Skip to content

Commit 9f1490c

Browse files
committed
docs(installation): removed docker tips and enhanced installation guide
1 parent 5598f0f commit 9f1490c

File tree

2 files changed

+20
-42
lines changed

2 files changed

+20
-42
lines changed

docs/Docker-tips.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/Installation-Guide.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,22 @@ Consider using an external [Patroni cluster](https://patroni.readthedocs.io/en/l
3232

3333
Place both `.env` and `docker-compose.yml` together in a directory, edit `.env` as you see fit, run `docker compose up -d`.
3434

35-
If you want a little more verbose explanation, see [Docker tips and tricks](docs/docker-tips.md).
35+
## In more details
36+
37+
1. Create a directory for your tt-rss installation. Do the rest in there.
38+
1. [Get the `.env` file](docs/Installation-Guide.md#.env) and edit it to suit your needs.
39+
1. Make sure you change all the password using something like `pwgen` to generate long and
40+
complex ones.
41+
1. [Get the `docker-compose.yml` file](docs/Installation-Guide.md#docker-compose) and edit
42+
it to suit your needs.
43+
1. Run `docker-compose up` to run within the current shell. Add the `-d` option for
44+
detached so you can run it in the background: `docker-compose -d up`.
45+
1. [Optional] Run `lazydocker` so you can always see what is happening.
46+
1. [Lazydocker](https://github.com/jesseduffield/lazydocker) is a nice little terminal
47+
UI for both `docker` and `docker-compose`, written in Go with the `gocui` library.
48+
This means that you can run it in an ssh session to see what your docker compose
49+
installation is doing — or not.
50+
1. [Optional] Run lots of docker commands so you see what is happening. [Check the docker documentation](https://docs.docker.com/manuals/).
3651

3752
### .env
3853

@@ -453,6 +468,10 @@ If your service uses a non-standard (i.e. not 80 or-443) port, make an internal
453468

454469
### Backup and restore
455470

471+
Backups are important as you will eventually lose your data due many a thing. It is better to have them rather than be sorry. Yes, even for a simple service like tt-rss.
472+
473+
Additionally, you should download your data in `OPML` regularity and restore from backups from time to time — is quarterly too much?
474+
456475
If you have `backups` container enabled, stock configuration makes automatic backups (database, local plugins,-etc.) once a week to a separate storage volume.
457476

458477
Note that this container is included as a safety net for people who wouldn't bother with backups otherwise.

0 commit comments

Comments
 (0)