summaryrefslogtreecommitdiff
path: root/InstallationNotes.md
blob: 50fcad021d10c7b9eed9126ff3ba87f67c93dd9a (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

Docker is the only supported way to deploy tt-rss. Unless you are a developer or require direct installation on the host for a different reason, consider using [docker-compose](https://docs.docker.com/compose/) setup described below.

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

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

### Dynamic: tt-rss is updated automatically

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/Home#how-do-i-use-dynamic-image-for-development).

→ [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.

----

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