Update: README with instructions for using start_salami

1 files changed, 45 insertions, 0 deletions

diff --git a/README b/README
index 255a6d9..5c624ed 100644
--- a/README
+++ b/README
@@ -7,6 +7,51 @@ server. Originally developed to help development of Qvarn
 credentials** grant. Later on, we hope to develop this into an OpenID
 Connect provider.
 
+
+Configuration for testing
+-----------------------------------------------------------------------------
+
+The `debug.yaml` file contains a sample configuration file for Salami
+for debugging and light testing. Use it with the `start_salami`
+script.
+
+The config defines one API client, client id `test-client`, with a
+client secret of "hunter2".
+
+
+Running Salami for debugging
+-----------------------------------------------------------------------------
+
+At the root of the source tree, run the following:
+
+    ./start_salami debug.yaml
+
+This starts Salami using the Bottle.py built-in debug HTTP server,
+instead of gunicorn. This makes it easier to debug Salami. If you'd
+like to run it with gunicorn instead, add the following line to
+`debug.yaml`:
+
+    gunicorn: yes
+
+Then run this:
+
+    ./start_salami debug.yaml
+
+This runs Salami with gunicorn. Note that that means it is run in the
+background. You will need to kill the process manually.
+
+
+Running Salami for production
+-----------------------------------------------------------------------------
+
+Install Salami and then run:
+
+    start_salami /etc/salamia/salami.yaml
+
+This runs Salami using gunicorn. Better, install the `salami.service`
+systemd unit and start Salami with that.
+
+
 Merging workflow
 -----------------------------------------------------------------------------