From ae288f19d729259795f72d787f65757a328408f6 Mon Sep 17 00:00:00 2001 From: Tracker-Friendly Date: Wed, 26 Jun 2024 00:02:25 +0100 Subject: [PATCH] Add README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad8ecf4 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Burgerauth + +Burgerauth is a free-and-open-source OAuth2 server. + +## Ok, that's great, how do I host my own instance? + +First, replace the domains in the source code and templates with your own (a domain is required, not just an IP). Second, copy confit.ini.example to config.ini then tweak to your liking. Third, run `go build`, and fourth, run `./burgerauth`. Read ERRORS.md to see how to handle server errors. + +## What if I am a developer? + +The OAuth2 protocol should be fairly standard. Burgerauth comes with OpenID Connect discovery, and you should use that to find out the URL endpoints for the instance you are targeting, and you shouldn't really touch anything else. Burgerauth provides only authorization and not resource-delegation, and so doesn't issue refresh tokens. + +## How long did this take to make? + +Yes. \ No newline at end of file