mirror of
https://github.com/YunoHost-Apps/weblate_ynh.git
synced 2024-10-01 13:35:04 +02:00
70 lines
3.1 KiB
Markdown
70 lines
3.1 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Weblate for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/weblate)  
|
|
|
|
[](https://install-app.yunohost.org/?app=weblate)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *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:** 4.18.2~ynh1
|
|
|
|
**Demo:** https://hosted.weblate.org/
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
## 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.
|
|
|
|
**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 can edit the file `$final_path/local_settings.py` to enable or disable features.
|
|
|
|
# Miscellaneous
|
|
|
|
## 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.
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://weblate.org>
|
|
* Official user documentation: <https://docs.weblate.org/>
|
|
* Official admin documentation: <https://docs.weblate.org/>
|
|
* Upstream app code repository: <https://github.com/WeblateOrg/weblate>
|
|
* YunoHost Store: <https://apps.yunohost.org/app/weblate>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/weblate_ynh/issues>
|
|
|
|
## 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.
|
|
|
|
``` bash
|
|
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
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|