Dockerized tt-rss using docker-compose

fox 5dd7a03270 Merge branch 'add-php7-openssl-master' of Ezwen/ttrss-docker-compose into master 2 months ago
app 676ff0d9da Add and enable php7-openssl in the 'app' image 2 months ago
web 0d5684ff4c switch to caddy from nginx 7 months ago
web-nginx c5bd3c357e add optional configuration for nginx frontend container 5 months ago
web-ssl 825ec395ac Accept Let's Encrypt TOS when using web-ssl 5 months ago
.env-dist 0168b8e689 clarify what HTTP_HOST does in .env-dist 5 months ago
.gitignore 9b0a93677d 1. move .env to .env-dist so local customization is not clashing with the 5 months ago
README.md d9fac409a4 upd README 5 months ago
docker-compose.yml c5bd3c357e add optional configuration for nginx frontend container 5 months ago

README.md

Dockerized tt-rss using docker-compose

The idea is to provide tt-rss working (and updating) out of the box with minimal fuss.

This setup is still WIP. Some features may be unimplemented or broken. Check the following before deploying:

General outline of the configuration is as follows:

  • separate containers (frontend: caddy, database: pgsql, app and updater: php/fpm)
  • 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)

Installation

Check out scripts from Git:

git clone https://git.tt-rss.org/fox/ttrss-docker-compose.git ttrss-docker && cd ttrss-docker

Edit configuration files:

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 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

docker-compose up --build

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, tt-rss will prompt you to do so on next page refresh.

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

Suggestions / bug reports