Installing on macOS

Exigences matérielles

Weblate should run on any contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

  • 2 GB of RAM

  • 2 CPU cores

  • 1 GB of storage space

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

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

The typical database storage usage is around 300 MB per 1 million hosted words. Storage space needed for cloned repositories varies, but Weblate tries to keep their size minimal by doing shallow clones.

Note

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

Installation

Exigences du système

Install the dependencies needed to build the Python modules (see Exigences logicielles):

brew install python pango cairo gobject-introspection libffi glib libyaml
pip3 install virtualenv

Make sure pip will be able to find the libffi version provided by homebrew — this will be needed during the installation build step.

export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"

Install wanted optional dependencies depending on features you intend to use (see Optional dependencies):

brew install tesseract

Optionally install software for running production server, see Exécuter un serveur, Database setup for Weblate, Background tasks using Celery. Depending on size of your installation you might want to run these components on dedicated servers.

The local installation instructions:

# Web server option 1: NGINX and uWSGI
brew install nginx uwsgi

# Web server option 2: Apache with ``mod_wsgi``
brew install httpd

# Caching backend: Redis
brew install redis

# Database server: PostgreSQL
brew install postgresql

Modules Python

Indication

We’re using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

  1. Create the virtualenv for Weblate:

    virtualenv --python=python3 ~/weblate-env
    
  2. Activate the virtualenv for Weblate:

    . ~/weblate-env/bin/activate
    
  3. Install Weblate including all dependencies:

    pip install Weblate
    
  4. Install database driver:

    pip install psycopg2-binary
    
  5. Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Optional dependencies):

    pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
    

Configurer Weblate

Note

Following steps assume virtualenv used by Weblate is active (what can be done by . ~/weblate-env/bin/activate). In case this is not true, you will have to specify full path to weblate command as ~/weblate-env/bin/weblate.

  1. Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py.

  2. Adjust the values in the new settings.py file to your liking. You will need to provide at least the database credentials and Django secret key, but you will want more changes for production setup, see Ajuster la configuration.

  3. Create the database and its structure for Weblate (the example settings use PostgreSQL, check Database setup for Weblate for production ready setup):

    weblate migrate
    
  4. Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:

    weblate createadmin
    
  5. Collect static files for web server (see Exécuter un serveur and Serving static files):

    weblate collectstatic
    
  6. Compress JavaScript and CSS files (optional, see Compressing client assets):

    weblate compress
    
  7. Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Background tasks using Celery for more info:

    ~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
    
  8. Start the development server (see Exécuter un serveur for production setup):

    weblate runserver
    

Après installation

Congratulations, your Weblate server is now running and you can start using it.

  • You can now access Weblate on http://localhost:8000/.

  • Login with admin credentials obtained during installation or register with new users.

  • You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Commandes de gestion.

  • You can stop the test server with Ctrl+C.

  • Review potential issues with your installation either on /manage/performance/ URL or using weblate check --deploy, see Configuration de production.

Ajouter une traduction

  1. Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Configuration du projet for more details.

    All you need to specify here is the project name and its website.

  2. Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Configuration des composants for more details.

    The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Formats de fichiers pris en charge for more details.

  3. Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.