gogs_ynh/README.md

<!--
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.
-->

# Gogs for YunoHost

[![Integration level](https://dash.yunohost.org/integration/gogs.svg)](https://dash.yunohost.org/appci/app/gogs) ![Working status](https://ci-apps.yunohost.org/ci/badges/gogs.status.svg) ![Maintenance status](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)

*[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.*

## 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.

### Features

- User dashboard, user profile and activity timeline.
- Repository and organization webhooks, including Slack, Discord and Dingtalk.
- Repository Git hooks, deploy keys and Git LFS.
- Repository issues, pull requests, wiki, protected branches and collaboration.
- Migrate and mirror repositories with wiki from other code hosts.
- Web editor for quick editing repository files and wiki.
- Jupyter Notebook and PDF rendering.
- Authentication via SMTP, LDAP.


**Shipped version:** 0.13.0~ynh1

**Demo:** https://try.gogs.io/user/login

## Screenshots

![Screenshot of Gogs](./doc/screenshots/screenshot.png)

## 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>

## Developer info

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.

``` bash
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
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Auto-update README 2021-11-07 10:32:58 +01:00			`<!--`
			`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.`
			`-->`

v.0.12.3 2020-10-11 22:38:04 +02:00			`# Gogs for YunoHost`
Initial commit 2016-08-15 15:38:50 +02:00
Auto-update README 2023-02-25 14:49:31 +01:00			`[![Integration level](https://dash.yunohost.org/integration/gogs.svg)](https://dash.yunohost.org/appci/app/gogs) ![Working status](https://ci-apps.yunohost.org/ci/badges/gogs.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gogs.maintain.svg)`

Auto-update README 2021-11-07 10:32:58 +01:00			`[![Install Gogs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs)`
Use new helpers and remove sudo in each command and factorise code 2018-02-07 00:31:25 +01:00
Auto-update README 2021-11-07 10:32:58 +01:00			`[Lire ce readme en français.](./README_fr.md)`
Use new helpers and remove sudo in each command and factorise code 2018-02-07 00:31:25 +01:00
Auto-update README 2021-11-07 10:32:58 +01:00			`> *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.*`
Add information about migration to gitea 2019-05-14 22:13:29 +02:00
fix 2020-10-11 22:45:51 +02:00			`## Overview`
Add information about migration to gitea 2019-05-14 22:13:29 +02:00
Auto-update README 2021-11-26 12:34:01 +01:00			`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.`

			`### Features`

			`- User dashboard, user profile and activity timeline.`
			`- Repository and organization webhooks, including Slack, Discord and Dingtalk.`
			`- Repository Git hooks, deploy keys and Git LFS.`
			`- Repository issues, pull requests, wiki, protected branches and collaboration.`
			`- Migrate and mirror repositories with wiki from other code hosts.`
			`- Web editor for quick editing repository files and wiki.`
			`- Jupyter Notebook and PDF rendering.`
Auto-update README 2021-11-26 22:12:55 +01:00			`- Authentication via SMTP, LDAP.`
Auto-update README 2021-11-26 12:34:01 +01:00
Add information about migration to gitea 2019-05-14 22:13:29 +02:00
Auto-update README 2023-03-15 23:12:04 +01:00			`Shipped version: 0.13.0~ynh1`
Fix ssh usage and add infos to readme 2016-10-16 16:43:48 +02:00
Auto-update README 2021-11-07 10:32:58 +01:00			`Demo: https://try.gogs.io/user/login`
[enh] manifest and readme fixes: - readme: - use Markdown syntax. - typo on YunoHost, bash, links. - manifest (with package_linter): - add missing 'packaging format' field. - License field must be 'free' or 'nonfree': - In YunoHost team, we are not agree about his value ('MIT' or 'free'). 2016-10-16 20:35:30 +02:00
Auto-update README 2021-11-07 12:42:20 +01:00			`## Screenshots`

Auto-update README 2022-06-01 08:12:14 +02:00			`![Screenshot of Gogs](./doc/screenshots/screenshot.png)`
Auto-update README 2021-11-07 12:42:20 +01:00
Auto-update README 2021-11-07 10:32:58 +01:00			`## Documentation and resources`
Fix ssh usage and add infos to readme 2016-10-16 16:43:48 +02:00
Auto-update README 2022-06-01 08:12:14 +02:00			`* 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>`
Initial commit 2016-08-15 15:38:50 +02:00
v.0.12.3 2020-10-11 22:38:04 +02:00			`## Developer info`
Initial commit 2016-08-15 15:38:50 +02:00
v.0.12.3 2020-10-11 22:38:04 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing).`
Initial commit 2016-08-15 15:38:50 +02:00
v.0.12.3 2020-10-11 22:38:04 +02:00			`To try the testing branch, please proceed like that.`
Auto-update README 2022-06-01 08:12:14 +02:00
			``` bash
v.0.12.3 2020-10-11 22:38:04 +02:00			`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`
Initial commit 2016-08-15 15:38:50 +02:00			```
Auto-update README 2021-11-07 10:32:58 +01:00
Auto-update README 2022-06-01 08:12:14 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`