diff --git a/doc/index.rst b/doc/index.rst index edb345b1a..41d06bf66 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -70,6 +70,7 @@ Table of contents installation upgrade configuration + moving rest_api contributing contributors diff --git a/doc/moving.rst b/doc/moving.rst new file mode 100644 index 000000000..f86338bac --- /dev/null +++ b/doc/moving.rst @@ -0,0 +1,53 @@ +################# +Moving to Modoboa +################# + +You have an existing platform and you'd like to move to Modoboa, the +following tools could help you. + +From postfixadmin +================= + +A dedicated command allows you to convert an existing `postfixadmin +`_ database to a Modoboa +one. Consult the `documentation +`_ to know more +about the process. + +Using CSV files +=============== + +Modoboa allows you to import any object (domain, domain alias, mailbox +and alias) using a simple CSV file encoded using **UTF8**. Each line +corresponds to a single object and must respect one of the following +format:: + + domain; ; ; ; + domainalias; ; ; + relaydomain; ; ; ; ; ; + account; ; ; ; ; ; ; ; ; [, ...] + alias; ; ; ; ... + +Boolean fields accept the following values: ``true``, ``1``, ``yes``, +``y`` (case insensitive). Any other value will be evaluated as false. + +.. warning:: + + The order does matter. Objects are created sequencially so a + domain must be created before its mailboxes and aliases and a + mailbox must created before its alias(es). + +To actually import such a file: + +.. sourcecode:: bash + + > sudo -u -i + > source /bin/activate + > cd + > python manage.py modo import + +Available options can be listed using the following command: + +.. sourcecode:: bash + + > python manage.py modo import -h