Fixes for CAS + OIDC
[cas.git] / README.md
index 724d3ba..7ce5880 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,13 +17,34 @@ Instalacja i uruchomienie
 
     pip install -r requirements.txt
 
 
     pip install -r requirements.txt
 
-2. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)
+2. Wypełnij bazę danych
+
+       ./manage.py migrate
+
+3. Aby utworzyć pierwszego użytkownika, użyj komendy:
+
+       ./manage createsuperuser
 
 
-       ./manage.py syncdb --migrate
-       
 5. Uruchom serwer deweloperski
 
        ./manage.py runserver
 
 6. Przy wdrożeniu utwórz plik `localsettings.py` i wpisz tam 
 5. Uruchom serwer deweloperski
 
        ./manage.py runserver
 
 6. Przy wdrożeniu utwórz plik `localsettings.py` i wpisz tam 
-ustawienia używanej bazy danych.
+ustawienia używanej bazy danych. Do przygotowania wersji do
+wdrożenia możesz użyć komendy `make deploy`.
+
+OpenID Connect
+--------------
+
+Aplikacja działa też jako dostawca OIDC (`django-oidc-provider`),
+pod adresem `/openid/` (konfiguracja: `/openid/.well-known/openid-configuration`).
+
+Przy wdrożeniu:
+
+* ustaw zmienną środowiskową `SITE_URL` (np. `https://cas.example.org`);
+  issuer będzie wtedy `https://cas.example.org/openid`,
+* jednorazowo wygeneruj klucz podpisujący: `./manage.py creatersakey`,
+* klientów (usługi) dodaje się w panelu admina: OpenID Connect Provider → Clients.
+
+Udostępniane claimy (`emails/oidc.py`): `sub` (id użytkownika), `preferred_username`
+(login), `name`, `given_name`, `family_name`, `email`, `email_verified`.