Basic updates in docs.
[wolnelektury.git] / doc / installation.rst
1 =====
2 Setup
3 =====
4
5 Requirements
6 ------------
7
8 * `Python 3.5-3.7 <http://python.org>`_
9 * Python requiremets: ``pip install -r requirements/requirements.txt``
10 * a library for your database of choice
11   (see `DBs supported by Django <https://docs.djangoproject.com/en/dev/topics/install/#get-your-database-running>`_)
12 * `Sass <http://sass-lang.com>`_ >= 3.2 for parsing SCSS stylesheets
13 * Librarian has more dependencies if you want to build PDF and MOBI files, 
14   see lib/librarian/README.md
15 * `Solr <https://lucene.apache.org/solr/>`_ server if you want to search
16
17
18 Running
19 -------
20 Set up the database with::
21
22     ./manage.py migrate
23
24 Run the dev server with::
25
26     ./manage.py runserver
27
28 Some tasks (like generating e-books) run in a seperate
29 Celery process by default, so you'll also need to run::
30
31     celery -A wolnelektury worker --loglevel=INFO
32
33 Or, if you don't want to run a separate Celery daemon, set this
34 in your ``localsettings.py``::
35
36     CELERY_ALWAYS_EAGER = True
37
38
39 Deployment
40 ----------
41
42 TODO
43
44
45 Publishing books
46 ----------------
47
48 Books are represented as XML files.
49 You can import XML files from a directory by running::
50
51     ./manage.py importbooks ../books
52
53 Or you can publish a single XML by using publishing form in admin,
54 or the publishing API.