From 8ae491b0e854fee4c9122c211c13604dcd6fe41f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Tue, 3 Nov 2020 23:08:23 +0100 Subject: [PATCH] Update README.md --- README.md | 78 +++++++++++++++++++++++-------------------------------- 1 file changed, 32 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 1e22aa8..9c6944f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ -# Gogs package for YunoHost - -Gogs is a self-hosted Git service written in Go. Alternative to Github. -- [Gogs website](http://gogs.io) - -[![Integration level](https://dash.yunohost.org/integration/gogs.svg)](https://ci-apps.yunohost.org/jenkins/job/gogs%20%28Community%29/lastBuild/consoleFull) +# 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) # IMPORTANT INFORMATION @@ -12,6 +8,20 @@ Gogs is a self-hosted Git service written in Go. Alternative to Github. **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 + +## Screenshots + +![](https://gogs.io/img/screenshots/2.png) + + +## 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 @@ -27,19 +37,6 @@ For the new install just install gitea by this command: sudo yunohost app install -l Gitea https://github.com/YunoHost-Apps/gitea_ynh ``` -## Requirements -A functional instance of [YunoHost](https://yunohost.org) - -## Installation -From the command-line: - -`sudo yunohost app install -l Gogs https://github.com/YunoHost-Apps/gogs_ynh` - -## Upgrade -From the command-line: - -`sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/gogs_ynh gogs` - ## 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: @@ -65,39 +62,28 @@ Previous versions of this package used to build Gogs from sources instead of usi Also, in some cases, Gogs will not restart properly during the update. If so, you can rerun the update safely or try to start Gogs with `sudo systemctl restart gogs.service`. -Sources and issues of the old package can be found [here](https://github.com/YunoHost-Apps/gogs_ynh_old/) -## Info -Gogs v0.11.66 +#### Supported architectures -- [YunoHost forum thread](https://forum.yunohost.org/t/gogs-package-an-awesome-github-alternative/1127) +* 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/) -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`. +## Links -## Private Mode -Actually it's possible to access to the git repositories by the `git` command over http also in private mode installation. It's important to know that in this mode the repository could be ALSO getted if you don't set the repository as private in the repos settings. + * 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/ -## Issue +--- -Any issue is welcome here : https://github.com/YunoHost-Apps/gogs_ynh/issues +## Developer info -## License -Gogs is published under the MIT License: -https://github.com/gogits/gogs/blob/master/LICENSE - -This package is published under the MIT License. - - -## Developper info -Please do your pull requests to the `dev` branch. - -Test or upgrade to dev version: -```bash -sudo su - admin -git clone -b dev https://github.com/YunoHost-Apps/gogs_ynh -# to install -sudo yunohost app install -l Gogs /home/admin/gogs_ynh -# to upgrade -sudo yunohost app upgrade -f /home/admin/gogs_ynh gogs +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gogs_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 +or +sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug ```