yunohost-gitea_ynh/doc/ADMIN.md
Félix Piédallu 60cb5e5ae4 Migrate to manifestv2 and other changes:
* Move app install dir from /opt to /var/www
* Revamp the way binaries are downloaded thanks to manifestv2 (no need to check for arch, etc)
* Remove custom helpers (exec_as, ynh_handle_app_migration)
* Rename LFS_KEY as LFS_JWT_SECRET and KEY as SECRET_KEY as named in app.ini
* Add JWT_SECRET for oauth and INTERNAL_TOKEN in app.ini
* update upstream sample app.ini URL
* Disable actions for now.
* Automatically add ssh permissions to the system user
* Remove support for upgrade before 1.6.4. Edit test_upgrade_from accordingly.
2023-11-29 17:26:25 +01:00

2.3 KiB

Git access

Via HTTPS

If you want to use git repositories with https remotes, you need to set this app as public.

Via SSH

If you want to use Gitea with SSH and be able to pull/push with your SSH key, your SSH daemon must be properly configured to use private/public keys.

Here is a sample configuration /etc/ssh/sshd_config that works with Gitea:

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

You must also add your public key to your Gitea profile.

When using SSH on any port other than 22, you need to add these lines to your SSH configuration ~/.ssh/config:

Host __DOMAIN__
    port 2222 # change this with the port you use

LFS setup

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

[server]
LFS_START_SERVER = true
LFS_HTTP_AUTH_EXPIRY = 20m

By default, NGINX is configured with a maximum value for uploading files at 200 MB. It's possible to change this value on /etc/nginx/conf.d/__DOMAIN__.d/__APP__.conf.

client_max_body_size 200M;

Don't forget to restart Gitea:

sudo systemctl restart __APP__.service`.

These settings are restored to the default configuration when updating Gitea. Remember to restore your configuration after all updates.

Upgrade

From command line:

yunohost app upgrade __APP__

If you want to bypass the safety backup before upgrading, run:

yunohost app upgrade --no-safety-backup __APP__

Backup

This application now uses the core-only feature of the backup. To keep the integrity of the data and to have a better guarantee of the restoration it is recommended to proceed as follows:

  • Stop Gitea service:
systemctl stop __APP__.service
  • Launch Gitea backup:
yunohost backup create --app __APP__
  • Backup your data with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in /home/yunohost.app/__APP__.
  • Restart Gitea service:
systemctl stop __APP__.service

Remove

Due of the backup core only feature the data directory in /home/yunohost.app/__APP__ is not removed. It must be manually deleted to purge user data from the app.