summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 45850c9..834f753 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@ This is a simple authenticating reverse proxy written in Go. It provides a flexi
It handles user registration, login, and session management, and proxies authenticated requests to the configured backend. It also includes an administration dashboard for user management.
+## Try the Demo
+```bash
+chmod +x run-demo.sh
+bash run-demo.sh
+```
+
## Why I Built This
I'm also the developer of [puremania](https://github.com/haturatu/puremania), and I wanted to avoid adding complex authentication logic to that project.
@@ -484,4 +490,4 @@ The base path for these endpoints is `/api/admin/users`, which can be customized
| `ENV` | The runtime environment. Set to `production` to enable secure cookies. | - |
| `CSRF_SECRET_KEY` | **(Required)** A 32-byte random key for CSRF protection. Generate with `openssl rand -base64 32`. | - |
| `CSRF_TRUSTED_ORIGINS` | A comma-separated list of trusted origins for CSRF protection. | - |
-| `CSRF_SAME_SITE` | The SameSite attribute for the CSRF cookie. Can be `lax`, `strict`, or `none`. | `lax` | \ No newline at end of file
+| `CSRF_SAME_SITE` | The SameSite attribute for the CSRF cookie. Can be `lax`, `strict`, or `none`. | `lax` |