Skip to content

Latest commit

 

History

History
1319 lines (886 loc) · 36.4 KB

install.rst

File metadata and controls

1319 lines (886 loc) · 36.4 KB
Raw

Installation instructions

Hardware requirements

Weblate should run on any contemporary hardware without problems, following are minimal configuration required to run Weblate on single host (Weblate, database and web server):

  • 1 GB of RAM memory
  • 2 CPU cores
  • 1 GB of storage space

The more memory you have, the better - it will be used for caching on all levels (filesystem, database and Weblate).

Note

The actual requirements for your installation heavily vary on size of translations managed by Weblate.

Software requirements

Python dependencies

Weblate is written in Python and support Python 2.7, 3.4 or newer. Following dependencies can be installed using pip or your distribution packages:

Django (>= 1.10)
https://www.djangoproject.com/
siphashc (>= 0.8)
https://github.com/WeblateOrg/siphashc
Translate-toolkit (>= 2.0.0)
http://toolkit.translatehouse.org/
Six (>= 1.7.0)
https://pypi.python.org/pypi/six
Mercurial (>= 2.8) (optional for Mercurial repositories support)
https://www.mercurial-scm.org/
social-auth-core (>= 1.3.0)
https://python-social-auth.readthedocs.io/
social-auth-app-django (>= 1.2.0)
https://python-social-auth.readthedocs.io/
django-appconf (>= 1.0)
https://github.com/django-compressor/django-appconf
Whoosh (>= 2.7.0)
https://bitbucket.org/mchaput/whoosh/wiki/Home
PIL or Pillow library
https://python-pillow.org/
lxml (>= 3.1.0)
http://lxml.de/
PyYaML (>= 3.0) (optional for YAML support)
http://pyyaml.org/wiki/PyYAML
defusedxml (>= 0.4)
https://bitbucket.org/tiran/defusedxml
dateutil
https://labix.org/python-dateutil
django_compressor (>= 2.1.1)
https://github.com/django-compressor/django-compressor
django-crispy-forms (>= 1.6.1)
https://django-crispy-forms.readthedocs.io/
Django REST Framework (>=3.4)
http://www.django-rest-framework.org/
libravatar (optional for federated avatar support)

You need to additionally install pydns (on Python 2) or py3dns (on Python 3) to make libravatar work.

https://pypi.python.org/pypi/pyLibravatar

pyuca (>= 1.1) (optional for proper sorting of strings)
https://github.com/jtauber/pyuca
babel (optional for Android resources support)
http://babel.pocoo.org/
Database backend
Any database supported in Django will work, see :ref:`database-setup` and backends documentation for more details.
pytz (optional, but recommended by Django)
https://pypi.python.org/pypi/pytz/
python-bidi (optional for proper rendering of badges in RTL languages)
https://github.com/MeirKriheli/python-bidi
tesserocr (>= 2.0.0) (optional for screenshots OCR)
https://github.com/sirfz/tesserocr

Other system requirements

Following dependencies have to be installed on the system:

Git (>= 1.6)
https://git-scm.com/
hub (optional for sending pull requests to GitHub)
https://hub.github.com/
git-review (optional for Gerrit support)
https://pypi.python.org/pypi/git-review
git-svn (>= 2.10.0) (optional for Subversion support)
https://git-scm.com/docs/git-svn
tesseract and it's data (optional for screenshots OCR)
https://github.com/tesseract-ocr/tesseract

Compile time dependencies

To compile some of the :ref:`python-deps` you might need to install their dependencies. This depends on how you install them and please consult individual packages for domentation. You won't need those if using prebuilt Wheels while installing using pip or when you use distribution packages.

Installing Weblate

Choose installation method that best fits your environment.

First choices include complete setup without relying on your system libraries:

You can also install Weblate directly on your system either fully using distribution packages (as of now available for openSUSE only) or mixed setup.

Choose installation method:

And install dependencies according your platform:

Installing in virtualenv

This is recommended method if you don't want to dig into details. This will create separate Python environment for Weblate, possibly duplicating some system Python libraries.

  1. Install development files for libraries we will use during building Python modules:

    # Debian/Ubuntu:
apt install libxml2-dev libxslt-dev libfreetype6-dev libjpeg-dev libz-dev libyaml-dev python-dev

# openSUSE/SLES:
zypper install libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel python-devel

# Fedora/RHEL/CentOS:
dnf install libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel python-devel

  2. Install pip and virtualenv. Usually they are shipped by your distribution or with Python:

    # Debian/Ubuntu:
apt-get install python-pip python-virtualenv

# openSUSE/SLES:
zypper install python-pip python-virtualenv

# Fedora/RHEL/CentOS:
dnf install python-pip python-virtualenv

  3. Create and activate virtualenv for Weblate (the path in /tmp is really just an example, you rather want something permanent):

    virtualenv /tmp/weblate
. /tmp/weblate/bin/activate

  4. Install Weblate including all dependencies, you can also use pip to install optional dependecies:

    pip install Weblate
# Optional deps
pip install pytz python-bidi PyYaML Babel pyuca pylibravatar pydns

  5. Create your settings (in our example it would be in :file:`/tmp/weblate/lib/python2.7/site-packages/weblate/settings.py` based on the :file:`settings_example.py` in same directory).

  6. You can now run Weblate commands using :command:`weblate` command, see :ref:`manage`.

  7. To run webserver, use the wsgi wrapper installed with Weblate (in our case it is :file:`/tmp/weblate/lib/python2.7/site-packages/weblate/wsgi.py`). Don't forget to set Python search path to your virtualenv as well (for example using virtualenv = /tmp/weblate in uwsgi).

Installing Weblate from Git

You can also run latest version from Git. It is maintained stable and production ready. You can usually find it running on Hosted Weblate.

To get latest sources using Git use:

git clone https://github.com/WeblateOrg/weblate.git

Note

If you are running version from Git, you should also regenerate locale files every time you are upgrading. You can do this by invoking script :file:`./scripts/generate-locales`.

Installing Weblate by pip

If you decide to install Weblate using pip installer, you will notice some differences. Most importantly the command line interface is installed to the system path as :command:`weblate` instead of :command:`./manage.py` as used in this documentation. Also when invoking this command, you will have to specify settings, either by environment variable DJANGO_SETTINGS or on the command line, for example:

weblate --settings=yourproject.settings migrate
.. seealso:: :ref:`invoke-manage`

Requirements on Debian or Ubuntu

On recent Debian or Ubuntu, most of requirements are already packaged, to install them you can use apt-get:

apt-get install python-pip python-django translate-toolkit \
    python-whoosh python-pil python-libravatar \
    python-babel git mercurial \
    python-django-compressor python-django-crispy-forms \
    python-djangorestframework python-dateutil

# Optional packages for database backend:

# For PostgreSQL
apt-get install python-psycopg2
# For MySQL on Ubuntu (if using Ubuntu package for Django)
apt-get install python-pymysql
# For MySQL on Debian (or Ubuntu if using upstream Django packages)
apt-get install python-mysqldb

On older versions, some required dependencies are missing or outdated, so you need to install several Python modules manually using pip:

# Dependencies for python-social-auth
apt-get install python-requests-oauthlib python-six python-openid

# Social auth
pip install social-auth-core
pip install social-auth-app-django

# In case your distribution has python-django older than 1.9
pip install Django

# In case python-django-crispy-forms package is missing
pip install django-crispy-forms

# In case python-whoosh package is misssing or older than 2.7
pip install Whoosh

# In case your python-django-compressor package is missing,
# try installing it by older name or using pip:
apt-get install python-compressor
pip install django_compressor

# Optional for OCR support
apt-get install tesseract-ocr libtesseract-dev libleptonica-dev cython
pip install tesserocr

For proper sorting of a Unicode strings, it is recommended to install pyuca:

pip install pyuca

Depending on how you intend to run Weblate and what you already have installed, you might need additional components:

# Web server option 1: nginx and uwsgi
apt-get install nginx uwsgi uwsgi-plugin-python

# Web server option 2: Apache with mod_wsgi
apt-get install apache2 libapache2-mod-wsgi

# Caching backend: memcached
apt-get install memcached

# Database option 1: postgresql
apt-get install postgresql

# Database option 2: mariadb
apt-get install mariadb-server

# Database option 3: mysql
apt-get install mysql-server

# SMTP server
apt-get install exim4

# GitHub PR support: hub
# See https://hub.github.com/

Requirements on openSUSE

Most of requirements are available either directly in openSUSE or in devel:languages:python repository:

zypper install python-Django translate-toolkit \
    python-Whoosh python-Pillow \
    python-social-auth-core python-social-auth-app-django \
    python-babel Git mercurial python-pyuca \
    python-dateutil

# Optional for database backend
zypper install python-psycopg2      # For PostgreSQL
zypper install python-MySQL-python  # For MySQL

Depending on how you intend to run Weblate and what you already have installed, you might need additional components:

# Web server option 1: nginx and uwsgi
zypper install nginx uwsgi uwsgi-plugin-python

# Web server option 2: Apache with mod_wsgi
zypper install apache2 apache2-mod_wsgi

# Caching backend: memcached
zypper install memcached

# Database option 1: postgresql
zypper install postgresql

# Database option 2: mariadb
zypper install mariadb

# Database option 3: mysql
zypper install mysql

# SMTP server
zypper install postfix

# GitHub PR support: hub
# See https://hub.github.com/

Requirements on OSX

If your python was not installed using brew, make sure you have this in your :file:`.bash_profile` file or executed somehow:

export PYTHONPATH="/usr/local/lib/python2.7/site-packages:$PYTHONPATH"

This configuration makes the installed libraries available to Python.

Requirements using pip installer

Most requirements can be also installed using pip installer:

pip install -r requirements.txt

For building some of the extensions devel files for several libraries are required, see :ref:`virtualenv` for instructions how to install these.

All optional dependencies (see above) can be installed using:

pip install -r requirements-optional.txt

Filesystem permissions

Weblate process needs to be able to read and write to the directory where it keeps data - :setting:`DATA_DIR`.

The default configuration places them in same tree as Weblate sources, however you might prefer to move these to better location such as :file:`/var/lib/weblate`.

Weblate tries to create these directories automatically, but it will fail when it does not have permissions to do so.

You should also take care when running :ref:`manage`, as they should be run under same user as Weblate itself is running, otherwise permissions on some files might be wrong.

.. seealso::

   :ref:`static-files`

Database setup for Weblate

It is recommended to run Weblate on some database server. Using SQLite backend is really good for testing purposes only.

.. seealso::

   :ref:`production-database`,
   :doc:`django:ref/databases`

PostgreSQL

PostgreSQL is usually best choice for Django based sites. It's the reference database using for implementing Django database layer.

.. seealso::

    :ref:`django:postgresql-notes`

Creating database in PostgreSQL

It is usually good idea to run Weblate in separate database and separate user:

# If PostgreSQL was not installed before, set the master password
sudo -u postgres psql postgres -c "\password postgres"

# Create database user called "weblate"
sudo -u postgres createuser -D -P weblate

# Create database "weblate" owned by "weblate"
sudo -u postgres createdb -O weblate weblate

Configuring Weblate to use PostgreSQL

The :file:`settings.py` snippet for PostgreSQL:

DATABASES = {
    'default': {
        # Database engine
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        # Database name
        'NAME': 'weblate',
        # Database user
        'USER': 'weblate',
        # Database password
        'PASSWORD': 'password',
        # Set to empty string for localhost
        'HOST': 'database.example.com',
        # Set to empty string for default
        'PORT': '',
    }
}

MySQL or MariaDB

MySQL or MariaDB are quite good choice to run Weblate. However when using MySQL you might hit some problems caused by it.

.. seealso::

    :ref:`django:mysql-notes`

Unicode issues in MySQL

MySQL by default uses something called utf8, what can not store all Unicode characters, only those who fit into three bytes in utf-8 encoding. In case you're using emojis or some other higher Unicode symbols you might hit errors when saving such data. Depending on MySQL and Python bindings version, the error might look like:

  • OperationalError: (1366, "Incorrect string value: '\\xF0\\xA8\\xAB\\xA1' for column 'target' at row 1")
  • UnicodeEncodeError: 'ascii' codec can't encode characters in position 0-3: ordinal not in range(128)

To solve this, you need to change your database to use utf8mb4 (what is again subset of Unicode, but this time which can be stored in four bytes in utf-8 encoding, thus covering all chars currently defined in Unicode).

This can be achieved at database creation time by creating it with this character set (see :ref:`mysql-create`) and specifying the character set in connection settings (see :ref:`mysql-config`).

In case you have existing database, you can change it to utf8mb4 by, but this won't change collation of existing fields:

ALTER DATABASE weblate CHARACTER SET utf8mb4;
.. seealso::

    `Using Innodb_large_prefix to Avoid ERROR 1071 <http://mechanics.flite.com/blog/2014/07/29/using-innodb-large-prefix-to-avoid-error-1071/>`_

Transaction locking

MySQL by default uses has different transaction locking scheme than other databases and in case you see errors like Deadlock found when trying to get lock; try restarting transaction it might be good idea to enable STRICT_TRANS_TABLES mode in MySQL. This can be done in the server configuration file (usually :file:`/etc/mysql/my.cnf` on Linux):

[mysqld]
sql-mode=STRICT_TRANS_TABLES
.. seealso::

    :ref:`django:mysql-sql-mode`

Creating database in MySQL

Create weblate user to access the weblate database:

# Grant all privileges to  weblate user
GRANT ALL PRIVILEGES ON weblate.* TO 'weblate'@'localhost'  IDENTIFIED BY 'password';

# Create database on MySQL >= 5.7.7
CREATE DATABASE weblate CHARACTER SET utf8mb4;

# Use utf8 for older versions
# CREATE DATABASE weblate CHARACTER SET utf8;

Configuring Weblate to use MySQL

The :file:`settings.py` snippet for MySQL:

DATABASES = {
    'default': {
        # Database engine
        'ENGINE': 'django.db.backends.mysql',
        # Database name
        'NAME': 'weblate',
        # Database user
        'USER': 'weblate',
        # Database password
        'PASSWORD': 'password',
        # Set to empty string for localhost
        'HOST': 'database.example.com',
        # Set to empty string for default
        'PORT': '',
        # Additional database options
        'OPTIONS': {
            # In case of older MySQL server which has default MariaDB
            # 'init_command': 'SET storage_engine=INNODB',
            # If your server supports it, see Unicode issues above
           'charset': 'utf8mb4',
        }

    }
}

Other configurations

Configuring outgoing mail

Weblate sends out emails on various occasions - for account activation and on various notifications configured by users. For this it needs access to the SMTP server, which will handle this.

The mail server setup is configured using settings :setting:`django:EMAIL_HOST`, :setting:`django:EMAIL_HOST_PASSWORD`, :setting:`django:EMAIL_HOST_USER` and :setting:`django:EMAIL_PORT`. Their names are quite self-explaining, but you can find our more information in the Django documentation.

Installation

.. seealso::

   :ref:`sample-configuration`

Copy :file:`weblate/settings_example.py` to :file:`weblate/settings.py` and adjust it to match your setup. You will probably want to adjust following options:

.. setting:: ADMINS

ADMINS

List of site administrators to receive notifications when something goes wrong, for example notifications on failed merge or Django errors.

.. seealso::

    :setting:`django:ADMINS`


.. setting:: ALLOWED_HOSTS

ALLOWED_HOSTS

If you are running Django 1.5 or newer, you need to set this to list of hosts your site is supposed to serve. For example:

ALLOWED_HOSTS = ['demo.weblate.org']
.. seealso::

    :setting:`django:ALLOWED_HOSTS`


.. setting:: SESSION_ENGINE

SESSION_ENGINE

Configure how your sessions will be stored. In case you keep default database backed engine you should schedule :command:`./manage.py clearsessions` to remove stale session data from the database.

.. seealso::

    :ref:`django:configuring-sessions`,
    :setting:`django:SESSION_ENGINE`


.. setting:: DATABASES

DATABASES

Connectivity to database server, please check Django's documentation for more details.

.. seealso::

    :ref:`database-setup`,
    :setting:`django:DATABASES`,
    :doc:`django:ref/databases`


.. setting:: DEBUG

DEBUG

Disable this for production server. With debug mode enabled, Django will show backtraces in case of error to users, when you disable it, errors will go by email to ADMINS (see above).

Debug mode also slows down Weblate as Django stores much more information internally in this case.

.. seealso::

    :setting:`django:DEBUG`,


.. setting:: DEFAULT_FROM_EMAIL

DEFAULT_FROM_EMAIL

Email sender address for outgoing email, for example registration emails.

.. seealso::

    :std:setting:`django:DEFAULT_FROM_EMAIL`,


.. setting:: SECRET_KEY

SECRET_KEY

Key used by Django to sign some information in cookies, see :ref:`production-secret` for more information.
.. setting:: SERVER_EMAIL

SERVER_EMAIL

Email used as sender address for sending emails to administrator, for example notifications on failed merge.

.. seealso::

    :std:setting:`django:SERVER_EMAIL`

Filling up the database

After your configuration is ready, you can run :samp:`./manage.py migrate` to create database structure. Now you should be able to create translation projects using admin interface.

In case you want to run installation non interactively, you can use :samp:`./manage.py migrate --noinput` and then create admin user using :djadmin:`createadmin` command.

You should also login to admin interface (on /admin/ URL) and adjust default site name to match your domain by clicking on :guilabel:`Sites` and there changing the :samp:`example.com` record to match your real domain name.

Once you are done, you should also check :guilabel:`Performance report` in the admin interface which will give you hints for non optimal configuration on your site.

.. seealso::

   :ref:`config`, :ref:`privileges`, :ref:`faq-site`, :ref:`production-site`

Production setup

For production setup you should do following adjustments:

Disable debug mode

Disable Django's debug mode (:setting:`DEBUG`) by:

DEBUG = False

With debug mode Django stores all executed queries and shows users backtraces of errors what is not desired in production setup.

.. seealso::

   :ref:`installation`

Properly configure admins

Set correct admin addresses to :setting:`ADMINS` setting for defining who will receive mail in case something goes wrong on the server, for example:

ADMINS = (
    ('Your Name', '[email protected]'),
)
.. seealso::

   :ref:`installation`

Set correct site name

Adjust site name in admin interface, otherwise links in RSS or registration emails will not work.

Please open admin interface and edit default site name and domain under the :guilabel:`Sites › Sites` (or you can do that directly at /admin/sites/site/1/ URL under your Weblate installation). You have to change the :guilabel:`Domain name` to match your setup.

Note

This setting should contain only domain name. For configuring protocol (enabling HTTPS) use :setting:`ENABLE_HTTPS` and for changing URL use :setting:`URL_PREFIX`.

Alternatively you can set the site name from command line using :djadmin:`changesite`. For example for using built in server:

./manage.py changesite --set-name 127.0.0.1:8000

For production site, you want something like:

./manage.py changesite --set-name weblate.example.com
.. seealso::

   :ref:`faq-site`, :djadmin:`changesite`,
   :doc:`django:ref/contrib/sites`

Enable indexing offloading

Enable :setting:`OFFLOAD_INDEXING` to prevent locking issues and improve performance. Don't forget to schedule indexing in background job to keep the index up to date.

.. seealso::

   :ref:`fulltext`, :setting:`OFFLOAD_INDEXING`, :ref:`production-cron`

Use powerful database engine

Use powerful database engine (SQLite is usually not good enough for production environment), see :ref:`database-setup` for more information.

.. seealso::

    :ref:`database-setup`,
    :ref:`installation`,
    :doc:`django:ref/databases`

Enable caching

If possible, use memcache from Django by adjusting CACHES configuration variable, for example:

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
        'LOCATION': '127.0.0.1:11211',
    }
}
.. seealso::

    :ref:`production-cache-avatar`,
    :doc:`django:topics/cache`

Avatar caching

In addition to caching of Django, Weblate performs caching of avatars. It is recommended to use separate, file backed cache for this purpose:

CACHES = {
    'default': {
        # Default caching backend setup, see above
        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
        'LOCATION': '127.0.0.1:11211',
    },
    'avatar': {
        'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache',
        'LOCATION': os.path.join(BASE_DIR, 'avatar-cache'),
        'TIMEOUT': 604800,
        'OPTIONS': {
            'MAX_ENTRIES': 1000,
        },
    }
.. seealso::

    :setting:`ENABLE_AVATARS`,
    :ref:`avatars`,
    :ref:`production-cache`,
    :doc:`django:topics/cache`

Configure email addresses

Weblate needs to send out emails on several occasions and these emails should have correct sender address, please configure :setting:`SERVER_EMAIL` and :setting:`DEFAULT_FROM_EMAIL` to match your environment, for example:

SERVER_EMAIL = '[email protected]'
DEFAULT_FROM_EMAIL = '[email protected]'
.. seealso::

    :ref:`installation`,
    :std:setting:`django:DEFAULT_FROM_EMAIL`,
    :std:setting:`django:SERVER_EMAIL`

Allowed hosts setup

Django 1.5 and newer require :setting:`ALLOWED_HOSTS` to hold list of domain names your site is allowed to serve, having it empty will block any request.

.. seealso::

    :std:setting:`django:ALLOWED_HOSTS`

Federated avatar support

By default, Weblate relies on <https://www.libravatar.org/> for avatars. When you install pyLibavatar, you will get proper support for federated avatars.

pyuca library

pyuca library is optionally used by Weblate to sort Unicode strings. This way language names are properly sorted even in non-ASCII languages like Japanese, Chinese or Arabic or for languages with accented letters.

Django secret key

The :setting:`SECRET_KEY` setting is used by Django to sign cookies and you should really use own value rather than using the one coming from example setup.

You can generate new key using :file:`examples/generate-secret-key` shipped with Weblate.

.. seealso::

    :std:setting:`django:SECRET_KEY`

Static files

If you see purely designed admin interface, the CSS files required for it are not loaded. This is usually if you are running in non-debug mode and have not configured your web server to serve them. Recommended setup is described in the :ref:`static-files` chapter.

.. seealso::

   :ref:`server`, :ref:`static-files`

Home directory

.. versionchanged:: 2.1
   This is no longer required, Weblate now stores all its data in
   :setting:`DATA_DIR`.

The home directory for user which is running Weblate should be existing and writable by this user. This is especially needed if you want to use SSH to access private repositories, but Git might need to access this directory as well (depends on Git version you use).

You can change the directory used by Weblate in :file:`settings.py`, for example to set it to configuration directory under Weblate tree:

os.environ['HOME'] = os.path.join(BASE_DIR, 'configuration')

Note

On Linux and other UNIX like systems, the path to user's home directory is defined in :file:`/etc/passwd`. Many distributions default to non writable directory for users used for serving web content (such as apache, www-data or wwwrun, so you either have to run Weblate under different user or change this setting.

.. seealso::

   :ref:`vcs-repos`

Template loading

It is recommended to use cached template loader for Django. It caches parsed templates and avoids need to do the parsing with every single request. You can configure it using following snippet:

TEMPLATE_LOADERS = (
    ('django.template.loaders.cached.Loader', (
        'django.template.loaders.filesystem.Loader',
        'django.template.loaders.app_directories.Loader',
    )),
)
.. seealso::

    :py:class:`django:django.template.loaders.cached.Loader`

Running maintenance tasks

For optimal performance, it is good idea to run some maintenance tasks in the background.

On Unix system, this can be scheduled using cron:

# Fulltext index updates
*/5 * * * * cd /usr/share/weblate/; ./manage.py update_index

# Cleanup stale objects
@daily cd /usr/share/weblate/; ./manage.py cleanuptrans

# Commit pending changes after 96 hours
@hourly cd /usr/share/weblate/; ./manage.py commit_pending --all --age=96 --verbosity=0

.. seealso::

   :ref:`production-indexing`, :djadmin:`update_index`, :djadmin:`cleanuptrans`, :djadmin:`commit_pending`

Running server

Running Weblate is not different from running any other Django based application. Django is usually executed as uwsgi or fcgi (see examples for different webservers below).

For testing purposes, you can use Django builtin web server:

./manage.py runserver

Serving static files

.. versionchanged:: 2.4

    Prior to version 2.4 Weblate didn't properly use Django static files
    framework and the setup was more complex.

Django needs to collect its static files to a single directory. To do so, execute :samp:`./manage.py collectstatic --noinput`. This will copy the static files into directory specified by STATIC_ROOT setting (this default to static directory inside :setting:`DATA_DIR`).

It is recommended to serve static files directly by your web server, you should use that for following paths:

:file:`/static/`
Serves static files for Weblate and admin interface (from defined by STATIC_ROOT).
:file:`/media/`
Used for user media uploads (eg. screenshots).
:file:`/favicon.ico`
Should be rewritten to rewrite rule to serve :file:`/static/favicon.ico`
:file:`/robots.txt`
Should be rewritten to rewrite rule to serve :file:`/static/robots.txt`
.. seealso::

    :doc:`django:howto/deployment/index`,
    :doc:`django:howto/static-files/deployment`

Content security policy

Default Weblate configuration enables weblate.middleware.SecurityMiddleware middleware which sets security related HTTP headers like Content-Security-Policy or X-XSS-Protection. These are set to work with Weblate and it's configuration, but this might clash with your customization. If that is your case, it is recommended to disable this middleware and set these headers manually.

Sample configuration for Apache

Following configuration runs Weblate as WSGI, you need to have enabled mod_wsgi (available as :file:`examples/apache.conf`):

.. literalinclude:: ../../examples/apache.conf
    :language: apache

This configuration is for Apache 2.4 and later. For earlier versions of Apache, replace Require all granted with Allow from all.

.. seealso::

    :doc:`django:howto/deployment/wsgi/modwsgi`

Sample configuration for Apache and gunicorn

Following configuration runs Weblate in gunicorn and Apache 2.4 (available as :file:`examples/apache.gunicorn.conf`):

.. literalinclude:: ../../examples/apache.gunicorn.conf
    :language: apache


.. seealso::

    :doc:`django:howto/deployment/wsgi/gunicorn`

Sample configuration for nginx and uwsgi

Following configuration runs Weblate as uwsgi under nginx webserver.

Configuration for nginx (also available as :file:`examples/weblate.nginx.conf`):

.. literalinclude:: ../../examples/weblate.nginx.conf
    :language: nginx

Configuration for uwsgi (also available as :file:`examples/weblate.uwsgi.ini`):

.. literalinclude:: ../../examples/weblate.uwsgi.ini
    :language: ini


.. seealso::

    :doc:`django:howto/deployment/wsgi/uwsgi`

Running Weblate under path

.. versionchanged:: 1.3

    This is supported since Weblate 1.3.

Sample Apache configuration to serve Weblate under /weblate. Again using mod_wsgi (also available as :file:`examples/apache-path.conf`):

.. literalinclude:: ../../examples/apache-path.conf
    :language: apache

Additionally you will have to adjust :file:`weblate/settings.py`:

URL_PREFIX = '/weblate'

Monitoring Weblate

Weblate provides /healthz/ URL to be used in simple health checks, for example using Kubernetes.

Collecting error reports

It is good idea to collect errors from any Django application in structured way and Weblate is not an exception from this. You might find several services providing this, for example:

Rollbar

Weblate has built in support for Rollbar. To use it it's enough to follow instructions for Rollbar notifier for Python.

In short, you need to adjust :file:`settings.py`:

# Add rollbar as last middleware:
MIDDLEWARE_CLASSES = (
    # ... other middleware classes ...
    'rollbar.contrib.django.middleware.RollbarNotifierMiddleware',
)

# Configure client access
ROLLBAR = {
    'access_token': 'POST_SERVER_ITEM_ACCESS_TOKEN',
    'client_token': 'POST_CLIENT_ITEM_ACCESS_TOKEN',
    'environment': 'development' if DEBUG else 'production',
    'branch': 'master',
    'root': '/absolute/path/to/code/root',
}

Everything else is integrated automatically, you will now collect both server and client side errors.

Migrating Weblate to another server

Migrating Weblate to another server should be pretty easy, however it stores data in few locations which you should migrate carefully. The best approach is to stop migrated Weblate for the migration.

Migrating database

Depending on your database backend, you might have several options to migrate the database. The most straightforward one is to dump the database on one server and import it on the new one. Alternatively you can use replication in case your database supports it.

The best approach is to use database native tools as they are usually most effective (eg. :command:`mysqldump` or :command:`pg_dump`). If you want to migrate between different databases, the only option might be to use Django management to dump and import the database:

# Export current data
./manage.py dumpdata > /tmp/weblate.dump
# Import dump
./manage.py loaddata /tmp/weblate.dump

Migrating VCS repositories

The VCS repositories stored under :setting:`DATA_DIR` need to be migrated as well. You can simply copy them or use :command:`rsync` to do the migration more effectively.

Migrating fulltext index

For the fulltext index (stored in :setting:`DATA_DIR`) it is better not to migrate it, but rather to generate fresh one using :djadmin:`rebuild_index`.

Other notes

Don't forget to move other services which Weblate might have been using like memcached, cron jobs or custom authentication backends.