flatisfy/doc/2.docker.md
Phyks (Lucas Verney) a9ac5484e0 Rework Docker image and add some doc.
Thanks @bnjbvr for the contribution!

This closes #15.
2017-06-21 15:10:56 +02:00

39 lines
1.0 KiB
Markdown

Testing Flatisfy using Docker
=============================
A basic `Dockerfile` is available for rapid testing. It is still really hacky
and should not be used in production.
1. First, build the docker image:
```
cd docker
docker build -t bnjbvr/flatisfy .
```
2. Then, create some folder to store your Flatisfy data in a permanent way (it
will be mount as a Docker volume in next steps), and initialize an empty
config:
```
mkdir flatisfy
cd flatisfy
FLATISFY_VOLUME=$(pwd)
docker run -P -v $FLATISFY_VOLUME:/flatisfy -p 8080:8080 bnjbvr/flatisfy sh -c "cd /home/user/app && python -m flatisfy init-config > /flatisfy/config.json"
```
3. Then, edit the generated `config.json` file according to your needs. See
[0.getting_started.md](0.getting_started.md) for more infos on the
configuration file format.
4. Finally, run the docker image to fetch flats and serve the web UI:
```
docker run -P -v $FLATISFY_VOLUME:/flatisfy -p 8080:8080 bnjbvr/flatisfy
```
Your Flatisfy instance is now available at `localhost:8080`!