Weblate deployments¶
Weblate comes with support for deployment using several technologies. This section brings overview of them.
Weblate and Docker¶
With dockerized weblate deployment you can get your personal weblate instance up an running in seconds. All of Weblate’s dependencies are already included. PostgreSQL is configured as default database.
Deployment¶
Following examples assume you have working Docker environment, with docker-compose installed. Please check Docker documentation for instructions on this.
- Clone weblate-docker repo:
git clone https://github.com/WeblateOrg/docker.git weblate-docker
cd weblate-docker
- Create a
docker-compose.override.yml
file with your settings. See Docker environment variables full list of environment vars
version: '2'
services:
weblate:
environment:
- WEBLATE_EMAIL_HOST=smtp.example.com
- WEBLATE_EMAIL_HOST_USER=user
- WEBLATE_EMAIL_HOST_PASSWORD=pass
- WEBLATE_ALLOWED_HOSTS=your hosts
- WEBLATE_ADMIN_PASSWORD=password for admin user
Nota
If WEBLATE_ADMIN_PASSWORD
is not set, admin user is created with
random password printed out on first startup.
- Build Weblate containers:
docker-compose build
- Start Weblate containers:
docker-compose up
Enjoy your Weblate deployment, it’s accessible on port 80 of the web container.
Ver también
Maintenance tasks¶
There are some cron jobs to run. You should set WEBLATE_OFFLOAD_INDEXING
to 1
when these are setup
*/5 * * * * cd /usr/share/weblate/; docker-compose run --rm weblate update_index
@daily cd /usr/share/weblate/; docker-compose run --rm weblate cleanuptrans
@hourly cd /usr/share/weblate-docker/; docker-compose run --rm weblate commit_pending --all --age=96
Docker environment variables¶
Many of Weblate Configuration can be set in Docker container using environment variables:
Generic settings¶
-
WEBLATE_DEBUG
¶ Configures Django debug mode, see Disable debug mode.
Example:
environment: - WEBLATE_DEBUG=1
-
WEBLATE_LOGLEVEL
¶ Configures verbosity of logging.
-
WEBLATE_SITE_TITLE
¶ Configures site title, see Set correct site name.
-
WEBLATE_ADMIN_NAME
¶
-
WEBLATE_ADMIN_EMAIL
¶ Configures site admins name and email, see Properly configure admins.
Example:
environment: - WEBLATE_ADMIN_NAME=Weblate Admin - WEBLATE_ADMIN_EMAIL=noreply@example.com
-
WEBLATE_ADMIN_PASSWORD
¶ Sets password for admin user. If not set, admin user is created with random password printed out on first startup.
Distinto en la versión 2.9: Since version 2.9, the admin user is adjusted on every container startup to match
WEBLATE_ADMIN_PASSWORD
,WEBLATE_ADMIN_NAME
andWEBLATE_ADMIN_EMAIL
.
-
WEBLATE_SERVER_EMAIL
¶
-
WEBLATE_DEFAULT_FROM_EMAIL
¶ Configures address for outgoing mails, see Configure email addresses.
-
WEBLATE_ALLOWED_HOSTS
¶ Configures allowed HTTP hostnames, see Allowed hosts setup
Example:
environment: - WEBLATE_ALLOWED_HOSTS=weblate.example.com,example.com
-
WEBLATE_SECRET_KEY
¶ Configures secret for cookies signing, see Django secret key.
Obsoleto desde la versión 2.9: The secret is now generated automatically on first startup, there is no need to set it manually.
-
WEBLATE_REGISTRATION_OPEN
¶ Configures whether registrations are open, see
REGISTRATION_OPEN
.Example:
environment: - WEBLATE_REGISTRATION_OPEN=0
-
WEBLATE_TIME_ZONE
¶ Configures used time zone.
-
WEBLATE_OFFLOAD_INDEXING
¶ Configures offloaded indexing, see Enable indexing offloading.
Example:
environment: - WEBLATE_OFFLOAD_INDEXING=1
-
WEBLATE_ENABLE_HTTPS
¶ Configures when use https in email and API links, see Set correct site name.
Example:
environment: - WEBLATE_ENABLE_HTTPS=1
-
WEBLATE_REQUIRE_LOGIN
¶ Configures login required for whole Weblate using
LOGIN_REQUIRED_URLS
.Example:
environment: - WEBLATE_REQUIRE_LOGIN=1
-
WEBLATE_GOOGLE_ANALYTICS_ID
¶ Configures ID for Google Analytics, see
GOOGLE_ANALYTICS_ID
.
Machine translation settings¶
-
WEBLATE_MT_GOOGLE_KEY
¶ Enables Google machine translation and sets
MT_GOOGLE_KEY
Authentication settings¶
-
WEBLATE_SOCIAL_AUTH_GITHUB_KEY
¶
-
WEBLATE_SOCIAL_AUTH_GITHUB_SECRET
¶ Enables Google OAuth2.
-
WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY
¶
-
WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET
¶ Enables Bitbucket authentication.
-
WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY
¶
-
WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET
¶ Enables Facebook OAuth2.
-
WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_KEY
¶
-
WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET
¶ Enables Google OAuth2.
PostgreSQL databse setup¶
The database is created by docker-compose.yml
, so this settings affects
both Weblate and PostgreSQL containers.
Ver también
-
POSTGRES_PASSWORD
¶ PostgreSQL password.
-
POSTGRES_USER
¶ PostgreSQL username.
-
POSTGRES_DATABASE
¶ PostgreSQL databse name.
Email server setup¶
To make outgoing email work, you need to provide mail server.
Ver también
-
WEBLATE_EMAIL_HOST
¶ Mail server, the server has to listen on port 587 and understand TLS.
-
WEBLATE_EMAIL_USER
¶ Email authentication user, do NOT use quotes here.
-
WEBLATE_EMAIL_PASSWORD
¶ Email authentication password, do NOT use quotes here.
Select your machine - local or cloud providers¶
With docker-machine you can create your Weblate deployment either on your local machine or on any large number of cloud-based deployments on e.g. Amazon AWS, Digitalocean and many more providers.
Weblate on OpenShift¶
This repository contains a configuration for the OpenShift platform as a service product, which facilitates easy installation of Weblate on OpenShift Online (https://www.openshift.com/), OpenShift Enterprise (https://enterprise.openshift.com/) and OpenShift Origin (https://www.openshift.org/).
Prerequisites¶
OpenShift Account
You need an account for OpenShift Online (https://www.openshift.com/) or another OpenShift installation you have access to.
You can register a free account on OpenShift Online, which allows you to host up to 3 applications free of charge.
OpenShift Client Tools
In order to follow the examples given in this documentation you need to have the OpenShift Client Tools (RHC) installed: https://developers.openshift.com/en/managing-client-tools.html
While there are other possibilities to create and configure OpenShift applications, this documentation is based on the OpenShift Client Tools (RHC) because they provide a consistent interface for all described operations.
Installation¶
You can install Weblate on OpenShift directly from Weblate’s github repository with the following command:
rhc -aweblate app create -t python-2.7 --from-code https://github.com/WeblateOrg/weblate.git --no-git
The -a
option defines the name of your weblate installation, weblate
in
this instance. You are free to specify a different name.
Optionally you can specify tag identifier right of the #
sign to identify
the version of Weblate to install (for example specify
https://github.com/WeblateOrg/weblate.git#weblate-2.0
to install Weblate 2.0).
For a list of available versions see here:
https://github.com/WeblateOrg/weblate/tags. Please note that only version 2.0 and
newer can be installed on OpenShift, as older versions don’t include the
necessary configuration files. The --no-git
option skips the creation of a
local git repository.
You can also specify which database you want to use:
# For MySQL
rhc -aweblate app create -t python-2.7 -t mysql-5.5 --from-code https://github.com/WeblateOrg/weblate.git --no-git
# For PostgreSQL
rhc -aweblate app create -t python-2.7 -t postgresql-9.2 --from-code https://github.com/WeblateOrg/weblate.git --no-git
Default Configuration¶
After installation on OpenShift Weblate is ready to use and preconfigured as follows:
- SQLite embedded database (DATABASES)
- Random admin password
- Random Django secret key (SECRET_KEY)
- Indexing offloading if the cron cartridge is installed (
OFFLOAD_INDEXING
) - Committing of pending changes if the cron cartridge is installed (
commit_pending
) - Weblate machine translations for suggestions bases on previous translations (
MACHINE_TRANSLATION_SERVICES
) - Weblate directories (STATIC_ROOT,
DATA_DIR
,TTF_PATH
, Avatar cache) set according to OpenShift requirements/conventions - Django site name and ALLOWED_HOSTS set to DNS name of your OpenShift application
- Email sender addresses set to no-reply@<OPENSHIFT_CLOUD_DOMAIN>, where <OPENSHIFT_CLOUD_DOMAIN> is the domain OpenShift runs under. In case of OpenShift Online it’s rhcloud.com.
Ver también
Retrieve Admin Password¶
You can retrieve the generated admin password with the following command:
rhc -aweblate ssh credentials
Indexing Offloading¶
To enable the preconfigured indexing offloading you need to add the cron cartridge to your application and restart it:
rhc -aweblate add-cartridge cron
rhc -aweblate app stop
rhc -aweblate app start
The fulltext search index will then be updated every 5 minutes.
Restarting with rhc restart
instead will not enable indexing offloading in Weblate.
You can verify that indexing offloading is indeed enabled by visiting the URL /admin/performance/
of your application.
Pending Changes¶
Weblate’s OpenShift configuration contains a cron job which periodically commits pending changes older than a certain age (24h by default). To enable the cron job you need to add the cron cartridge and restart Weblate as described in the previous section. You can change the age parameter by setting the environment variable WEBLATE_PENDING_AGE to the desired number of hours, e.g.:
rhc -aweblate env set WEBLATE_PENDING_AGE=48
Customize Weblate Configuration¶
You can customize the configuration of your Weblate installation on OpenShift
through environment variables. Override any of Weblate’s setting documented
under Configuration using rhc env set
by prepending the settings name with
WEBLATE_
. The variable content is put verbatim to the configuration file,
so it is parsed as Python string, after replacing environment variables in it
(eg. $PATH
). To put literal $
you need to escape it as $$
.
For example override the ADMINS
setting like this:
rhc -aweblate env set WEBLATE_ADMINS='(("John Doe", "jdoe@example.org"),)'
To change site title, do not forget to include additional quotes:
rhc -aweblate env set WEBLATE_SITE_TITLE='"Custom Title"'
New settings will only take effect after restarting Weblate:
rhc -aweblate app stop
rhc -aweblate app start
Restarting using rhc -aweblate app restart
does not work. For security reasons only constant expressions are allowed as values.
With the exception of environment variables which can be referenced using ${ENV_VAR}
. For example:
rhc -aweblate env set WEBLATE_PRE_COMMIT_SCRIPTS='("${OPENSHIFT_DATA_DIR}/examples/hook-generate-mo",)'
You can check the effective settings Weblate is using by running:
rhc -aweblate ssh settings
This will also print syntax errors in your expressions. To reset a setting to its preconfigured value just delete the corresponding environment variable:
rhc -aweblate env unset WEBLATE_ADMINS
Ver también
Updating¶
It is recommended that you try updates on a clone of your Weblate installation before running the actual update. To create such a clone run:
rhc -aweblate2 app create --from-app weblate
Visit the newly given URL with a browser and wait for the install/update page to disappear.
You can update your Weblate installation on OpenShift directly from Weblate’s github repository by executing:
rhc -aweblate2 ssh update https://github.com/WeblateOrg/weblate.git
The identifier right of the #
sign identifies the version of Weblate to install.
For a list of available versions see here: https://github.com/WeblateOrg/weblate/tags.
Please note that the update process will not work if you modified the git repository of you weblate installation.
You can force an update by specifying the --force
option to the update script. However any changes you made to the
git repository of your installation will be discarded:
rhc -aweblate2 ssh update --force https://github.com/WeblateOrg/weblate.git
The --force
option is also needed when downgrading to an older version.
Please note that only version 2.0 and newer can be installed on OpenShift,
as older versions don’t include the necessary configuration files.
The update script takes care of the following update steps as described under Generic upgrade instructions.
- Install any new requirements
- manage.py migrate
- manage.py setupgroups –move
- manage.py setuplang
- manage.py rebuild_index –all
- manage.py collectstatic –noinput
Bitnami Weblate stack¶
Bitnami provides Weblate stack for many platforms at <https://bitnami.com/stack/weblate>. The setup will be adjusted during installation, see <https://bitnami.com/stack/weblate/README.txt> for more documentation.
SUSE Studio appliance¶
Weblate appliance provides preconfigured Weblate running with MySQL database as backend and Apache as web server. It is provided in many formats suitable for any form of virtualization, cloud or hardware installation.
It comes with standard set of passwords you will want to change:
Username | Password | Scope | Description |
---|---|---|---|
root | linux | System | Administrator account, use for local or SSH login |
root | MySQL | MySQL administrator | |
weblate | weblate | MySQL | Account in MySQL database for storing Weblate data |
admin | admin | Weblate | Weblate/Django admin user |
The appliance is built using SUSE Studio and is based on openSUSE 12.3.
You should also adjust some settings to match your environment, namely: