summaryrefslogtreecommitdiff
path: root/InstallationNotes.md
blob: 8ec2d8a034aadebb16a05d9da969a78b880fcf65 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
% Installation Guide

As of 2020, the recommended way to deploy tt-rss is via Docker. Unless you have very specific needs which require direct installation on the host, consider using docker-compose setup described below.

Official dockerized setup uses [docker-compose](https://docs.docker.com/compose/). There are two variants available:

### 1. Dynamic: tt-rss is updated automatically

Use this if you want to always run latest tt-rss code.

→ [Installation guide (dynamic)](https://git.tt-rss.org/fox/ttrss-docker-compose/src/master/README.md)

Updates are applied automatically from git master branch on container restart.

### 2. Static: uses pre-built images provided via Docker Hub

This seems to be a more commonly used pattern for Docker containers: images (including a snapshot of tt-rss source code) are built automatically and then pushed to [Docker Hub](https://hub.docker.com/u/cthulhoo). 

Use this if you want manual control over tt-rss updates or an ability to revert to an older prebuilt image.

→ [Installation guide (static)](https://git.tt-rss.org/fox/ttrss-docker-compose/src/static-dockerhub/README.md)

Updates are handled the usual way. Either run `docker-compose pull` etc. when appropriate or use something like [Watchtower](https://github.com/containrrr/watchtower) to apply updates automatically.

----

Alternatively, [install directly on a host machine](wiki/InstallationNotesHost).