X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/8325a3ee5db92b5e219b1c853d12db8534ff8bba..563c8930b3b5643399dc409f6ed139f7289b6ea7:/README.rst?ds=sidebyside diff --git a/README.rst b/README.rst index 0f4e7ae1..351ca8b4 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,51 @@ -Instalacja -========== -1. Ściągnij i zainstaluj `pip `_ -2. Zainstaluj wymagane biblioteki komendą:: +==================== +Platforma Redakcyjna +==================== - pip install -f http://redmine.nowoczesnapolska.org.pl/projects/librarian/files -r requirements.txt +Opis projektu +============= +Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl. -Zależności -========== +Wymagania +========= +* `Django 1.1 `_ +* `django-piston 0.2.3rc1 `_ +* `librarian 1.2 `_ +* `lxml 2.2.2 `_ +* `Mercurial 1.3.1 `_ +* `PIL 1.1.6 `_ (wymagane przez skrypt imgconv.py) +* `pngnq `_ (wymagane przez skrypt imgconv.py) +* `zuber/django-cas-consumer `_ (wymagane do autoryzacji przez CAS) + +Instalacja i użycie +=================== +#. Ściągnij i zainstaluj `pip `_ +#. Przejdź do katalogu serwisu w konsoli +#. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą:: + + pip install -r requirements.txt + +#. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika):: + + ./project/manage.py syncdb + +#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. + +#. Uruchom serwer deweloperski:: + + ./project/manage.py runserver + +#. Zalecane jest serwowanie aplikacji przez `modwsgi `_ na serwerze `Apache2 `_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django `_. + +Wdrożenie +========= +#. Ściągnij i zainstaluj `fabric `_ +#. Przejdź do katalogu serwisu w konsoli +#. Aby wdrożyć serwis na serwer deweloperski wpisz komendę:: + + fab staging deploy + + Aby wdrożyć serwis na serwer produkcyjny wpisz:: + + fab production deploy - * `Django 1.1 `_ - * `Mercurial 1.3.1 `_ - * `librarian 1.2 `_ - * `PIL 1.1.6 `_ (wymagane przez skrypt imgconv.py) - * `pngnq `_ (wymagane przez skrypt imgconv.py)