Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.81 KB

quick.rst

File metadata and controls

78 lines (51 loc) · 2.81 KB
Raw

Quick setup guide

Note

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

Installing from sources

  1. Install all required dependencies, see :ref:`requirements`.

  2. Grab Weblate sources (either using Git or download a tarball) and unpack them, see :ref:`install-weblate`.

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

  4. Create database which will be used by Weblate, see :ref:`database-setup`.

  5. Build Django tables, static files and initial data (see :ref:`tables-setup` and :ref:`static-files`):

    ./manage.py migrate
./manage.py collectstatic
./scripts/generate-locales # If you are using Git checkout

  6. Configure webserver to serve Weblate, see :ref:`server`.

Using prebuilt appliance

  1. Download the appliance and start it. You need to choose format depending on your target environment.
  2. Everything should be set up immediately after boot, though you will want to adjust some settings to improve security, see :ref:`appliance`.

Installing on OpenShift

  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/nijel/weblate.git --no-git

  2. After installation everything should be preconfigured and you can immediately start to add a translation project as described below. For more information, including on how to retrieve the generated admin password, see :ref:`openshift`.

Adding translation

  1. Open admin interface (http://localhost/admin/) and create project you want to translate. See :ref:`project` 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 :ref:`component` for more details.

    The important fields here being component name, VCS repository address and mask for finding translatable files. Weblate supports wide range of formats including Gettext PO files, Android resource strings, OS X string properties, Java properties or Qt Linguist files, see :ref:`formats` for more details.

  3. Once 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.