fix documentation formating, use of a symbolic link for frontend deployment

This commit is contained in:
Spitap
2023-02-11 16:36:03 +01:00
parent 4f709852e6
commit 5e7087c335
3 changed files with 12 additions and 9 deletions
+2 -1
View File
@@ -11,13 +11,14 @@ documentation.
**You will find them using the following url patterns:**
* New API+Docs: *https://<hostname>/api/schema-v2/swagger/*
* Old API: *http://<hostname>/api/v1/
* Old API: *http://<hostname>/api/v1/*
* (Old) Documentation: *http://<hostname>/docs/api/*
**Examples:**
* `new example <https://demo.modoboa.org/api/schema-v2/swagger/>`_
* `old example <https://demo.modoboa.org/docs/api/>`_
documentation is available on the official demo.
Using this API requires an authentication and for now, only a token
+9 -7
View File
@@ -53,14 +53,17 @@ Then, reload postfix.
New-admin interface
===================
New admin interface won't update by itself. To do so, run the following commands:
.. note::
You don't need to perform these actions if you installed modoboa after 2.0.5.
New admin interface won't update by itself. To fix this, run the following commands (you need to perform this only one time):
.. sourcecode:: bash
> sudo -u <modoboa_user> -i bash
> cd <modoboa_instance_dir>
> rm -rf frontend
> cp -R <virtuenv_path>/lib/pythonX.X/site-packages/modoboa/frontend_dist/ frontend/
> ln -s <virtuenv_path>/lib/pythonX.X/site-packages/modoboa/frontend_dist/ frontend/
Extensions
**********
@@ -136,13 +139,13 @@ The following modifications must be applied to the :file:`settings.py` file:
]
* Add the following variable::
* Add the following variable:
.. sourcecode:: python
PID_FILE_STORAGE_PATH = '/var/run'
* Update ``LOGGING`` variable to define an address for ``syslog-auth`` handler::
* Update ``LOGGING`` variable to define an address for ``syslog-auth`` handler:
.. sourcecode:: python
@@ -154,9 +157,8 @@ The following modifications must be applied to the :file:`settings.py` file:
},
* You now have the possibility to customize the url of the new-admin
interface. To do so please head up to :ref:`the custom configuration
chapter <customization>` (advanced user).
* You now have the possibility to customize the url of the new-admin interface.
To do so please head up to :ref:`the custom configuration chapter <customization>` (advanced user).
* Add ``DEFAULT_THROTTLE_RATES`` to ``REST_FRAMEWORK``:
+1 -1
View File
@@ -273,7 +273,7 @@ class DeployCommand(Command):
if not os.path.exists(base_frontend_dir):
return
frontend_target_dir = "{}/frontend".format(parsed_args.name)
shutil.copytree(base_frontend_dir, frontend_target_dir)
os.symlink(base_frontend_dir, frontend_target_dir, True)
with open("{}/config.json".format(frontend_target_dir), "w") as fp:
fp.write("""{