weblate_ynh/README.md

# Weblate for YunoHost

[![Integration level](https://dash.yunohost.org/integration/weblate.svg)](https://dash.yunohost.org/appci/app/weblate) ![](https://ci-apps.yunohost.org/ci/badges/weblate.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/weblate.maintain.svg)  
[![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=weblate)

> *This package allows you to install Weblate quickly and simply on a YunoHost server.  
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

Weblate is a libre web-based translation tool with tight version control integration. It provides two user interfaces, propagation of translations across components, quality checks and automatic linking to source files.

**Shipped version:** 3.8.0

## Screenshots

![](https://weblate.org/static/img/BigScreenshot.png)

## Demo

* [YunoHost project uses Weblate for translations](https://translate.yunohost.org)

## Admin account

An admin user is created at installation, the login is what you provided at installation, the password is **weblate**.

## 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.

**Careful**, You will have to **manually** move your hub binary file from `/var/www/$app/bin/` to `/usr/bin` to enable pull request on GitHub.

**SSH keys**, you will have to go in administration, and generate a public key for Weblate and add github.com so Weblate knows the fingerprint. Please note if your account already have a public key (ssh-rsa), you will have to manually add the Weblate's one to your GitHub account.

## Settings and upgrades

Almost everything related to Weblate's configuration is handled in a `settings.py` file.
You will 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*).

## LDAP connexion

It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/latest/admin/auth.html?highlight=LDAP#ldap-authentication), I'm unsure it is a good idea to connect this kind of tools to your LDAP.

#### Supported architectures

* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/weblate/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/weblate/)

## Limitations

* Any known limitations.

## Additional information

* Other info you would like to add about this app.

## Links

 * Report a bug about this package: https://github.com/YunoHost-Apps/weblate_ynh
 * Report a bug about Weblate itself: https://github.com/WeblateOrg/weblate
 * Documentation: https://docs.weblate.org/
 * Weblate website: https://weblate.org/
 * YunoHost website: https://yunohost.org/

---

Developer info
----------------

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/weblate_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug
or
sudo yunohost app upgrade weblate -u https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug
```
Update README.md 2020-06-28 23:01:11 +02:00			`# Weblate for YunoHost`

			`[![Integration level](https://dash.yunohost.org/integration/weblate.svg)](https://dash.yunohost.org/appci/app/weblate) ![](https://ci-apps.yunohost.org/ci/badges/weblate.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/weblate.maintain.svg)`
Add integration results and install with yunohost 2017-10-24 21:42:49 +02:00			`[![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=weblate)`
Create README.md 2017-09-13 12:20:16 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`> *This package allows you to install Weblate quickly and simply on a YunoHost server.`
			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`
add innodb_large_prefix 2017-09-18 09:53:19 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`## Overview`
Fix restoration 2017-09-27 16:35:53 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`Weblate is a libre web-based translation tool with tight version control integration. It provides two user interfaces, propagation of translations across components, quality checks and automatic linking to source files.`

			`Shipped version: 3.8.0`
Remove SMTP and use sendmail 2017-09-28 16:42:10 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`## Screenshots`
Upgrade to 3.0 2018-06-06 00:23:36 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`![](https://weblate.org/static/img/BigScreenshot.png)`
Upgrade to 3.0 2018-06-06 00:23:36 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`## Demo`

			`* [YunoHost project uses Weblate for translations](https://translate.yunohost.org)`

			`## Admin account`
Upgrade to 3.0 2018-06-06 00:23:36 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`An admin user is created at installation, the login is what you provided at installation, the password is weblate.`
Upgrade to 3.0 2018-06-06 00:23:36 +02:00
Update README.md 2020-07-23 22:23:09 +02:00			`## GitHub`
Remove SMTP and use sendmail 2017-09-28 16:42:10 +02:00
Update README.md 2020-07-23 22:23:09 +02:00			`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/).`
Improve readme for upgrades 2017-10-18 23:11:10 +02:00			`This user will only be used to open the pull-request, each translation keep his author.`

Update README.md 2020-07-23 22:23:09 +02:00			Careful, You will have to manually move your hub binary file from `/var/www/$app/bin/` to `/usr/bin` to enable pull request on GitHub.
Add manual step for hub, and ssh key warning 2017-11-07 09:23:59 +01:00
Update README.md 2020-07-23 22:23:09 +02:00			`SSH keys, you will have to go in administration, and generate a public key for Weblate and add github.com so Weblate knows the fingerprint. Please note if your account already have a public key (ssh-rsa), you will have to manually add the Weblate's one to your GitHub account.`
Add manual step for hub, and ssh key warning 2017-11-07 09:23:59 +01:00
Improve readme for upgrades 2017-10-18 23:11:10 +02:00			`## Settings and upgrades`

			Almost everything related to Weblate's configuration is handled in a `settings.py` file.
Update README.md 2020-06-28 23:01:11 +02:00			You will probably edit it to enable or disable diverse features, it is stored in `$final_path/venv/lib/python2.7/site-packages/weblate/settings.py`.
Improve readme for upgrades 2017-10-18 23:11:10 +02:00
			`Unfortunatly, this settings file also gets upgrades for each release.`

Update README.md 2020-07-23 22:23:09 +02:00			`This package will:`
Improve readme for upgrades 2017-10-18 23:11:10 +02:00
			`* 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`
add innodb_large_prefix 2017-09-18 09:53:19 +02:00
add changesite name and change_url 2017-09-21 10:22:34 +02:00			`## Weblate and databases`
add innodb_large_prefix 2017-09-18 09:53:19 +02:00
add changesite name and change_url 2017-09-21 10:22:34 +02:00			`Weblate [recommands PostgreSQL](https://docs.weblate.org/en/latest/admin/install.html#database-setup-for-weblate), but YunoHost uses Mysql.`
add innodb_large_prefix 2017-09-18 09:53:19 +02:00
Improve readme for upgrades 2017-10-18 23:11:10 +02:00			`Carefull, this application install PostgreSQL and change the default configuration to ask for every connexion and every user a password (local all all password).`
typo in nginx 2017-09-18 16:52:11 +02:00
			`## LDAP connexion`

Add hub's support for github PR 2017-10-04 10:46:26 +02:00			`It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/latest/admin/auth.html?highlight=LDAP#ldap-authentication), I'm unsure it is a good idea to connect this kind of tools to your LDAP.`
Improve Readme 2018-09-17 22:29:37 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`#### Supported architectures`

			`* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/weblate/)`
			`* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/weblate/)`
Improve Readme 2018-09-17 22:29:37 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`## Limitations`
Improve Readme 2018-09-17 22:29:37 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`* Any known limitations.`
Improve Readme 2018-09-17 22:29:37 +02:00
Update README.md 2020-06-28 23:01:11 +02:00			`## Additional information`

			`* Other info you would like to add about this app.`
Improve Readme 2018-09-17 22:29:37 +02:00
			`## Links`

			`* Report a bug about this package: https://github.com/YunoHost-Apps/weblate_ynh`
			`* Report a bug about Weblate itself: https://github.com/WeblateOrg/weblate`
			`* Documentation: https://docs.weblate.org/`
			`* Weblate website: https://weblate.org/`
			`* YunoHost website: https://yunohost.org/`
Update README.md 2020-06-28 23:01:11 +02:00
			`---`

			`Developer info`
			`----------------`

			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/weblate_ynh/tree/testing).`

			`To try the testing branch, please proceed like that.`
			```
			`sudo yunohost app install https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade weblate -u https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug`
			```