github-jwinterm/modoboa
1
0
Fork 0
mirror of https://github.com/jwinterm/modoboa.git synced 2026-10-17 05:41:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updated.

Browse Source
This commit is contained in:
Antoine Nguyen
2015-04-08 15:58:06 +02:00
parent d11c8265ba
commit c5040c5902
4 changed files with 90 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/conf.py
+2 -2
View File
@@ -50,9 +50,9 @@ copyright = u'2015, Antoine Nguyen'
# built documents.
#
# The short X.Y version.
version = '1.2'
version = '1.3'
# The full version, including alpha/beta/rc tags.
release = '1.2.1'
release = '1.3.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
doc/getting_started/install.rst
+26 -22
View File
@@ -93,37 +93,31 @@ Deployment
`modoboa-admin.py`, a command line tool, lets you deploy a
*ready-to-use* Modoboa site using only one instruction::
$ modoboa-admin.py deploy modoboa_example --collectstatic [--with-amavis] [--dburl database-url] [--amavis_dburl database-url]
Just answer the few questions and you're done. You can now go to the
:ref:`first_use` section.
$ modoboa-admin.py deploy modoboa_example --collectstatic [--dburl default:database-url] [--extensions extensions]
.. note::
The `--with-amavis` option must be set only if you intend to use
the :ref:`amavis_frontend`.
In case you need a **silent installation** (e.g. if you're using
Salt-Stack, Ansible or whatever), it's possible to supply the database
credentials as commandline arguments.
You can see the complete option list by running the following command::
$ modoboa-admin.py help deploy
By default, only the core application of Modoboa is installed. To
install extensions, use the ``--extensions`` option which accepts a
list of extension names as argument (``--extensions ext1 ext2 ...``).
If you want to use install all extensions, just use the ``all``
shortcut like this ``--extensions all``.
.. note::
`--dburl database-url` for the modoboa database credentials
`--amavis_dburl database-url` for the amavis database credentials
You can specify more than one database connection using the
``--dburl`` option. Multiple connections are differentiated by a
prefix. The primary connection must use the ``default:`` prefix (as
shown in the example above). For the `amavis extension
<http://modoboa-amavis.readthedocs.org>`_ extension, use the
``amavis:`` prefix like this ``--dburl amavis:<database url>``.
Your database-url should meet the following syntax:
``scheme://[user:pass@][host:port]/dbname``
Your database url should meet the following syntax
``scheme://[user:pass@][host:port]/dbname`` **OR**
``sqlite:////full/path/to/your/database/file.sqlite``.
**or**
Available schemes are:
``sqlite:////full/path/to/your/database/file.sqlite``
Available `schemes` are:
* postgres
* postgresql
* postgis
@@ -131,6 +125,16 @@ You can see the complete option list by running the following command::
* mysql2
* sqlite
The command will ask you a few questions, answer them and you're
done. You can now go to the :ref:`first_use` section.
In case you need a **silent installation** (e.g. if you're using
Salt-Stack, Ansible or whatever), it's possible to supply the database
credentials as commandline arguments.
You can see the complete option list by running the following command::
$ modoboa-admin.py help deploy
.. note::
doc/getting_started/upgrade.rst
+60 -3
View File
@@ -33,9 +33,8 @@ your instance was first deployed::
If you customized your configuration file (:file:`settings.py`) with
non-standard settings, you'll have to re-apply them.
Then, run ``modoboa-admin.py deploy``::
$ modoboa-admin.py deploy <modoboa_instance_dir> --collectstatic [--with-amavis] [--dburl database-url] [--amavis_dburl database-url] [--domain hostname] [--lang lang] [--timezone timezone]
Finally, run the ``deploy`` comamand. Make sure to consult the
:ref:`deployment` section to know more about the available options.
If you prefer the manual way, check if
:ref:`specific_upgrade_instructions` are required according to the
@@ -50,6 +49,64 @@ you did choose. See :ref:`webservers` for more details.
Specific upgrade instructions
*****************************
1.3.0
=====
This release does not bring awesome new features but it is a necessary
bridge to the future of Modoboa. All extensions now have their own git
repository and the deploy process has been updated to reflect this
change.
Another important update is the use of Django 1.7. Besides its new
features, the migration system has been reworked and is now more
robust than before.
Before we begin with the procedure, here is a table showing old
extension names and their new name:
+----------------------------------------+--------------------------+--------------------------+
|Old name |New package name |New module name |
+========================================+==========================+==========================+
|modoboa.extensions.admin |modoboa-admin |modoboa_admin |
+----------------------------------------+--------------------------+--------------------------+
|modoboa.extensions.limits |modoboa-admin-limits |modoboa_admin_limits |
+----------------------------------------+--------------------------+--------------------------+
|modoboa.extensions.postfix_autoreply |modoboa-postfix-autoreply |modoboa_postfix_autoreply |
+----------------------------------------+--------------------------+--------------------------+
|modoboa.extensions.postfix_relay_domains|modoboa-admin-relaydomains|modoboa_admin_relaydomains|
+----------------------------------------+--------------------------+--------------------------+
|modoboa.extensions.radicale |modoboa-radicale |modoboa_radicale |
+----------------------------------------+--------------------------+--------------------------+
|modoboa.extensions.sievefilters |modoboa-sievefilters |modoboa_sievefilters |
+----------------------------------------+--------------------------+--------------------------+
|modoboa.extensions.stats |modoboa-stats |modoboa_stats |
+----------------------------------------+--------------------------+--------------------------+
|modoboa.extensions.webmail |modoboa-webmail |modoboa_webmail |
+----------------------------------------+--------------------------+--------------------------+
Here are the required steps:
#. Install the extensions using pip (look at the second column in the table above)::
$ pip install <the extensions you want>
#. Remove ``south`` from ``INSTALLED_APPS``
#. Rename old extension names inside ``MODOBOA_APPS`` (look at the third column in the table above)
#. Remove ``modoboa.lib.middleware.ExtControlMiddleware`` from ``MIDDLEWARE_CLASSES``
#. Change ``DATABASE_ROUTERS`` to::
DATABASE_ROUTERS = ["modoboa_amavis.dbrouter.AmavisRouter"]
#. Run the following commands::
$ cd <modoboa_instance_dir>
$ python manage.py migrate
$ python manage.py load_initial_data
$ python manage.py collectstatic
1.2.0
=====
doc/integration/imap_and_smtp.rst
+2 -2
View File
@@ -422,9 +422,9 @@ be used by Postfix to lookup into Modoboa tables.
To automaticaly generate the requested map files and store them in a
directory, run the following command::
$ modoboa-admin.py postfix_maps --dbtype <mysql|postgres|sqlite> mapfiles
$ modoboa-admin.py postfix_maps --dbtype <mysql|postgres|sqlite> --extensions <extension names> <directory>
:file:`mapfiles` is the directory where the files will be
``<directory>`` is the directory where the files will be
stored. Answer the few questions and you're done.
.. _postfix_config: