Initial commit
[cas.git] / README.rst
1 ================================
2 Fundacja Nowoczesna Polska - CAS
3 ================================
4
5 O projekcie
6 ===========
7 CAS to aplikacja WWW służąca do autentykacji (a w przyszłości również autoryzacji) użytkowników 
8 serwisów Fundacji Nowoczesna Polska. Implementuje on protokół `CAS <http://www.jasig.org/cas>`_ w 
9 wersji 1.0.
10
11 Wymagania
12 =========
13 * `Django 1.1 <http://djangoproject.com/>`_
14 * `zuber/django-cas-provider <http://github.com/zuber/django-cas-provider>`_
15
16 Instalacja i uruchomienie
17 =========================
18 1. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
19 2. Przejdź do katalogu aplikacji w konsoli
20 3. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą::
21
22         pip install -r requirements.txt
23
24 4. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
25
26         ./manage.py syncdb
27         
28 5. Uruchom serwer deweloperski::
29
30         ./manage.py runserver
31
32 6. Przy wdrożeniu będziesz musiał najpewniej utworzyć plik `localsettings.py` i wpisać tam 
33 ustawienia używanej bazy danych. Zalecane jest serwowanie aplikacji 
34 przez `modwsgi <http://code.google.com/p/modwsgi/>`_ na serwerze `Apache2 <http://httpd.apache.org/>`_ 
35 przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane 
36 są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_.