Fixes for CAS + OIDC
[cas.git] / README.md
1 O projekcie
2 -----------
3
4 CAS to aplikacja WWW służąca do uwierzytelniania użytkowników 
5 serwisów Fundacji Nowoczesna Polska. Implementuje ona protokół CAS <http://www.jasig.org/cas>
6 w  wersjach 1.0 i 2.0.
7
8 Wymagania
9 ---------
10
11 * Zobacz requirements.txt
12
13 Instalacja i uruchomienie
14 -------------------------
15
16 1. Zainstaluj wymagane biblioteki, np. używając pip:
17
18     pip install -r requirements.txt
19
20 2. Wypełnij bazę danych
21
22         ./manage.py migrate
23
24 3. Aby utworzyć pierwszego użytkownika, użyj komendy:
25
26         ./manage createsuperuser
27
28 5. Uruchom serwer deweloperski
29
30         ./manage.py runserver
31
32 6. Przy wdrożeniu utwórz plik `localsettings.py` i wpisz tam 
33 ustawienia używanej bazy danych. Do przygotowania wersji do
34 wdrożenia możesz użyć komendy `make deploy`.
35
36 OpenID Connect
37 --------------
38
39 Aplikacja działa też jako dostawca OIDC (`django-oidc-provider`),
40 pod adresem `/openid/` (konfiguracja: `/openid/.well-known/openid-configuration`).
41
42 Przy wdrożeniu:
43
44 * ustaw zmienną środowiskową `SITE_URL` (np. `https://cas.example.org`);
45   issuer będzie wtedy `https://cas.example.org/openid`,
46 * jednorazowo wygeneruj klucz podpisujący: `./manage.py creatersakey`,
47 * klientów (usługi) dodaje się w panelu admina: OpenID Connect Provider → Clients.
48
49 Udostępniane claimy (`emails/oidc.py`): `sub` (id użytkownika), `preferred_username`
50 (login), `name`, `given_name`, `family_name`, `email`, `email_verified`.