diff options
| -rw-r--r-- | README.md | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/README.md b/README.md index 2299f20..b8406c8 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,15 @@ blog. Some things aren't currently fully implemented. The non-exhaustive list is: - - Logging in via IndieAuth - - Using your website as an IndieAuth endpoint (polyfilled via an - external service) - - Sending Webmentions (though you can send them manually!) - - Receiving Webmentions - - Syndicating - - Token management (polyfilled via an external service) + + - Logging in to the website via IndieAuth (e.g. for private posts) + - Displaying received Webmentions (beyond counters) + - Syndication with social network silos + - UI for token management and revocation - Changing settings beyond what was filled in at the onboarding Some planned features also include: + - An interactive (and customizable) widget on the main page - Custom CSS - Custom syndication locations @@ -84,19 +83,22 @@ Kittybox to preserve your privacy and security. Set the following environment variables: - `BACKEND_URI`: Your storage backend URI, used to store post content. - - To use flat files, use `file://` and append an absolute path to - your folder like this: `file:///var/lib/kittybox/data` - <!-- - To use Redis (currently not working) use `redis://` and append - either an URI or a path to the Unix socket for your Redis - instance.--> + - To use flat files, use `file://` and append an absolute path to + your folder like this: `file:///var/lib/kittybox/data` + - To use Postgres, use `postgres://`. You probably know how to use this. + <!-- - To use Redis (currently not working) use `redis://` and append + either an URI or a path to the Unix socket for your Redis + instance.--> - `BLOBSTORE_URI`: Your media endpoint storage URI, used to store files uploaded via the media endpoint. - - To use flat files, use `file://` and append an absolute path to - your folder like this: `file:///var/lib/kittybox/media` + - To use flat files, use `file://` and append an absolute path to + your folder like this: `file:///var/lib/kittybox/media` - `AUTH_STORE_URI`: Storage for authentication-related data (tokens, authorization codes etc.) - - To use flat files, use `file://` and append an absolute path to - your folder like this: `file:///var/lib/kittybox/auth` + - To use flat files, use `file://` and append an absolute path to + your folder like this: `file:///var/lib/kittybox/auth` + - `JOB_QUEUE_URI`: Job queue URI, currently used for incoming + webmention handling. Only Postgres is supported (see above for syntax) Additionally you can customize the `SERVE_AT` environment variable to customize where Kittybox will listen to requests. |