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

Merge pull request #33 from ericgaspar/Readme

Browse source 
Update README.md
This commit is contained in:
Éric Gaspar 2020-10-12 17:47:03 +02:00 committed by GitHub
commit 8c3d013292
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 68 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

83
README.md
View file

@ -1,40 +1,46 @@
[![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=weblate) # Weblate for YunoHost
![](https://dash.yunohost.org/integration/weblate.svg)
# Weblate translation platform for YunoHost
The YunoHost team uses [Weblate](https://weblate.org) for translations: https://translate.yunohost.org [![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 ## 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**.
## Weblate 3.0 upgrade ## GitHub
This upgrade is a major one, remember to read this page before upgrading: https://docs.weblate.org/en/latest/admin/upgrade.html#upgrade-3 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/).
After upgrading:
* All existing users and groups have been migrated to new model.
* Any per user permissions are removed, please assign users to appropriate groups and roles to grant them permissions.
* Any custom groups will not have any permissions after upgrade, please grant the permissions again.
## 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. This user will only be used to open the pull-request, each translation keep his author.
**Careful**, I still have to understand why, but you'll have to **manually** move your hub binary frile from /var/www/$app/bin/ to /usr/bin to enable pull request on github. I'm close to fix this. **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'll 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'll have to manually add the weblate's one to your github account. **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 ## Settings and upgrades
Almost everything related to Weblate's configuration is handled in a `settings.py` file. 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`. 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. Unfortunatly, this settings file also gets upgrades for each release.
This package will : This package will:
* generate a default settings file for your current installation, * 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), * send you a diff with your actual settings (the content will be sent to *root*, and only basic information for weblate's admin),
@ -54,23 +60,18 @@ Carefull, this application install PostgreSQL and change the default configurati
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. 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.
## State of this package #### Supported architectures
* works fine: * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/weblate/)
[x] install/remove/backup/remove/upgrade with x86_64 * 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/)
* to be confirmed: ## Limitations
[ ] ARM support
* to be added: * Any known limitations.
[ ] use jq instead of grep/sed
[ ] change URL script ## Additional information
[ ] use debian package for lxml (may unlock ARM support)
[ ] Add configuration options using the YunoHost interface (https://forum.yunohost.org/t/yunohost-3-1-minor-stable-release-version-stable-mineure/5445) * Other info you would like to add about this app.
[ ] Add fail2ban script
[ ] Enable CHECK_LIST?
[ ] Enable AUTOFIX_LIST?
[ ] Enable Translation Memory?
## Links ## Links
@ -79,3 +80,17 @@ It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/lat
* Documentation: https://docs.weblate.org/ * Documentation: https://docs.weblate.org/
* Weblate website: https://weblate.org/ * Weblate website: https://weblate.org/
* YunoHost website: https://yunohost.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
```

30
manifest.json
View file

@ -2,11 +2,9 @@
"name": "Weblate", "name": "Weblate",
"id": "weblate", "id": "weblate",
"packaging_format": 1, "packaging_format": 1,
"requirements": {
"yunohost": ">= 3.5.0"
},
"description": { "description": {
"en": "A translation platform using Git and Python" "en": "A translation platform using Git and Python",
"fr": "Une plateforme de traduction utilisant Git et Python"
}, },
"version": "3.8.0~ynh3", "version": "3.8.0~ynh3",
"url": "https://weblate.org", "url": "https://weblate.org",
@ -14,6 +12,9 @@
"maintainer": { "maintainer": {
"name": "Jean-Baptiste Holcroft", "name": "Jean-Baptiste Holcroft",
"email": "jean-baptiste@holcroft.fr" "email": "jean-baptiste@holcroft.fr"
},
"requirements": {
"yunohost": ">= 3.5.0"
}, },
"multi_instance": true, "multi_instance": true,
"services": [ "services": [
@ -25,7 +26,8 @@
"name": "domain", "name": "domain",
"type": "domain", "type": "domain",
"ask": { "ask": {
"en": "Choose a domain for Weblate:" "en": "Choose a domain for Weblate",
"fr": "Choisissez un domaine pour Weblate"
}, },
"example": "domain.org" "example": "domain.org"
}, },
@ -33,7 +35,8 @@
"name": "path", "name": "path",
"type": "path", "type": "path",
"ask": { "ask": {
"en": "Choose a path for Weblate:" "en": "Choose a path for Weblate",
"fr": "Choisissez un chemin pour Weblate"
}, },
"example": "/weblate", "example": "/weblate",
"default": "/weblate" "default": "/weblate"
@ -42,10 +45,12 @@
"name": "is_public", "name": "is_public",
"type": "boolean", "type": "boolean",
"ask": { "ask": {
"en": "Should Weblate be public accessible?" "en": "Should Weblate be public accessible?",
"fr": "Weblate doit-il être accessible au public ?"
}, },
"help": { "help": {
"en": "Any YunoHost user and anonymous people from the web will be able to access the application" "en": "Any YunoHost user and anonymous people from the web will be able to access the application",
"fr": "Tout utilisateur YunoHost et les personnes anonymes pourront accéder à l'application"
}, },
"default": "0" "default": "0"
}, },
@ -53,7 +58,8 @@
"name": "admin", "name": "admin",
"type": "user", "type": "user",
"ask": { "ask": {
"en": "Choose an admin user for Weblate" "en": "Choose an admin user for Weblate",
"fr": "Choisissez l'administrateur pour Weblate"
}, },
"example": "simon" "example": "simon"
}, },
@ -61,7 +67,8 @@
"name": "github_account", "name": "github_account",
"type": "string", "type": "string",
"ask": { "ask": {
"en": "Github's username" "en": "GitHub's username",
"fr": "Nom d'utilisateur de GitHub"
}, },
"example": "simon" "example": "simon"
}, },
@ -69,7 +76,8 @@
"name": "github_token", "name": "github_token",
"type": "string", "type": "string",
"ask": { "ask": {
"en": "Github's token (oauth)" "en": "GitHub's token (OAuth)",
"fr": "Jeton GitHub (OAuth)"
}, },
"example": "simon" "example": "simon"
} }