diff --git a/README.md b/README.md index ccfd49b..595a93c 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,14 @@ before deploying: - [TODO](https://git.tt-rss.org/fox/ttrss-docker-compose/wiki/TODO) - [FAQ](https://git.tt-rss.org/fox/ttrss-docker-compose/wiki#faq) +**This is an alternative static version which bakes source code into the container which gives +you more control over application updates.** + General outline of the configuration is as follows: - separate containers (frontend: caddy, database: pgsql, app and updater: php/fpm) - - tt-rss updates from git master repository on container restart - - tt-rss source code is stored on a persistent volume so plugins, etc. could be easily added + - tt-rss latest git master source baked into container on build + - working copy is stored on (and rsynced over on restart) a persistent volume so plugins, etc. could be easily added - ``config.php`` is generated if it is missing - database schema is installed automatically if it is missing - Caddy has its http port exposed to the outside @@ -24,7 +27,9 @@ General outline of the configuration is as follows: #### Check out scripts from Git: ```sh -git clone https://git.tt-rss.org/fox/ttrss-docker-compose.git ttrss-docker && cd ttrss-docker +git clone https://git.tt-rss.org/fox/ttrss-docker-compose.git ttrss-docker +cd ttrss-docker +git checkout static ``` #### Edit configuration files: @@ -52,8 +57,10 @@ See docker-compose documentation for more information and available options. ### Updating -Restarting the container will update tt-rss from the origin repository. If database needs to be updated, -tt-rss will prompt you to do so on next page refresh. +You will need to rebuild the container to update tt-rss source code from Git. Working copy +will be synchronized on startup. + +If database needs to be updated, tt-rss will prompt you to do so on next page refresh. #### Updating container scripts @@ -61,7 +68,6 @@ tt-rss will prompt you to do so on next page refresh. 2. Update scripts from git: ``git pull origin master`` and apply any necessary modifications to ``.env``, etc. 3. Rebuild and start the containers: ``docker-compose up --build`` - ### Using SSL with Letsencrypt - ``HTTP_HOST`` in ``.env`` should be set to a valid hostname (i.e. no localhost or IP address)