weblate/docs/admin/optionals.rst
Michal Čihař 200eb86884 Document running migration after installing billing
Signed-off-by: Michal Čihař <michal@cihar.com>
2017-01-30 09:11:26 +01:00

88 lines
1.9 KiB
ReStructuredText
Vendored

Optional Weblate modules
========================
Weblate comes with several optional modules which might be useful for your
setup.
.. _git-exporter:
Git exporter
------------
.. versionadded:: 2.10
The Git exporter provides you read only access to underlaying Git repository
using http.
Installation
++++++++++++
To install, simply add ``weblate.gitexport`` to installed applications in
:file:`settings.py`:
.. code-block:: python
INSTALLED_APPS += (
'weblate.gitexport',
)
After installing you need to migrate your database, so that existing
repositories are properly exported:
.. code-block:: sh
./manage.py migrate
Usage
+++++
The module automatically hooks into Weblate and sets exported repository URL in
the :ref:`component`.
The repositories are accessible under ``/git/`` path of the Weblate, for example
``https://example.org/git/weblate/master/``:
.. code-block:: sh
git clone 'https://example.org/git/weblate/master/'
Repositories are available anonymously unless :ref:`acl` is enabled. In that
case you need to authenticate using your API token (you can obtain it in your
:ref:`user-profile`):
.. code-block:: sh
git clone 'https://user:KEY@example.org/git/weblate/master/'
Billing
-------
.. versionadded:: 2.4
Billing module is used on `Hosted Weblate <https://weblate.org/hosting/>`_
and is used to define billing plans, track invoices and usage limits.
Installation
++++++++++++
To install, simply add ``weblate.billing`` to installed applications in
:file:`settings.py`:
.. code-block:: python
INSTALLED_APPS += (
'weblate.billing',
)
This module includes additional database structures, to have them installed you
should run the database migration:
.. code-block:: sh
./manage.py migrate
Usage
+++++
After installation you can control billing in the admin interface. Users with
billing enabled will get new :guilabel:`Billing` tab in their
:ref:`user-profile`.