From d484a0a1d0286d03604db518517f7f49a18a848c Mon Sep 17 00:00:00 2001 From: Kegsay Date: Mon, 15 Aug 2016 14:32:17 +0100 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index e8a9e91..6aa80d6 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,37 @@ check that the server is still running. curl -X GET localhost:4050/test {} + +## Architecture + +``` + + HOMESERVER + | ++=============================================================+ +| | Go-NEB | +| +---------+ | +| | Clients | | +| +---------+ | +| | | +| +---------+ +------------+ +--------------+ | +| | Service |-------| Auth Realm |------| Auth Session |-+ | +| +---------+ +------------+ +--------------+ | | +| ^ ^ +---------------+ | +| | | | ++=============================================================+ + | | + WEBHOOK REDIRECT + REQUEST REQUEST + + +Clients = A thing which can talk to homeservers and listen for events. +Service = An individual bot, configured by a user. +Auth Realm = A place where a user can authenticate with. +Auth Session = An individual authentication session + + +``` Some `AuthRealms` support "Starter Links". These are HTTP URLs which knowledgeable clients should use to *start* the auth process. They are commonly returned as metadata to `!commands`. These links require the client to prove that they own a given user ID by appending a token