1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/weblate_ynh.git synced 2024-10-01 13:35:04 +02:00
weblate_ynh/README.md

75 lines
3.1 KiB
Markdown
Raw Normal View History

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)
[![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=weblate)
2017-09-13 12:20:16 +02:00
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.*
2017-09-18 09:53:19 +02:00
2020-06-28 23:01:11 +02:00
## Overview
2017-09-27 16:35:53 +02:00
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.
2021-01-05 12:00:34 +01:00
**Shipped version:** 4.4
2017-09-28 16:42:10 +02:00
2020-06-28 23:01:11 +02:00
## Screenshots
2018-06-06 00:23:36 +02:00
2020-06-28 23:01:11 +02:00
![](https://weblate.org/static/img/BigScreenshot.png)
2018-06-06 00:23:36 +02:00
2020-06-28 23:01:11 +02:00
## Demo
* [YunoHost project uses Weblate for translations](https://translate.yunohost.org)
2020-07-23 22:23:09 +02:00
## GitHub
2017-09-28 16:42:10 +02:00
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/).
2017-10-18 23:11:10 +02:00
This user will only be used to open the pull-request, each translation keep his author.
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.
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.
2020-10-28 17:21:00 +01:00
You can edit the file `$final_path/local_settings.py` to enable or disable features.
2017-10-18 23:11:10 +02:00
# Miscellaneous
2017-09-18 09:53:19 +02:00
2017-09-18 16:52:11 +02:00
## LDAP connexion
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.
2018-09-17 22:29:37 +02:00
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/)
2018-09-17 22:29:37 +02:00
2020-06-28 23:01:11 +02:00
## Limitations
2018-09-17 22:29:37 +02:00
2020-06-28 23:01:11 +02:00
* Any known limitations.
2018-09-17 22:29:37 +02:00
2020-06-28 23:01:11 +02:00
## Additional information
* Other info you would like to add about this app.
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/
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
```