Commit ce5edc60 authored by Sascha Herzinger's avatar Sascha Herzinger

updated README

parent 09e732a6
Pipeline #5466 passed with stages
in 39 minutes and 31 seconds
......@@ -2,9 +2,37 @@
This folder contains all files necessary to setup the Fractalis service in a production environment.
### Usage
`docker-compose up` That's all! This will expose the service on port 443 and 80 by default.
This behavior can be changed by setting the environment variables `FRACTALIS_HTTP_PORT` and `FRACTALIS_HTTPS_PORT`.
For more detailed information please look into the files. They are rather self-explanatory and good place to do own modifications.
We assume that Docker and Docker-Compose are already installed on the system and
are up-to-date. It is possible to check this by opening a terminal and running
the following commands:
```
> docker --version
docker version 18.03.0-ce, build 0520e24
> docker-compose --version
docker-compose version 1.20.1, build 5d8c71b
```
If these commands fail or if the versions are much older than the one displayed
above please consult https://docs.docker.com/install/ and
https://docs.docker.com/compose/install/
If docker is properly installed on your system please run the following commands:
```
> git clone https://git-r3lab.uni.lu/Fractalis/fractalis.git
> cd fractalis/docker
> docker-compose up
```
The last command might require root access to connect with the Docker engine.
Depending on your network connection, this step will take a few minutes. Once
all the services are up and running you can open Chrome, Firefox, or Safari and
navigate to `http://localhost` or, if you use docker-machine, to http://`docker-machine ip`.
If you see the
Fractalis welcome screen, your system just became a Fractalis node that can be used
for statistical computation, as long as Docker is running. If this fails for you,
make sure docker is properly installed and port 80 and 443 are not used by other
services on your system. If they are either stop the services or use the environment
variables `FRACTALIS_HTTP_PORT` and `FRACTALIS_HTTPS_PORT` to change the ports
used by Fractalis.
### Configuration (Fractalis / Celery / Flask)
1. Modify [docker/fractalis/config.py](config/fractalis/config.py) before `running docker-compose up`.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment