Quick setup guide

Note

This is just a quick guide for installing and starting to use Weblate for testing purposes. Please check Installation instructions for more real world setup instructions.

Installing from sources

  1. Install all required dependencies, see Software requirements.

  2. Grab Weblate sources (either using Git or download a tarball) and unpack them, see Installing Weblate.

  3. Copy weblate/settings_example.py to weblate/settings.py and adjust it to match your setup. You will at least need to configure the database connection (possibly adding user and creating the database). Check Configuration for Weblate specific configuration options.

  4. Create the database which will be used by Weblate, see Database setup for Weblate.

  5. Build Django tables, static files and initial data (see Filling up the database and Serving static files):

    ./manage.py migrate
    ./manage.py collectstatic
    ./scripts/generate-locales # If you are using Git checkout
    
  6. Configure webserver to serve Weblate, see Running server.

Installing using Docker

  1. Clone weblate-docker repo:

    git clone https://github.com/WeblateOrg/docker.git weblate-docker
    cd weblate-docker
    
  2. Start Weblate containers:

    docker-compose up
    

See also

See Running Weblate in the Docker for more detailed instructions and customization options.

Installing on OpenShift 2

  1. You can install Weblate on OpenShift PaaS directly from its Git repository using the OpenShift Client Tools:

    rhc -aweblate app create -t python-2.7 --from-code https://github.com/WeblateOrg/weblate.git --no-git
    
  2. After installation everything should be preconfigured and you can immediately start to add a translation project as described below.

See also

For more information, including on how to retrieve the generated admin password, see Running Weblate on OpenShift 2.

Adding translation

  1. Open admin interface (http://localhost/admin/) and create project you want to translate. See Project configuration for more details.

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

  2. Create component which is the real object for translating - it points to VCS repository and selects which files to translate. See Component configuration for more details.

    The important fields here being 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, OS X string properties, Java properties or Qt Linguist files, see Supported formats for more details.

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