summaryrefslogtreecommitdiff
path: root/InstallationNotes.md
blob: 7b18431f4e6f7364dba3a4dc97f45a7cc410a89d (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 2022, I recommend everyone to use Docker Hub images. Those are generated through a proper CI/CD pipeline which involves basic unit tests and static code analysis. This means you're less likely to receive a broken image. You get no such guarantees when using git master branch.**

Docker(-compose) is the only supported way to deploy tt-rss.

### Static: uses pre-built images provided via Docker Hub ← **recommended for users**

This seems to be a more commonly used pattern for Docker containers: images (including a snapshot of tt-rss source code) are built automatically on master branch updates 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.git/tree/README.md?h=static-dockerhub )

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.

### Dynamic: uses git master branch ← for developers

Use this if you want to always run latest tt-rss code and/or don't want to rely on Docker Hub. Also, using dynamic image makes more sense [for development](https://git.tt-rss.org/fox/ttrss-docker-compose.wiki.git/tree/Home.md#how-do-i-use-dynamic-image-for-development).

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

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

------

See also: [Host installation (not supported)](InstallationNotesHost).