You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ttrss-docker-compose/README.md

118 lines
4.1 KiB
Markdown

5 years ago
# A primitive set of scripts to deploy tt-rss via docker-compose
The idea is to provide tt-rss working (and updating) out of the box with minimal fuss.
5 years ago
5 years ago
This setup is still WIP. Some features may be unimplemented or broken. Check the following
before deploying:
5 years ago
5 years ago
- [TODO](https://git.tt-rss.org/fox/ttrss-docker-compose/wiki/TODO)
- [FAQ](https://git.tt-rss.org/fox/ttrss-docker-compose/wiki#faq)
General outline of the configuration is as follows:
5 years ago
- separate containers (frontend: caddy, database: pgsql, app and updater: php/fpm)
5 years ago
- tt-rss updates from git master repository on container restart
- tt-rss source code is stored on a persistent volume so plugins, etc. could be easily added
- ``config.php`` is generated if it is missing
- database schema is installed automatically if it is missing
- Caddy has its http port exposed to the outside
- optional SSL support via Caddy w/ automatic letsencrypt certificates
- feed updates are handled via update daemon started in a separate container (updater)
5 years ago
5 years ago
### Installation
#### Check out scripts from Git:
5 years ago
```sh
git clone https://git.tt-rss.org/fox/ttrss-docker-compose.git ttrss-docker && cd ttrss-docker
5 years ago
```
#### Edit configuration files:
5 years ago
Copy ``.env-dist`` to ``.env`` and edit any relevant variables you need changed.
* You will likely have to change ``SELF_URL_PATH`` which should equal fully qualified tt-rss
5 years ago
URL as seen when opening it in your web browser. If this field is set incorrectly, you will
likely see the correct value in the tt-rss fatal error message.
Note: ``SELF_URL_PATH`` is updated in generated tt-rss ``config.php`` automatically on container
restart. You don't need to modify ``config.php`` manually for this.
* By default, container binds to **localhost** port **8280**. If you want the container to be
accessible on the net, without using a reverse proxy sharing same host, you will need to
remove ``127.0.0.1:`` from ``HTTP_PORT`` variable in ``.env``.
#### Build and start the container
```sh
docker-compose up --build
```
5 years ago
See docker-compose documentation for more information and available options.
### Updating
Restarting the container will update tt-rss from the origin repository. If database needs to be updated,
5 years ago
tt-rss will prompt you to do so on next page refresh.
5 years ago
#### Updating container scripts
1. Stop the containers: ``docker-compose down && docker-compose rm``
2. Update scripts from git: ``git pull origin master`` and apply any necessary modifications to ``.env``, etc.
3. Rebuild and start the containers: ``docker-compose up --build``
### Using SSL with Letsencrypt
5 years ago
5 years ago
- ``HTTP_HOST`` in ``.env`` should be set to a valid hostname (i.e. no localhost or IP address)
5 years ago
- comment out ``web`` container, uncomment ``web-ssl`` in ``docker-compose.yml``
- ``SELF_URL_PATH`` in ``.env`` should not include a port as the container is going to use default https port
5 years ago
- ports 80 and 443 should be externally accessible i.e. not blocked by firewall and/or conflicting with host services
5 years ago
### How do I add plugins and themes?
By default, tt-rss code is stored on a persistent docker volume (``app``). You can find
its location like this:
5 years ago
```sh
docker volume inspect ttrss-docker_app | grep Mountpoint
```
5 years ago
Alternatively, you can mount any host directory as ``/var/www/html`` by updating ``docker-compose.yml``, i.e.:
```yml
5 years ago
volumes:
- app:/var/www/html
```
Replace with:
```yml
5 years ago
volumes:
- /opt/tt-rss:/var/www/html
```
Copy and/or git clone any third party plugins into ``plugins.local`` as usual.
5 years ago
### How do I put this container behind a reverse proxy?
A common pattern is shared nginx doing SSL termination, etc.
```nginx
location /tt-rss/ {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_pass http://127.0.0.1:8280/tt-rss/;
break;
}
```
5 years ago
You will need to set ``SELF_URL_PATH`` to a correct (i.e. visible from the outside) value in the ``.env`` file.
### Suggestions / bug reports
5 years ago
- [Forum thread](https://community.tt-rss.org/t/docker-compose-tt-rss/2894)