1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gogs_ynh.git synced 2024-09-03 20:36:23 +02:00
gogs_ynh/README.md

72 lines
2.9 KiB
Markdown
Raw Normal View History

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.
-->
2020-10-11 22:38:04 +02:00
# Gogs for YunoHost
2016-08-15 15:38:50 +02:00
2020-10-11 22:45:51 +02:00
[![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)
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)
2021-11-07 10:32:58 +01:00
*[Lire ce readme en français.](./README_fr.md)*
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.*
2020-10-11 22:45:51 +02:00
## Overview
2021-11-07 12:47:42 +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.
2021-11-07 10:32:58 +01:00
**Shipped version:** 0.12.3~ynh1
2016-10-16 16:43:48 +02:00
2021-11-07 10:32:58 +01:00
**Demo:** https://try.gogs.io/user/login
2021-11-07 12:42:20 +01:00
## Screenshots
![](./doc/screenshots/screenshot.png)
2021-11-21 21:56:13 +01:00
## 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:
```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
```
## 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.
2021-11-07 10:32:58 +01:00
## Documentation and resources
2016-10-16 16:43:48 +02:00
2021-11-07 10:32:58 +01: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
2016-08-15 15:38:50 +02:00
2020-10-11 22:38:04 +02:00
## Developer info
2016-08-15 15:38:50 +02:00
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).
2016-08-15 15:38:50 +02:00
2020-10-11 22:38:04 +02:00
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
2016-08-15 15:38:50 +02:00
```
2021-11-07 10:32:58 +01:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps