about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorEugen Rochko <eugen@zeonfederated.com>2016-02-23 22:17:07 +0100
committerEugen Rochko <eugen@zeonfederated.com>2016-02-23 22:17:07 +0100
commitee73d35eea024894e851d807132c3f21a133152d (patch)
tree9368486314b3665376d55e2a44ccf1f1de12fd48 /README.md
parentfa33750105389110a3395ca19167f789d21a149e (diff)
Incoming Salmon requests can be turned into follows and unfollows
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index ce820af34..588c763f3 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,9 @@ The core ideals of this project are:
 - Ease of deployment. The end-goal of this project is to be distributable as a Docker image.
 
 **Current status of the project is early development. Documentation, licensing information &co will be added later**
+
+## Configuration
+
+- `LOCAL_DOMAIN` should be the domain/hostname of your instance. This is **absolutely required** as it is used for generating unique IDs for everything federation-related
+- `LOCAL_HTTPS` set it to `true` if HTTPS works on your website. This is used to generate canonical URLs, which is also important when generating and parsing federation-related IDs
+- `HUB_URL` should be the URL of the PubsubHubbub service that your instance is going to use. By default it is the open service of Superfeedr