commit abe01fdd3fab0d292ccd02c6f07b00fb10e6bec3
parent aa2b306be10c100cecc969745095ad6183086a0a
Author: parazyd <parazyd@dyne.org>
Date: Wed, 23 Jan 2019 15:35:34 +0100
Add initial README.
Diffstat:
M | README.md | | | 83 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- |
1 file changed, 82 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,2 +1,83 @@
-diasporadiaries
+DiasporaDiaries
===============
+
+DiasporaDiaries is a platform for writing stories about experiences of
+living abroad.
+
+
+Deploying
+---------
+
+### Dependencies
+
+```
+python3 python3-flask python3-flask-login python3-bcrypt
+```
+
+DiasporaDiaries runs as a standalone HTTP server and is supposed to be
+proxied with another httpd like nginx to allow TLS.
+
+```
+usage: diaspora.py [-h] [-l L] [-p P] [-d]
+
+optional arguments:
+ -h, --help show this help message and exit
+ -l L Address for listening (ex: 127.0.0.1)
+ -p P Port for listening (ex: 8000)
+ -d Debug mode
+```
+
+An example nginx configuration would look like:
+
+```
+server {
+ listen 80;
+ listen 443 ssl;
+ server_name diasporadiaries.eu www.diasporadiaries.eu;
+
+ ssl_certificate /etc/ssl/diaspora.pem;
+ ssl_certificate_key /etc/ssl/diaspora.key;
+
+ location / {
+ proxy_pass http://127.0.0.1:8000;
+ proxy_set_header Host $host;
+ }
+}
+
+```
+
+Features
+--------
+
+* sqlite3 database for users and stories
+* JSON storage for messages and follows
+
+
+Usage
+-----
+
+Initially, DiasporaDiaries starts with no users. Once you write the
+first story and add an email, a user will be created for you with
+administrator capabilities. From then on, all subsequent users will
+employ normal capabilities.
+
+If a user writes an email address upon writing a story, an account is
+created for them as well, and this allows them to log in. Logging in
+gives access to some of the platform's features, such as a shoutbox,
+private messaging, and following other users and viewing profiles.
+
+Anonymous users may still write stories without their email, but they
+will not be viewable as profiles on the platform, nor will they be able
+to leave messages or send private messages.
+
+Administrators have an additional features of a dashboard, where they
+can make stories visible or hidden, edit the said stories, and manage
+users.
+
+
+License
+-------
+
+GNU Affero General Public License v3
+
+diasporadiaries is Copyright (C) 2019 Ivan Jelincic <parazyd@dyne.org>