@@ -9,7 +9,7 @@ Please have a look at this playlist to see a demo of the visual aspects of Fract
### Installation (Docker)
The easiest and most convenient way to deploy Fractalis is using Docker.
All necessary information can be found in the docker folder.
All necessary information can be found [here](docker).
### Installation (Manual)
If you do not want to use docker or want a higher level of control of the several components, that's fine. In fact it isn't difficult to setup Fractalis manually:
...
...
@@ -21,18 +21,18 @@ If you do not want to use docker or want a higher level of control of the severa
- Run and expose the Fractalis web service with whatever tools you want. We recommend **gunicorn** and **nginx**, but others should work, too.
- Run the celery workers on any machine that you want within the same network. (For a simple setup this can be the very same machine that the web service runs on).
Note: The [docker-compose.yml](https://git-r3lab.uni.lu/Fractalis/fractalis/blob/master/docker/docker-compose.yml) describes how the different services are started and how they connect with each other.
Note: The [docker-compose.yml](docker/docker-compose.yml) describes how the different services are started and how they connect with each other.
### Configuration
Use the environment variable `FRACTALIS_CONFIG` to define the configuration file path.
This variable must be a) a valid python file (.py) and b) be available on all instances that host a Fractalis web service or a Fractalis worker.
Tip: Use the [default settings](https://git-r3lab.uni.lu/Fractalis/fractalis/blob/master/fractalis/config.py) as an example for your own configuration file.
Tip: Use the [default settings](fractalis/config.py) as an example for your own configuration file.
Please note, that all this files combines [Flask settings](http://flask.pocoo.org/docs/0.12/config/), [Celery settings](http://docs.celeryproject.org/en/latest/userguide/configuration.html), and Fractalis settings, which are all listed and documented within this file.
Please don't overwrite default settings if you don't know what you are doing. This might have severe implications for security or might cause Fractalis to not work correctly.
### Add support for new services
Support for other services is exclusively implemented within [this folder](https://git-r3lab.uni.lu/Fractalis/fractalis/tree/master/fractalis/data/etls). We recommend looking at the *ada* example implementation. Just make sure you use the class inheritance (ETL, ETLHandler) correctly, and you will get readable error messages if something goes wrong.
&&printf"[lcsb-base]\nname=LCSB Base Repo\nbaseurl=http://lcsb-cent-mirr-server.uni.lu/CentOS/7/os/x86_64/\nenabled=1"> /etc/yum.repos.d/lcsb-base.repo \
&&rm-rf /var/cache/yum \
&& yum clean all \
&& yum install--nogpg-y python34 python34-pip python34-devel readline-devel R wget \
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](https://git-r3lab.uni.lu/Fractalis/fractalis/blob/master/docker/config/fractalis/config.py) before `running docker-compose up`.
1. Modify [docker/fractalis/config.py](config/fractalis/config.py) before `running docker-compose up`.
2. Replace the [dummy certificates](https://git-r3lab.uni.lu/Fractalis/fractalis/tree/master/docker/config/nginx/certs) with your own. The included one are only for development purposes.
2. Replace the [dummy certificates](config/nginx/certs) with your own. The included one are only for development purposes.
Tip: Use the [default settings](https://git-r3lab.uni.lu/Fractalis/fractalis/blob/master/fractalis/config.py) as an example for your own configuration file.
Tip: Use the [default settings](../fractalis/config.py) as an example for your own configuration file.
Please note, that all this files combines [Flask settings](http://flask.pocoo.org/docs/0.12/config/), [Celery settings](http://docs.celeryproject.org/en/latest/userguide/configuration.html), and Fractalis settings, which are all listed and documented within this file.
Please don't overwrite default settings if you don't know what you are doing. This might have severe implications for security or might cause Fractalis to not work correctly.
