From: David Kerkeslager <kerkeslager@gmail.com>
Date: Thu, 13 Aug 2020 02:55:24 +0000 (-0400)
Subject: Add to README
X-Git-Url: https://code.kerkeslager.com/?p=styx.blog;a=commitdiff_plain;h=f11ad06aa0def19169ca60210f644f7b630084e4

Add to README
---

diff --git a/README.md b/README.md
index a0caea4..af9e5cf 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,13 @@ styx.blog
 =========
 
 This is the source code for [Styx](https://styx.blog).
+
+This application runs on a SQLite3 local DB in debug mode by default. To override this
+behavior without changing the code, you can configure the application in a JSON file
+located at`~/.styxrc`. Once DEBUG is turned off in that file, you can provide a SECRET_KEY
+and DB_PASSWORD. Styx does expect a Postgres database named `styx`, but that can easily
+be configured at a later date.
+
+The server was configured using [this tutorial](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-debian-9)
+(backup link [here](https://web.archive.org/web/20200813024859/https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-debian-9)).
+That tutorial has a bunch of helpful debugging tips at the end.