From 617f6fcc44ccb74c658f17876351c3945a801d6c Mon Sep 17 00:00:00 2001
From: Mathieu Bruyen <code@mais-h.eu>
Date: Sun, 19 May 2019 16:37:36 +0200
Subject: [PATCH] readme instructions

---
 Readme.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..78f710e
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,67 @@
+# Tiny Tiny RSS on dokku
+
+Runs as a [Dockerfile deployment](http://dokku.viewdocs.io/dokku/deployment/methods/dockerfiles/) with a [Postgres database](https://github.com/dokku/dokku-postgres). Pulls [TTRSS release](https://git.tt-rss.org/git/tt-rss) into an [nginx base image](https://hub.docker.com/_/nginx/) with PHP7, parses `DATABASE_URL` environment variable and starts the fetch daemon using supervisord.
+
+## Setup
+
+```
+dokku plugin:install https://github.com/dokku/dokku-postgres.git
+
+dokku apps:create ttrss
+dokku postgres:create ttrssdb_11_2
+dokku postgres:link ttrssdb_11_2 ttrss
+dokku config:set ttrss SELF_URL_PATH=http://ttrss.example.com/
+
+git remote add dokku dokku@example.com:ttrrs
+git push dokku
+
+dokku run ttrss php7 /var/lib/tt-rss-install/install-db.php
+```
+
+## HTTPS
+
+### Setup
+
+```
+dokku plugin:install https://github.com/dokku/dokku-letsencrypt.git
+
+dokku config:set --no-restart ttrss DOKKU_LETSENCRYPT_EMAIL=todo@example.com
+dokku config:set --no-restart ttrss SELF_URL_PATH=https://ttrss.example.com/
+dokku letsencrypt ttrss
+dokku ps:restart ttrss
+```
+
+### Renewal
+
+```
+dokku plugins:upgrade letsencrypt
+dokku letsencrypt:auto-renew ttrss
+```
+
+## Upgrade
+
+### TTRSS
+
+Check for updates in [config.php-dist](https://git.tt-rss.org/fox/tt-rss/commits/master/config.php-dist) and propagate them in `config.php`. In `Dockerfile`, update nginx base image and TTRSS release.
+
+```
+dokku postgres:export ttrssdb_11_2 > ttrss.db
+git push dokku
+# go to Tiny Tiny RSS, it will ask to upgrade database, do it and check app is working
+rm ttrss.db
+```
+
+### Database
+
+```
+# upgrade from Postgres 10.2 to 11.2
+dokku plugins:upgrade postgres
+dokku postgres:clone ttrssdb_10_2 ttrssdb_11_2
+dokku postgres:link ttrssdb_11_2 ttrss
+dokku postgres:promote ttrssdb_11_2 ttrss
+
+# check app is working, then delete old database
+dokku postgres:unlink ttrssdb_10_2 ttrss
+dokku postgres:destroy ttrssdb_10_2
+```
+