mirror of
https://github.com/YunoHost-Apps/gogs_ynh.git
synced 2024-09-03 20:36:23 +02:00
Merge pull request #2 from YunoHost-Apps/typo_fix
[enh] manifest and readme fixes:
This commit is contained in:
commit
23f85454c8
2 changed files with 18 additions and 30 deletions
45
README.md
45
README.md
|
@ -1,79 +1,66 @@
|
|||
Gogs for Yunohost
|
||||
=================
|
||||
# Gogs package for YunoHost
|
||||
|
||||
Gogs is a self-hosted Git service written in Go. Alternative to Github.
|
||||
Official website: <http://gogs.io/>
|
||||
- [Gogs website](http://gogs.io)
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Functionnal instance of [Yunohost](https://yunohost.org/#/)
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Requirements
|
||||
- Functionnal instance of [YunoHost](https://yunohost.org)
|
||||
|
||||
## Installation
|
||||
From command line:
|
||||
|
||||
`sudo yunohost app install -l Gogs https://github.com/YunoHost-Apps/gogs_ynh`
|
||||
|
||||
Upgrade
|
||||
-------
|
||||
## Upgrade
|
||||
From command line:
|
||||
|
||||
`sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/gogs_ynh gogs`
|
||||
|
||||
Notes on SSH usage
|
||||
------------------
|
||||
|
||||
## 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 need to be properly configured to use private/public key. Here is a sample configuration (in `/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
|
||||
```
|
||||
|
||||
Infos on upgrade from the old package version (gogs <0.9.xx)
|
||||
-------
|
||||
## Infos on upgrade from the old package version (gogs <0.9.xx)
|
||||
Previous versions of this package used to build gogs from sources instead of using precompiled binary. It also leave data to many places which was not good. The upgrade try to take care of moving everything to the right place **BUT, it's strongly advised to do a backup of your repositories and of the gogs directory before the update**. Your avatars and issue attachments files may be lost in the process.
|
||||
|
||||
Plus, 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/)
|
||||
|
||||
Infos
|
||||
-----
|
||||
## Infos
|
||||
Gogs v0.9.97
|
||||
|
||||
Yunohost forum thread: https://forum.yunohost.org/t/gogs-package-an-awesome-github-alternative/1127
|
||||
- [YunoHost forum thread](https://forum.yunohost.org/t/gogs-package-an-awesome-github-alternative/1127)
|
||||
|
||||
Architecture: this package is compatible with amd64, i386 and arm, the package will try to detect it with the command arch and fail if it can't find it. If that happen please open an issue describing your hardware and the result of the command `arch`.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
## License
|
||||
Gogs is published under MIT License
|
||||
https://github.com/gogits/gogs/blob/master/LICENSE
|
||||
|
||||
This package is published under MIT License
|
||||
|
||||
|
||||
Developper infos
|
||||
----------------
|
||||
|
||||
## Developper infos
|
||||
Please do your pull request 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
|
||||
|
|
|
@ -2,11 +2,12 @@
|
|||
"package_format": 1,
|
||||
"name": "Gogs",
|
||||
"id": "gogs",
|
||||
"packaging_format": 1,
|
||||
"description": {
|
||||
"en": "A self-hosted Git service written in Go",
|
||||
"fr": "A self-hosted Git service written in Go"
|
||||
},
|
||||
"url": "http://gogs.io/",
|
||||
"url": "http://gogs.io",
|
||||
"license": "MIT",
|
||||
"version": "0.9.97",
|
||||
"maintainer": {
|
||||
|
|
Loading…
Add table
Reference in a new issue