Add customization manual (Resolves #18)

README.md

@@ -22,102 +22,16 @@ pip install -e .
 python3 -m ftracker
 ```
 
-Edit `config.ini` to tune your installation.
+Edit `config.ini` to tune your installation (see
+[INSTALL.md #customization](https://git.fasttube.de/FaSTTUBe/ft-corona-tracker/src/branch/master/INSTALL.md#customization)
+for customization options).
 
 Then, point your browser at <http://localhost:5000/>.
 
 ## Installation/Deployment
 
-There are 2 methods: Docker and Manual.
-
-### Method A: Docker
-
-Pull the container from docker hub using
-
-```bash
-sudo docker pull fasttube/ftracker
-```
-
-OR build the container locally with
-
-```bash
-sudo docker build . -t fasttube/ftracker
-```
-
-Then, if you want the container to also handle SSL so it can run standalone you
-need to pass it a domain and email so it can obtain a certificate from `Let's
-encrypt`. Use the first path in the `-v` option to point to your config file:
-
-```bash
-sudo docker run \
-	-it --rm \
-	--name ftracker \
-	-e DOMAIN=example.com \
-	-e LE_EMAIL=admin@example.com \
-	-p 80:80 \
-	-p 443:443 \
-	-v /your/full/path/to/config.ini:/etc/ftracker/config.ini \
-	fasttube/ftracker
-```
-
-Otherwise you can run it without SSL (maybe behind your own web+ssl server)
-using just
-
-```bash
-sudo docker run \
-	-it --rm \
-	--name ftracker \
-	-p 80:80 \
-	-v /your/full/path/to/config.ini:/etc/ftracker/config.ini \
-	fasttube/ftracker
-```
-
-If those work in the foreground and everything looks okay, you can start them
-without `-it --rm` and with `-d` instead to run them in the background. Keep in
-mind that it can take around 10 seconds to fully start.
-
-To stop/start/uninstall the container afterwards, run:
-
-```bash
-docker stop ftracker  # might take a few seconds
-docker start ftracker # continue running
-docker rm -f ftracker # uninstall
-```
-
-### Method B: Manual
-
-#### 1. FTracker Backend
-
-Install backend system wide:
-```bash
-# clone, cd into repo
-sudo -H pip install . # Use -e if you want to hack on the backend while installed.
-```
-
-#### 2. WSGI Server + Service file
-
-You need a WSGI Middleware (using `Flask`'s included `werkzeug` is discouraged
-for production environments). I recommend `uwsgi` since it's flexible, fast and
-has `nginx` integration. A sample configuration file as well as service
-description files for both `systemd` and `rc` are included in `res/` for you to
-adapt (file paths etc.) and install to your system (The `systemd` service file
-still untested though, feel free to leave feedback).
-
-#### 3. Webserver
-
-You need a webserver. I recommend `nginx` because it's the industry standard
-and fast. A sample config file is included in `res/` for you to adapt (domain,
-SSL certs) and install to your system. The configuration should include:
-Webroot in `web/` with a fallback to the WSGI handler for the backend.
-
-Enabling SSL (https) and redirecting http to https is strongly encouraged, i
-recommend using `Let's Encrypt`'s `certbot` to easily obtain certificates.
-
-#### 4. Customization
-
-Edit `config.ini` to your liking. Restart the backend by restarting the `uwsgi`
-service, e.g. `sudo systemctl restart ftracker` or `sudo service ftracker
-restart`
+See
+[INSTALL.md](https://git.fasttube.de/FaSTTUBe/ft-corona-tracker/src/branch/master/INSTALL.md)
 
 ## Open Sources