doc/sso.txt

   1 Single Sign-On (SSO)
   2 ====================
   3
   4 This guide will walk you through setting up Keycloak for use with aurweb. For
   5 extensive documentation, see <https://www.keycloak.org/documentation.html>.
   6
   7 Installing Keycloak
   8 -------------------
   9
  10 Keycloak is in the official Arch repositories:
  11
  12     # pacman -S keycloak
  13
  14 The default port is 8080, which conflicts with aurweb’s default port. You need
  15 to edit `/etc/keycloak/standalone.xml`, looking for this line:
  16
  17     <socket-binding name="http" port="${jboss.http.port:8080}"/>
  18
  19 The default developer configuration assumes it is set to 8083. Alternatively,
  20 you may customize [options] aur_location and [sso] openid_configuration in
  21 `conf/config`.
  22
  23 You may then start `keycloak.service` through systemd.
  24
  25 See also ArchWiki <https://wiki.archlinux.org/title/Keycloak>.
  26
  27 Configuring a realm
  28 -------------------
  29
  30 Go to <http://127.0.0.1:8083/auth> and log in as administrator. Then, hover the
  31 text right below the Keycloak logo at the top left, by default *Master*. Click
  32 *Add realm* and name it *aurweb*.
  33
  34 Open the *Clients* tab, and create a new *openid-connect* client. Call it
  35 *aurweb*, and set the root URL to <http://127.0.0.1:8080> (your aur_location).
  36
  37 Create a user from the *Users* tab and try logging in from
  38 <http://127.0.0.1:8083/auth/realms/aurweb/account/>.