diff --git a/README.md b/README.md index da5a6b6..1271cf1 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,33 @@ + + # Gogs for YunoHost [![Integration level](https://dash.yunohost.org/integration/gogs.svg)](https://dash.yunohost.org/appci/app/gogs) ![](https://ci-apps.yunohost.org/ci/badges/gogs.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gogs.maintain.svg) -[![Install Gogs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=gogs) +[![Install Gogs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) -> *This package allows you to install Gogs quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Gogs 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.* -> :warning: **Note that this package will not be longer be maintened by the actual maintener. -> The idea is to migrate to [gitea](https://github.com/YunoHost-Apps/gitea_ynh) which is more featured.** - ## Overview -Gogs is a self-hosted Git service written in Go. Alternative to Github. -**Shipped version:** 0.11.66 +Lightweight Git forge -## Screenshots +**Shipped version:** 0.12.3~ynh1 -![](https://gogs.io/img/screenshots/2.png) +**Demo:** https://try.gogs.io/user/login +## Documentation and resources -## Demo - -* [Official demo](https://try.gogs.io/user/login) - -For the old install you can migrate to gitea easly by juste upgrading your actuall gogs instance with the gitea source by this command: -``` -sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/gitea_ynh gogs -``` -**Note that this command contains some risk of data lost. So it's important to make a backup of the app before the install.** -To make a backup you can use this command: -``` -sudo yunohost backup create --debug --apps gogs -``` - -For the new install just install gitea by this command: -``` -sudo yunohost app install -l Gitea https://github.com/YunoHost-Apps/gitea_ynh -``` - -## Notes on SSH usage -If you want to use Gogs with ssh and be able to pull/push with you ssh key, your SSH daemon must be properly configured to use private/public keys. Here is a sample configuration of `/etc/ssh/sshd_config` that works with Gogs: - -```bash -PubkeyAuthentication yes -AuthorizedKeysFile %h/.ssh/authorized_keys -ChallengeResponseAuthentication no -PasswordAuthentication no -UsePAM no -``` - -You also need to add your public key to your Gogs profile. - -If you use SSH on another port than 22, you need to add theses lines to your SSH config in `~/.ssh/config`: - -```bash -Host domain.tld - port 2222 # change this with the port you use -``` - -Architecture: this package is compatible with amd64, i386 and arm. The package will try to detect it with the command uname -m and fail if it can't detect the architecture. If that happens please open an issue describing your hardware and the result of the command `uname -m`. - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/gogs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/gogs/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/gogs%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/gogs/) - - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/gogs_ynh/issues - * App website: http://gogs.io - * Upstream app repository: https://github.com/gogs/gogs - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: http://gogs.io +* Official admin documentation: https://gogs.io/docs +* Upstream app code repository: https://github.com/gogs/gogs +* YunoHost documentation for this app: https://yunohost.org/app_gogs +* Report a bug: https://github.com/YunoHost-Apps/gogs_ynh/issues ## Developer info @@ -83,3 +39,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing or sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..45a4359 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,39 @@ +# Gogs pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/gogs.svg)](https://dash.yunohost.org/appci/app/gogs) ![](https://ci-apps.yunohost.org/ci/badges/gogs.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gogs.maintain.svg) +[![Installer Gogs avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Gogs rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Forge Git légère + +**Version incluse :** 0.12.3~ynh1 + +**Démo :** https://try.gogs.io/user/login + +## Documentations et ressources + +* Site officiel de l'app : http://gogs.io +* Documentation officielle de l'admin : https://gogs.io/docs +* Dépôt de code officiel de l'app : https://github.com/gogs/gogs +* Documentation YunoHost pour cette app : https://yunohost.org/app_gogs +* Signaler un bug : https://github.com/YunoHost-Apps/gogs_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug +ou +sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file