351ca8b4db02e0a5ec8e19528809a365c2f29cd4
[redakcja.git] / README.rst
1 ====================
2 Platforma Redakcyjna
3 ====================
4
5 Opis projektu
6 =============
7 Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
8
9 Wymagania
10 =========
11 * `Django 1.1 <http://djangoproject.com/>`_
12 * `django-piston 0.2.3rc1 <http://bitbucket.org/jespern/django-piston/>`_
13 * `librarian 1.2 <http://redmine.nowoczesnapolska.org.pl/projects/show/librarian>`_
14 * `lxml 2.2.2 <http://codespeak.net/lxml/>`_
15 * `Mercurial 1.3.1 <http://www.selenic.com/mercurial/>`_
16 * `PIL 1.1.6 <http://www.pythonware.com/products/pil/>`_ (wymagane przez skrypt imgconv.py)
17 * `pngnq <http://pngnq.sourceforge.net/>`_ (wymagane przez skrypt imgconv.py)
18 * `zuber/django-cas-consumer <http://github.com/zuber/django-cas-consumer>`_ (wymagane do autoryzacji przez CAS)
19
20 Instalacja i użycie
21 ===================
22 #. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
23 #. Przejdź do katalogu serwisu w konsoli
24 #. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą::
25
26         pip install -r requirements.txt
27
28 #. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
29
30         ./project/manage.py syncdb
31
32 #. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
33
34 #. Uruchom serwer deweloperski::
35
36         ./project/manage.py runserver
37
38 #. Zalecane jest serwowanie aplikacji przez `modwsgi <http://code.google.com/p/modwsgi/>`_ na serwerze `Apache2 <http://httpd.apache.org/>`_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_.
39
40 Wdrożenie
41 =========
42 #. Ściągnij i zainstaluj `fabric <http://docs.fabfile.org/>`_
43 #. Przejdź do katalogu serwisu w konsoli
44 #. Aby wdrożyć serwis na serwer deweloperski wpisz komendę::
45
46         fab staging deploy
47         
48  Aby wdrożyć serwis na serwer produkcyjny wpisz::
49
50         fab production deploy
51