neingeist
/
ttrss-docker-compose
mirror of https://git.tt-rss.org/fox/ttrss-docker-compose
1
0
Fork 0
Code Issues Releases Wiki Activity
Dockerized tt-rss using docker-compose
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.
118 Commits
8 Branches
0 Tags
610 KiB
Shell 70.5%
Dockerfile 27.8%
PHP 1.7%
 
 
 
master
static-dockerhub
dynamic-php7
testing-php81
mariadb-unsupported
legacy-php5
pgsql-count-bits-13
pgsql-count-bits-12
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2e13396bd7'
${ noResults }
Go to file
Andrew Dolgov 2e13396bd7 use clean alpine 3.13 base 4 years ago
app use clean alpine 3.13 base 4 years ago
config.d initial for env-based setup 4 years ago
web set /tt-rss/backups as internal 4 years ago
web-nginx web-nginx: listen on ipv6 too 4 years ago
web-ssl set /tt-rss/backups as internal 4 years ago
.env-dist use TTRSS_DB_* variables instead of POSTGRES_* to set database configuration 4 years ago
.gitignore update .gitignore 4 years ago
README.md Update 'README.md' 4 years ago
docker-compose.yml backups: include .env 4 years 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.

General outline of the configuration is as follows:

  • separate containers (frontend: nginx, 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
  • database schema is installed automatically if it is missing
  • nginx has its http port exposed to the outside
  • optional SSL support via Caddy w/ automatic letsencrypt certificates (deprecated)
  • feed updates are handled via update daemon started in a separate container (updater)
  • optional backups container which performs tt-rss database backup once a week

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.

By default, web 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.

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.

Main configuration file (config.php) is rewritten on startup, don't edit it manually. Use environment variables (see app/Dockerfile for complete list) or config.d snippets to customize it.

Build and start the container

docker-compose up --build -d

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