diff --git a/README.md b/README.md index 1ca136f..7261aab 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,17 @@ It shall NOT be edited by hand. # Gitea 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.svg)](https://install-app.yunohost.org/?app=gogs) +[![Integration level](https://dash.yunohost.org/integration/gitea.svg)](https://dash.yunohost.org/appci/app/gitea) ![Working status](https://ci-apps.yunohost.org/ci/badges/gitea.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gitea.maintain.svg) +[![Install Gitea with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gitea) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Gogs quickly and simply on a YunoHost server. +> *This package allows you to install Gitea 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 -Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. +Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and GitLab. Gitea is a fork of Gogs. See the Gitea Announcement blog post to read about the justification for a fork. ### Features @@ -31,19 +31,19 @@ Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its part - Customize HTML templates, static files and many others. -**Shipped version:** 0.12.6~ynh1 +**Shipped version:** 1.17.0~ynh1 -**Demo:** https://try.gogs.io/user/login +**Demo:** https://try.gitea.io/ ## Screenshots -![](./doc/screenshots/screenshot.png) +![Screenshot of Gitea](./doc/screenshots/screenshot.png) ## Disclaimers / important information ## 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: +If you want to use Gitea 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 @@ -53,7 +53,7 @@ PasswordAuthentication no UsePAM no ``` -You also need to add your public key to your Gogs profile. +You also need to add your public key to your Gitea profile. If you use SSH on another port than 22, you need to add theses lines to your ssh config in `~/.ssh/config`: @@ -68,21 +68,22 @@ Actually it's possible to access to the Git repositories by the `git` command ov ## Documentation and resources -* 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 +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gitea_ynh/tree/testing). To try the testing branch, please proceed like that. -``` -sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug or -sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug +sudo yunohost app upgrade gitea -u https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index fbb3e65..96fb587 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,32 +1,36 @@ + + # Gitea 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) +[![Niveau d'intégration](https://dash.yunohost.org/integration/gitea.svg)](https://dash.yunohost.org/appci/app/gitea) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/gitea.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/gitea.maintain.svg) +[![Installer Gitea avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gitea) *[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. +> *Ce package vous permet d'installer Gitea 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 -Gogs (Go Git Service) est une forge multiplateforme basée sur git écrite en Go. Sa particularité est d’être léger et pouvant fonctionner sur carte ARM, ce qui fait qu’il est adapté à l’auto-hébergement. Gogs a une interface web similaire à celle de GitHub. +Gitea est un service Git auto-hébergé. Il est similaire à GitHub, Bitbucket et GitLab. Gitea est un fork de Gogs. -**Version incluse :** 0.12.6~ynh1 +**Version incluse :** 1.17.0~ynh1 -**Démo :** https://try.gogs.io/user/login +**Démo :** https://try.gitea.io/ ## Captures d'écran -![](./doc/screenshots/screenshot.png) +![Capture d'écran de Gitea](./doc/screenshots/screenshot.png) ## Avertissements / informations importantes ## 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: +If you want to use Gitea 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 @@ -36,7 +40,7 @@ PasswordAuthentication no UsePAM no ``` -You also need to add your public key to your Gogs profile. +You also need to add your public key to your Gitea profile. If you use SSH on another port than 22, you need to add theses lines to your ssh config in `~/.ssh/config`: @@ -51,21 +55,22 @@ Actually it's possible to access to the Git repositories by the `git` command ov ## 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 +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gitea_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 + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug ou -sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug +sudo yunohost app upgrade gitea -u https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**