update README.md

pull/5/head
Andrew Dolgov 4 years ago
parent 8b4cfe23ea
commit 0b8f9a8669

@ -16,7 +16,7 @@ General outline of the configuration is as follows:
- ``config.php`` is generated if it is missing - ``config.php`` is generated if it is missing
- database schema is installed automatically if it is missing - database schema is installed automatically if it is missing
- nginx has its http port exposed to the outside - nginx has its http port exposed to the outside
- optional SSL support via Caddy w/ automatic letsencrypt certificates - optional SSL support via Caddy w/ automatic letsencrypt certificates (deprecated)
- feed updates are handled via update daemon started in a separate container (updater) - feed updates are handled via update daemon started in a separate container (updater)
- optional backups container which performs tt-rss database backup once a week - optional backups container which performs tt-rss database backup once a week
@ -32,7 +32,7 @@ git checkout static-dockerhub
You're interested in ``docker-compose.yml`` stored in root directory, as opposed to ``src``. You're interested in ``docker-compose.yml`` stored in root directory, as opposed to ``src``.
Latter directory is used to build images for publishing on Docker Hub. Use it if you Latter directory is used to build images for publishing on Docker Hub. Use it if you
want to build your own containers. want to build your own containers.
#### Edit configuration files: #### Edit configuration files:
@ -43,15 +43,14 @@ You will likely have to change ``SELF_URL_PATH`` which should equal fully qualif
URL as seen when opening it in your web browser. If this field is set incorrectly, you will URL as seen when opening it in your web browser. If this field is set incorrectly, you will
likely see the correct value in the tt-rss fatal error message. likely see the correct value in the tt-rss fatal error message.
Note: ``SELF_URL_PATH`` is updated in generated tt-rss ``config.php`` automatically on container
restart. You don't need to modify ``config.php`` manually for this.
By default, `web` container binds to **localhost** port **8280**. If you want the container to be By default, `web` container binds to **localhost** port **8280**. If you want the container to be
accessible on the net, without using a reverse proxy sharing same host, you will need to accessible on the net, without using a reverse proxy sharing same host, you will need to
remove ``127.0.0.1:`` from ``HTTP_PORT`` variable in ``.env``. remove ``127.0.0.1:`` from ``HTTP_PORT`` variable in ``.env``.
Please don't rename the services inside `docker-compose.yml` unless you know what you're doing. Web container expects application container to be named `app`, if you rename it and it's not accessible via Docker DNS as `http://app` you will run into 502 errors on startup. Please don't rename the services inside `docker-compose.yml` unless you know what you're doing. Web container expects application container to be named `app`, if you rename it and it's not accessible via Docker DNS as `http://app` you will run into 502 errors on startup.
You can customize other `config.php` defines using environment variables (see `app/Dockerfile` for complete list).
#### Pull and start the container #### Pull and start the container
```sh ```sh

Loading…
Cancel
Save