Skip to content

Commit cc4168e

Browse files
committed
docs(installation): more tweaks from PR comments
1 parent 9f1490c commit cc4168e

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/Installation-Guide.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,13 @@ Place both `.env` and `docker-compose.yml` together in a directory, edit `.env`
4040
complex ones.
4141
1. [Get the `docker-compose.yml` file](docs/Installation-Guide.md#docker-compose) and edit
4242
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`.
43+
1. Run `docker-compose up -d` to run within the current shell. Note that the `-d` will detach the docker containers so when you close your shell, docker will still run.
4544
1. [Optional] Run `lazydocker` so you can always see what is happening.
4645
1. [Lazydocker](https://github.com/jesseduffield/lazydocker) is a nice little terminal
4746
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
47+
This means that you can run it in an SSH session to see what your Docker Compose
4948
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/).
49+
1. [Optional] Run lots of Docker commands so you see what is happening. [Check the docker documentation](https://docs.docker.com/manuals/).
5150

5251
### .env
5352

@@ -470,7 +469,7 @@ If your service uses a non-standard (i.e. not 80 or-443) port, make an internal
470469

471470
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.
472471

473-
Additionally, you should download your data in `OPML` regularity and restore from backups from time to time — is quarterly too much?
472+
Restoring from backups from time to time (is quarterly too much?) is another thing you should get used to. There is no point in having backups if you cannot restore from them.
474473

475474
If you have `backups` container enabled, stock configuration makes automatic backups (database, local plugins,-etc.) once a week to a separate storage volume.
476475

@@ -505,6 +504,10 @@ The process to restore the database from a `backups` container backup might look
505504
3. Clear database (**THIS WOULD DELETE EVERYTHING IN THE-DB**): `psql -h db -U $TTRSS_DB_USER $TTRSS_DB_NAME -e -c "drop schema public cascade; create schema public"`
506505
3. Restore the backup: `zcat /backups/ttrss-backup-yyyymmdd.sql.gz | psql -h db -U $TTRSS_DB_USER $TTRSS_DB_NAME`
507506

507+
#### OPML
508+
509+
Optionally, you could download your data in `OPML` regularity. It is not a full backup, can be useful nonetheless.
510+
508511
### How do I use custom certificates?
509512

510513
You need to mount custom certificates into the *app* and *updater* containers like this:

0 commit comments

Comments
 (0)