You need to have docker installed. You should find the Docker installer for your platform. This will install all the requirements to start.
To run the latest stable build of Tideflow, launch a docker container from the
Docker Hub's image:
An example of the command that launches Tideflow is:
docker run -d \ -p 80:3000 \ -p 1337:1337 \ -e ROOT_URL="<the url where your application will be available>" \ -e MONGO_URL="<mongodb deployment>" \ -e JWT_SECRET="<a random security token>" \ tideflowio/tideflow:latest
Let's cover each argument in the example:
-dlaunches the container in detached mode. This allows you to close the terminal while it continuous to run in the background.
-p 80:3000This exposes the port 80 in your server, to the port 3000 in the docker container. 3000 is the default port that Tideflow's server listens on.
-p host:container. more info
-p 1337:1337This exposes the port 1337 to the 1337 in the container. This is required to connect Tideflow's agent. More info.
-e ROOT_URLSpecifies on which URL Tideflow will be running at.
-e MONGO_URLThe URL of your MongoDB deployment. Please note that you can and should also use
MONGO_OPLOG_URLif your MongoDB is a replica set. This will improve the performance. More info
-e JWT_SECRETThis is a random text, used to encode and verify access tokens that give access to the files that Tideflow generates. More info