add readme; push readme to dockerhub

.drone.jsonnet

@@ -69,6 +69,23 @@ local PipelineNotifications(depends_on=[]) = {
         ],
       },
     },
+    {
+      image: "sheogorath/readme-to-dockerhub",
+      name: "readme",
+      environment: {
+        DOCKERHUB_USERNAME: { from_secret: "docker_username" },
+        DOCKERHUB_PASSWORD: { from_secret: "docker_password" },
+        DOCKERHUB_REPO_PREFIX: "xoxys",
+        DOCKERHUB_REPO_NAME: "ttrss",
+        README_PATH: "README.md"
+      },
+      when: {
+        ref: [
+          'refs/heads/master',
+          'refs/tags/**',
+        ],
+      },
+    },
     {
       name: "microbadger",
       image: "plugins/webhook",

.drone.yml

@@ -61,6 +61,21 @@ steps:
     - refs/heads/master
     - "refs/tags/**"
 
+- name: readme
+  image: sheogorath/readme-to-dockerhub
+  environment:
+    DOCKERHUB_PASSWORD:
+      from_secret: docker_password
+    DOCKERHUB_REPO_NAME: ttrss
+    DOCKERHUB_REPO_PREFIX: xoxys
+    DOCKERHUB_USERNAME:
+      from_secret: docker_username
+    README_PATH: README.md
+  when:
+    ref:
+    - refs/heads/master
+    - "refs/tags/**"
+
 - name: microbadger
   pull: always
   image: plugins/webhook
@@ -94,6 +109,6 @@ depends_on:
 
 ---
 kind: signature
-hmac: f15274a2fd107c7a19948d4ba36c9c2fe6c55bad46d8a4690c529c801ef8c9ad
+hmac: a65910eece4462292dd0b4c69d09893697f7ce38fe3ba938fa96e2c799d57ad2
 
 ...

README.md

@@ -1,2 +1,115 @@
 # ttrss
 
+TT-RSS is an open source web-based news feed (RSS/Atom) reader and aggregator, designed to allow you to read news from any location, while feeling as close to a real desktop application as possible.
+
+## Usage
+
+Here are some example snippets to help you get started creating a container.
+
+### Docker
+
+```Shell
+docker create \
+  --name=ttrss \
+  -p 80:80 \
+  xoxys/ttrss
+```
+
+### Docker Compose
+
+Compatible with docker-compose v2 schemas.
+
+```Yaml
+---
+version: '2'
+
+services:
+  ttrss:
+    image: xoxys/ttrss:latest
+    ports:
+      - "80:80"
+    depends_on:
+      - db
+
+  db:
+    image: postgres
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: secure
+      POSTGRES_DB: ttrss
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data:
+    driver: local
+```
+
+## Environment variables
+
+### TT-RSS
+
+```Shell
+TTRSS_DB_TYPE=pgsql
+TTRSS_DB_HOST=db
+TTRSS_DB_USER=postgres
+TTRSS_DB_NAME=ttrss
+TTRSS_DB_PASS=secure
+TTRSS_DB_PORT=5432
+TTRSS_SELF_URL_PATH=http://localhost/
+TTRSS_SINGLE_USER_MODE=false
+TTRSS_SIMPLE_UPDATE_MODE=false
+TTRSS_PHP_EXECUTABLE=/usr/bin/php
+TTRSS_AUTH_AUTO_CREATE=true
+TTRSS_AUTH_AUTO_LOGIN=true
+TTRSS_FORCE_ARTICLE_PURGE=0
+TTRSS_SPHINX_SERVER=localhost:9312
+TTRSS_SPHINX_INDEX=ttrss, delta
+TTRSS_ENABLE_REGISTRATION=false
+TTRSS_REG_NOTIFY_ADDRESS=
+TTRSS_REG_MAX_USERS=10;
+TTRSS_SESSION_COOKIE_LIFETIME=86400
+TTRSS_SMTP_FROM_NAME=Tiny Tiny RSS
+TTRSS_SMTP_FROM_NAME=
+TTRSS_DIGEST_SUBJECT=[tt-rss] New headlines for last 24 hours
+TTRSS_CHECK_FOR_UPDATES=true
+TTRSS_ENABLE_GZIP_OUTPUT=false
+TTRSS_PLUGINS=auth_internal, note
+TTRSS_LOG_DESTINATION=sql
+TTRSS_CONFIG_VERSION=26
+```
+
+### PHP
+
+```Shell
+PHP_EXPOSE_PHP=Off
+PHP_MAX_EXECUTION_TIME=30
+PHP_MAX_INPUT_TIME=60
+PHP_MEMORY_LIMIT=50M
+PHP_ERROR_REPORTING=E_ALL & ~E_DEPRECATED & ~E_STRICT
+PHP_DISPLAY_ERRORS=Off
+PHP_DISPLAY_STARTUP_ERRORS=Off
+PHP_LOG_ERRORS=On
+PHP_LOG_ERRORS_MAX_LEN=1024
+PHP_IGNORE_REPEATED_ERRORS=Off
+PHP_IGNORE_REPEATED_SOURCE=Off
+PHP_REPORT_MEMLEAKS=On
+PHP_HTML_ERRORSOn
+PHP_ERROR_LOG=/proc/self/fd/2
+PHP_POST_MAX_SIZE=8M
+PHP_FILE_UPLOADS=Off
+PHP_UPLOAD_MAX_FILESIZE=2M
+PHP_MAX_FILE_UPLOADS=2
+PHP_ALLOW_URL_FOPEN=On
+PHP_ALLOW_URL_INCLUDE=Off
+PHP_DATE_TIMEZONE=Europe/Berlin
+PHP_SQL_SAFE_MODE=On
+```
+
+### License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+### Maintainers and Contributors
+
+[Robert Kaussow](https://gitea.rknet.org/xoxys)

overlay/etc/php7/php-fpm.conf

@@ -1,5 +1,5 @@
 [global]
-error_log = /dev/stderr
+error_log = /proc/self/fd/2
 log_level = warning
 daemonize = no
 

overlay/etc/php7/php.ini

@@ -63,7 +63,7 @@ html_errors = On
 ;docref_ext = .html
 ;error_prepend_string = "<span style='color: #ff0000'>"
 ;error_append_string = "</span>"
-error_log = php_errors.log
+error_log = /proc/self/fd/2
 ;windows.show_crt_warning
 
 ;arg_separator.output = "&amp;"

overlay/etc/templates/config.php.tmpl

@@ -31,7 +31,7 @@
 	// multiple users and authentication. Enabling this assumes you have
 	// your tt-rss directory protected by other means (e.g. http auth).
 
-	define('SIMPLE_UPDATE_MODE', {{ getenv "TTRSS_SELF_URL_PATH" "false" }});
+	define('SIMPLE_UPDATE_MODE', {{ getenv "TTRSS_SIMPLE_UPDATE_MODE" "false" }});
 	// Enables fallback update mode where tt-rss tries to update feeds in
 	// background while tt-rss is open in your browser.
 	// If you don't have a lot of feeds and don't want to or can't run

overlay/etc/templates/php.ini.tmpl

@@ -63,7 +63,7 @@ html_errors = {{ getenv "PHP_HTML_ERRORS" "On" }}
 ;docref_ext = .html
 ;error_prepend_string = "<span style='color: #ff0000'>"
 ;error_append_string = "</span>"
-error_log = {{ getenv "PHP_ERROR_LOG" "php_errors.log"}}
+error_log = {{ getenv "PHP_ERROR_LOG" "/proc/self/fd/2"}}
 ;windows.show_crt_warning
 
 ;arg_separator.output = "&amp;"