kienan
/
ttrss-container
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
164 Commits 1 Branch 0 Tags 135 KiB
Shell 74.9%
Dockerfile 22.9%
PHP 2.2%
Go to file
Andrew Dolgov ab8f1c5420 * temporarily add more startup debugging 
* adjust chown ordering a bit
 		2022-05-22 09:23:25 +03:00
app * temporarily add more startup debugging 2022-05-22 09:23:25 +03:00
config.d initial for env-based setup 2021-01-31 15:05:50 +03:00
web-nginx web-nginx: add basic healthcheck 2021-12-07 17:19:48 +03:00
.env-dist use TTRSS_DB_* variables instead of POSTGRES_* to set database configuration 2021-02-03 06:25:07 +03:00
.gitignore add optional support for xdebug 2021-02-22 12:13:20 +03:00
README.md fix git.tt-rss.org links 2022-04-04 10:14:13 +03:00
docker-compose.yml remove caddy containers 2021-03-05 17:48:27 +03:00

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 and plugins update 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 updated automatically
  • nginx has its http port exposed to the outside
  • 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

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

Edit configuration files

Configuration is done primarily through the environment. Copy .env-dist to .env and edit any relevant variables you need changed.

You will likely have to change TTRSS_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.

Legacy configuration file (config.php) is not created automatically, if you need it, copy it from config.php-dist manually.

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

Build and start the container

docker-compose up --build -d

See docker-compose documentation for more information and available options.

Default login credentials

Username: admin, password: password

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. Normally this happens automatically on container startup.

Updating container scripts

Latest tt-rss source code expects latest container scripts and vice versa. Updating both is a good idea.

  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