To quickly get started with your own installation you can use one of these docker-compose files. download the file you want ( you can rename the file to docker-compose.yaml or use -f to specify the file )
docker-compose-traefik.yml is for people running docker ce/docker desktop
open a shell and cd to that folder you downloaded the file to, and type ( you need to rename the downloaded file to docker-compose.yml, or use the next command instead )
docker-compose upSay you downloaded docker-compose-traefik.yml and you want to set your own project name.
docker-compose -f docker-compose-traefik.yml -p demo upThis will be the basis for everything else you do, for instance, if you need to update the images to the latest version, you would then use
docker-compose -f docker-compose-traefik.yml -p demo pullThen you can access the API/web on http://localhost.openiap.io and RabbitMQ on http://mq.localhost.openiap.io
The first username and password you try to login as, will be created and made admin. This cannot be admin, root or other common administrate account names.
For almost everyone, you will want to start with docker-compose-traefik.yml This gives you a good starting point for testing it on your local machine, and play around with the settings. Once you understand how it works, and you know how to change the domain names it responds too, then you can push this to a server locally or to some cloud provider. If you have a public IP for the solution you can also have a look at docker-compose-traefik-letsencrypt.yml for a guide on how to use Lets Encrypt for certificates. For more complex setups where you don't have public IP or just need access to wildcard certificates there is also an example on how to request Lets Encrypt certificates using DNS01 in the docker-compose-traefik-letsencrypt-dns01.yml file.
In this video the whole process is showed on ubuntu 18
All examples use localhost.openiap.io for domain. This domain points to your localhost ( 127.0.0.1 ) and there for only works on your local machine. To allow other clients to connect, or if you did this on a hosting/cloud server somewhere, you need to use your own DNS to access your instance.
First find the IP if your machine. If used on the local network only, use the IP of the machine with docker, if you are in the cloud, us the public IP given to that machine.
You need to add 2 DNS record at your DNS provider, one for OpenFlow it self, and and for all the services under that OpenFlow ( MQ, NodeRED's, etc. )
First add one A record for OpenFlow, pointing to the IP of the docker host. ( in this example your domain is mydomain.com )
openflow A 10.0.1.1
Next add an wildcard * record for all the services exposed from that instance, as a CNAME pointing to the instance
* CNAME openflow.mydomain.com.
( a few DNS providers does not allow create wildcard records using CNAME, and that case use an A record pointing to the same IP )
If something is not working, make sure all instances are running, if on windows client simply open the docker UI and expand the project. for everyone else you can use
docker-compose -f docker-compose-traefik.yml -p demo psand make sure all is running
If one is not running, check the logs by specifying the service name ( SERVICE table ) for instance to watch web logs
docker-compose -f docker-compose-traefik.yml -p demo logs webIf you want to watch the logs lice you can add the follow flag
docker-compose -f docker-compose-traefik.yml -p demo logs web -f- Its a know issue rabbitmq can take a bit long to startup on docker desktop that will make the web instances restart a few times until rabbitmq is responding.
- It's a know issue that with mongodb 5 you need to be running on a processor that supports AVX and have an updated docker installation. A work around can be to specify you want to use mongodb 4 instead
For questions or help, feel free to join the community on the forum or rocket chat.
For help with running on kubernetes or self hosting, feel free to contact OpenIAP for a commercial support options.