X-Git-Url: https://git.mdrn.pl/cas.git/blobdiff_plain/a7d807af1096c152baf5c32f4f4b3f1a26ea2c76..a98197a1a1dd5fb58e727cb334bfc2357501d366:/README.md diff --git a/README.md b/README.md index d63f735..7ce5880 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,50 @@ O projekcie ----------- -CAS to aplikacja WWW służąca do uwierzytelniania (a w przyszłości również autoryzacji) użytkowników -serwisów Fundacji Nowoczesna Polska. Implementuje on protokół CAS w -wersji 1.0. +CAS to aplikacja WWW służąca do uwierzytelniania użytkowników +serwisów Fundacji Nowoczesna Polska. Implementuje ona protokół CAS +w wersjach 1.0 i 2.0. Wymagania --------- -* Django 1.1 -* zuber/django-cas-provider +* Zobacz requirements.txt Instalacja i uruchomienie ------------------------- -1. Ściągnij i zainstaluj pip -2. Przejdź do katalogu aplikacji w konsoli -3. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą +1. Zainstaluj wymagane biblioteki, np. używając pip: pip install -r requirements.txt -4. 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 - 5. Uruchom serwer deweloperski ./manage.py runserver -6. Przy wdrożeniu będziesz musiał najpewniej utworzyć plik `localsettings.py` i wpisać tam -ustawienia używanej bazy danych. Zalecane jest serwowanie aplikacji przez modwsgi na serwerze Apache2. \ No newline at end of file +6. Przy wdrożeniu utwórz plik `localsettings.py` i wpisz tam +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`.