diff --git a/src/postorius/doc/deployment.rst b/src/postorius/doc/deployment.rst index 2aa5757..d4923f0 100644 --- a/src/postorius/doc/deployment.rst +++ b/src/postorius/doc/deployment.rst @@ -19,7 +19,7 @@ [uwsgi] chdir = /srv/django/mailman - module = postorius_standalone.wsgi + module = example_project.wsgi virtualenv = /srv/django/mailman/env master = true @@ -97,21 +97,21 @@ :: - Alias /static /path/to/postorius_standalone/static - + Alias /static /srv/django/mailman/public/static + Order deny,allow Allow from all - WSGIScriptAlias / /path/to/postorius_standalone/srv/postorius.wsgi - + WSGIScriptAlias / /srv/django/mailman/srv/postorius.wsgi + Order deny,allow Allow from all The first Alias serves the static files (CSS, JS, Images, etc.). The WSGIScriptAlias serves the Django application. The paths need to be changed -depending on which location you downloaded ``postorius_standalone`` to. +depending on which location you have your postorius project in. Final setup instructions ======================== @@ -119,7 +119,7 @@ We're almost ready. But you need to create translations and collect the static files from Postorius (which resides somewhere on your pythonpath) to be able to serve them from the site directory. All you have to do is to change into the -``postorius_standalone`` directory and run: +postorius project directory and run: :: diff --git a/src/postorius/doc/development.rst b/src/postorius/doc/development.rst index 1dc3349..d85fdcd 100644 --- a/src/postorius/doc/development.rst +++ b/src/postorius/doc/development.rst @@ -129,8 +129,8 @@ Accessing the Mailman API ========================= -Postorius uses mailman.client to connect to Mailman's REST API. In order to -directly use the client, ``cd`` to your project folder and execute +Postorius uses mailmanclient to connect to Mailman's REST API. In order to +directly use the client, ``cd`` to the ``example_project`` folder and execute ``python manage.py mmclient``. This will open a python shell (IPython, if that's available) and provide you with a client object connected to to your local Mailman API server (it uses the credentials from your settings.py). @@ -144,14 +144,14 @@ >>> client - >>> print client.system['mailman_version'] + >>> print(client.system['mailman_version']) GNU Mailman 3.0.0b2+ (Here Again) >>> mailman_dev = client.get_list('mailman-developers@python.org') - >>> print mailman_dev settings + >>> print(mailman_dev.settings) {u'description': u'Mailman development', u'default_nonmember_action': u'hold', ...} -For detailed information how to use mailman.client, check out its documentation_. +For detailed information how to use mailmanclient, check out its documentation_. .. _documentation: https://gitlab.com/mailman/mailmanclient/blob/master/src/mailmanclient/docs/using.rst diff --git a/src/postorius/doc/setup.rst b/src/postorius/doc/setup.rst index 62e86d0..91c1203 100644 --- a/src/postorius/doc/setup.rst +++ b/src/postorius/doc/setup.rst @@ -27,12 +27,6 @@ $ pip install postorius -or: - -:: - - $ easy_install postorius - Latest dev version ------------------ @@ -53,28 +47,24 @@ Since you have now installed the necessary packages to run Postorius, it's time to setup your Django site. -First, get the project directory from gitlab: +You can find an example project in ``example_project`` in the root of +``postorius'`` git repository. -:: - - $ git clone https://gitlab.com/mailman/postorius_standalone.git - -Change the database setting in ``postorius_standalone/settings.py`` to +Change the database setting in ``example_project/settings.py`` to your preferred database, if you want something other than SQlite. .. note:: Detailed information on how to use different database engines can be found in the `Django documentation`_. -.. _Django documentation: https://docs.djangoproject.com/en/1.8/ref/settings/#databases +.. _Django documentation: https://docs.djangoproject.com/en/1.9/ref/settings/#databases Third, prepare the database: :: - $ cd postorius_standalone + $ cd example_project $ python manage.py migrate - $ cd .. This will create the ``.db file`` (if you ar using SQLite) and will setup all the necessary db tables. @@ -82,9 +72,8 @@ To create a superuser which will act as an admin account for Postorius, run the following commands:: - $ cd postorius_standalone + $ cd example_project $ python manage.py createsuperuser - $ cd .. Running the development server @@ -94,7 +83,7 @@ :: - $ cd postorius_standalone + $ cd example_project $ python manage.py runserver