yunohost-gitea_ynh/README.md

Gitea package for YunoHost

This package allow you to install gitea quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to know how to install and enjoy it.

Overview

Gitea is a fork of Gogs a self-hosted Git service written in Go. Alternative to Github.

Shipped version: 1.13.0

Screenshots

Documentation

• Official documentation: https://docs.gitea.io/
• YunoHost documentation: There no other documentations, feel free to contribute.

YunoHost specific features

Multi-users support

LDAP and HTTP auth are supported.

Supported architectures

• x86-64 -
• ARMv8-A -

Additional informations

Notes on SSH usage

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 Gitea:

PubkeyAuthentication yes
AuthorizedKeysFile /home/%u/.ssh/authorized_keys
ChallengeResponseAuthentication no
PasswordAuthentication no
UsePAM no

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:

Host domain.tld
    port 2222 # change this with the port you use

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.

Upgrade

By default a backup is made before the upgrade. To avoid this you have theses following possibilites:

• Pass the NO_BACKUP_UPGRADE env variable with 1 at each upgrade. By example NO_BACKUP_UPGRADE=1 yunohost app upgrade gitea.
• Set the settings disable_backup_before_upgrade to 1. You can set this with this command:

yunohost app setting gitea disable_backup_before_upgrade -v 1

After this settings will be applied for all next upgrade.

Backup

This app use now the core-only feature of the backup. To keep the integrity of the data and to have a better guarantee of the restoration is recommended to proceed like this:

• Stop gitea service with theses following command:

systemctl stop gitea.service

• Launch the backup of gitea with this following command:

yunohost backup create --app gitea

• Do a backup of your data with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in /home/gitea.
• Restart the gitea service with theses command:

systemctl start gitea.service

Remove

Due of the backup core only feature the data directory in /home/gitea is not removed. It need to be removed manually to purge app user data.

LFS setup

To use a repository with an LFS setup, you need to activate-it on /opt/gitea/custom/conf/app.ini

[server]
LFS_START_SERVER = true
LFS_HTTP_AUTH_EXPIRY = 20m

By default Nginx is setup with a max value to updload files at 200 Mo. It's possible to change this value on /etc/nginx/conf.d/my.domain.tld.d/gitea.conf.

client_max_body_size 200M;

Don't forget to restart Gitea sudo systemctl restart gitea.service.

This settings are restored to the default config when Gitea is updated. Don't forget to restore your setup after all updates.

Git command access with HTTPS

If you want to use the git command (like git clone, git pull, git push), you need to set this app as public.

Links

• Report a bug: https://framagit.org/YunoHost-Apps/gitea_ynh/issues
• App website: http://gitea.io
• YunoHost website: https://yunohost.org/

---

Install

From command line:

sudo yunohost app install -l gitea https://github.com/YunoHost-Apps/gitea_ynh

Upgrade

From command line:

sudo yunohost app upgrade gitea -u https://github.com/YunoHost-Apps/gitea_ynh

License

Gitea is published under the MIT License: https://github.com/go-gitea/gitea/blob/master/LICENSE

This package is published under the MIT License.

Todo