From 3736c4deca7daa9bad7f59601d6c1f7e0ba45dcd Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Holcroft Date: Wed, 18 Oct 2017 23:11:10 +0200 Subject: [PATCH] Improve readme for upgrades --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5539aa6..3251844 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,37 @@ The YunoHost team uses [Weblate](https://weblate.org) for translations: https://translate.yunohost.org -## Admin +## Admin account -An admin user is created at installation, the login is what you provided at installation, the password is *weblate*. +An admin user is created at installation, the login is what you provided at installation, the password is **weblate**. -# Github +## Github You'll need to give weblate a github user and a token. Please read [github's documentation about token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). +This user will only be used to open the pull-request, each translation keep his author. + +## Settings and upgrades + +Almost everything related to Weblate's configuration is handled in a `settings.py` file. +You'll probably edit it to enable or disable diverse features, it is stored in `$final_path/venv/lib/python2.7/site-packages/weblate/settings.py`. + +Unfortunatly, this settings file also gets upgrades for each release. + +This package will : + +* generate a default settings file for your current installation, +* send you a diff with your actual settings (the content will be sent to *root*, and only basic information for weblate's admin), +* generate a default settings file the new weblate's version, that will **replace** your actual `settings.py`. + +You'll have to **manually** add your previous changes to this new `settings.py`. + +# Miscellaneous ## Weblate and databases Weblate [recommands PostgreSQL](https://docs.weblate.org/en/latest/admin/install.html#database-setup-for-weblate), but YunoHost uses Mysql. -Carefull, this application install PostgreSQL and change the default configuration to ask for every connexion and every user a password (local all all password). +Carefull, this application install PostgreSQL and change the default configuration to ask for every connexion and every user a password (*local all all password*). ## LDAP connexion