Quick setup guide¶
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.
Choosing installation method¶
Choose best installation method depending on your environment and customization you need:
- Choose Docker if you are familiar with that and if you are not going to change Weblate code, see Installing using Docker.
- If you are not going to change Weblate code, but want to avoid Docker install in virtual env, see Installing in a virtualenv.
- If you want to develop and/or change Weblate code, grab Weblate from Git, see Installing from sources.
Installing in a virtualenv¶
If you’d just like to do a quick installation locally on your device to find out if Weblate is for you, you can install it using a virtual environment for Python 2, a simple (and slow!) SQLite database, and the lightweight Django development server.
Install development files for libraries needed for building some Python modules:
# Debian/Ubuntu: apt install libxml2-dev libxslt-dev libfreetype6-dev libjpeg-dev libz-dev libyaml-dev python3-dev build-essential # openSUSE/SLES: zypper install libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel python3-devel # Fedora/RHEL/CentOS: dnf install libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel python3-devel
Install pip and virtualenv. Usually they are shipped by your distribution or with Python:
# Debian/Ubuntu: apt install python3-pip python3-virtualenv virtualenv # openSUSE/SLES: zypper install python3-pip python3-virtualenv # Fedora/RHEL/CentOS: dnf install python3-pip python3-virtualenv
Create the virtualenv for Weblate:
virtualenv --python=python3 ~/weblate-env
Activate the virtualenv for Weblate, so Weblate will look for Python libraries there first:
Install Weblate including all dependencies. You can also use pip to install the optional dependencies:
pip install Weblate # Optional deps pip install pytz python-bidi PyYAML pyuca # Install database backend for PostgreSQL pip install psycopg2-binary # Install database backend for MySQL apt install default-libmysqlclient-dev pip install mysqlclient
Copy the file
Optionally, adjust the values in the new
Create the SQLite database and its structure for Weblate:
Create the administrator user account and copy the password it outputs to the clipboard, and maybe also save it to a text file for later use:
Start the development server:
Open a web browser, go to http://localhost:8000/accounts/login/ and login with the user name admin and paste the password in.
Proceed with Adding translation to add some translatable contents to your test installation.
You can stop the test server with Ctrl+C, and leave the virtual environment with
If you want to resume testing later, you need to repeat the steps 4, 8 and 11 each time to start the development server.
Installing from sources¶
Grab Weblate sources (either using Git or download a tarball) and unpack them, see Installing Weblate.
Install all required dependencies into an virtual env (also see Software requirements):
virtualenv --python=python3 .venv . .venv/bin/activate pip install -r /path/to/weblate/requirements.txt
weblate/settings.pyand 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.
Create the database which will be used by Weblate, see Database setup for Weblate.
./manage.py migrate ./manage.py collectstatic ./scripts/generate-locales # If you are using Git checkout
Configure webserver to serve Weblate, see Running server.
Installing using Docker¶
Clone weblate-docker repo:
git clone https://github.com/WeblateOrg/docker-compose.git weblate-docker cd weblate-docker
Start Weblate containers:
See Running Weblate with Docker for more detailed instructions and customization options.
Installing on OpenShift 2¶
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
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 Running Weblate on OpenShift 2.
All you need to specify here is project name and its website.
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, iOS string properties, Java properties or Qt Linguist files, see Supported file formats for more details.
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.