2020-01-24 06:18:58 +00:00
# Dockerized tt-rss using docker-compose
2019-11-15 12:51:55 +00:00
2019-11-16 11:20:54 +00:00
The idea is to provide tt-rss working (and updating) out of the box with minimal fuss.
2019-11-15 14:08:40 +00:00
2020-01-23 05:04:27 +00:00
- [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:
2019-11-15 12:51:55 +00:00
2020-01-22 13:41:31 +00:00
- separate containers (frontend: caddy, database: pgsql, app and updater: php/fpm)
2020-01-23 05:04:27 +00:00
- 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
2020-01-22 13:40:31 +00:00
- feed updates are handled via update daemon started in a separate container (updater)
2020-09-30 09:30:02 +00:00
- optional backups container which performs tt-rss database backup once a week
2019-11-15 12:51:55 +00:00
2019-11-15 18:30:50 +00:00
### Installation
2019-11-15 18:50:21 +00:00
#### Check out scripts from Git:
2019-11-15 18:30:50 +00:00
2020-01-23 05:10:40 +00:00
```sh
2019-11-15 18:49:44 +00:00
git clone https://git.tt-rss.org/fox/ttrss-docker-compose.git ttrss-docker & & cd ttrss-docker
2019-11-15 18:30:50 +00:00
```
2020-01-19 09:54:24 +00:00
#### Edit configuration files:
2019-11-15 18:30:50 +00:00
2020-01-19 09:54:24 +00:00
Copy ``.env-dist`` to ``.env`` and edit any relevant variables you need changed.
2020-12-31 08:49:02 +00:00
You will likely have to change ``SELF_URL_PATH`` which should equal fully qualified tt-rss
2019-11-15 18:30:50 +00:00
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.
2020-01-19 09:54:24 +00:00
Note: ``SELF_URL_PATH`` is updated in generated tt-rss ``config.php`` automatically on container
2020-01-19 10:08:54 +00:00
restart. You don't need to modify ``config.php`` manually for this.
2020-01-19 09:54:24 +00:00
2020-12-31 08:49:19 +00:00
By default, `web` container binds to **localhost** port **8280** . If you want the container to be
2020-01-19 09:54:24 +00:00
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``.
2020-12-31 08:49:02 +00:00
Please don't rename the services inside `docker-compose.yml` unless you know what you're doing. Web container expects application container to be named `app` , if you rename it and it's not accessible via Docker DNS as `http://app` you will run into 502 errors on startup.
2020-12-31 08:48:38 +00:00
2019-11-15 18:50:21 +00:00
#### Build and start the container
2020-01-23 05:10:40 +00:00
```sh
docker-compose up --build
```
2019-11-15 18:30:50 +00:00
See docker-compose documentation for more information and available options.
### Updating
2019-11-16 11:23:43 +00:00
Restarting the container will update tt-rss from the origin repository. If database needs to be updated,
2019-11-15 18:35:29 +00:00
tt-rss will prompt you to do so on next page refresh.
2019-11-15 18:30:50 +00:00
2019-11-16 11:23:43 +00:00
#### Updating container scripts
1. Stop the containers: ``docker-compose down && docker-compose rm``
2019-11-16 11:24:26 +00:00
2. Update scripts from git: ``git pull origin master`` and apply any necessary modifications to ``.env``, etc.
2019-11-16 11:23:43 +00:00
3. Rebuild and start the containers: ``docker-compose up --build``
2019-11-15 19:03:11 +00:00
### Suggestions / bug reports
2019-11-15 18:33:02 +00:00
2019-11-16 10:19:36 +00:00
- [Forum thread ](https://community.tt-rss.org/t/docker-compose-tt-rss/2894 )
