X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/759c804d6c3b8db0ad99dcd5d155396b29ebedd7..94df6dd78db144202338eae9b4e90af44b0058c2:/README.rst diff --git a/README.rst b/README.rst index 8ddf4123..351ca8b4 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,13 @@ +==================== Platforma Redakcyjna ==================== Opis projektu -************* +============= Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl. Wymagania -********* +========= * `Django 1.1 `_ * `django-piston 0.2.3rc1 `_ * `librarian 1.2 `_ @@ -16,23 +17,35 @@ Wymagania * `pngnq `_ (wymagane przez skrypt imgconv.py) * `zuber/django-cas-consumer `_ (wymagane do autoryzacji przez CAS) -Instalacja -********** -1. Ściągnij i zainstaluj `pip `_ -2. Przejdź do katalogu serwisu w konsoli -3. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą:: +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 - pip install -f http://redmine.nowoczesnapolska.org.pl/projects/librarian/files -r requirements.txt +#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. -4. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika):: +#. Uruchom serwer deweloperski:: - ./manage.py syncdb + ./project/manage.py runserver -5. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. +#. 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 `_. -6. Uruchom serwer deweloperski:: +Wdrożenie +========= +#. Ściągnij i zainstaluj `fabric `_ +#. Przejdź do katalogu serwisu w konsoli +#. Aby wdrożyć serwis na serwer deweloperski wpisz komendę:: - ./manage.py runserver + fab staging deploy + + Aby wdrożyć serwis na serwer produkcyjny wpisz:: -7. 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 `_. + fab production deploy