initial commit

1 files changed, 48 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..80bd986
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+<!--
+.. File: README.md
+.. Location: https://bgstack15.ddns.net/cgit/newspipe-docker
+.. Author: bgstack15
+.. Startdate: 2023-06-15-5 14:50
+.. Title: Docker materials for newspipe
+.. Project: newspipe-docker
+.. Purpose: Docker image and docker-compose for newspipe
+.. History:
+.. Usage:
+.. Reference: See heading References
+.. Improve: See heading Improve
+.. Dependencies:
+..    Docker
+-->
+
+# Overview
+This project consists of the elements to assemble a [docker](https://www.docker.com/) image and [docker-compose](https://docs.docker.com/compose/) instructions of [newspipe](https://git.sr.ht/~cedric/newspipe), the rss feed aggregator web app.
+
+# Why this project exists
+Of category [awesome-selfhosted#feed-readers](https://github.com/awesome-selfhosted/awesome-selfhosted#feed-readers), only so many projects where written in Python/Flask, and of those (including [JARR](https://1pxsolidblack.pl/jarr-en.html) and [Temboz](https://github.com/fazalmajid/temboz)), newspipe was the only one I could get installed at all, which I did in a container because I didn't want to contaminate any real system with the likes of npm and some of the other dependencies of this app.
+
+# Using
+Basic docker experience should suffice. You can make a directory, e.g., `instance`, to mount inside the container which will receive the initial configurations from the app, which you can then configure before restarting.
+
+    docker run -p 5004:5004 --mount type=bind,source=./instance,destination=/newspipe/instance -it --rm newspipe:latest entrypoint.sh create_admin admin "1234567890"
+
+# Operations
+## Create admin user
+If you are using bare docker:
+
+    docker run -p 5004:5004 --mount type=bind,source=./instance,destination=/newspipe/instance -it --rm newspipe:latest entrypoint.sh create_admin admin "1234567890"
+
+Or if it is currently running in docker-compose:
+
+    docker-compose exec newspipe entrypoint.sh create_admin admin "123456789"
+
+# Improve
+Future improvements include:
+
+* add option for using postgresql in networked container
+* (underlying project: add ldap auth)
+
+# References
+
+1. <https://stackoverflow.com/questions/72465421/how-to-use-poetry-with-docker>
+2. <https://git.sr.ht/~cedric/newspipe>
+3. FreeIPA auth (ldap+kerberos) for a different rss reader, in a different language <https://git.sacredheartsc.com/ttrss-freeipa/tree/auth_freeipa/init.php>