From 3c3f671957035fe96404868c81935ec84a35c03e Mon Sep 17 00:00:00 2001 From: jolheiser Date: Wed, 24 May 2023 15:27:26 -0500 Subject: [PATCH] chore: add config examples to readme Signed-off-by: jolheiser --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 695bac6..d3b025c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,31 @@ Invite links for your [Gitea](https://gitea.io) instance! +## Setup + +Configure Invitea with a config, environment variables, or flags. + +```yaml +domain: http://localhost:8080 +session-secret: honk +gitea-client-key: # OAuth2 app key +gitea-client-secret: # OAuth2 app secret +gitea-token: # Used for creating the accounts +gitea-url: https://git.jojodev.com +level: info +``` + +The CLI flags would match the key above and environment variables would match `INVITEA_`. + +```sh +./invitea --domain http://localhost8080 --session-secret honk +``` + +```sh +INVITEA_DOMAIN="http://localhost:8080" +INVITEA_SESSION_SECRET="honk" +``` + ## License [MIT](LICENSE) \ No newline at end of file