From f98f2835a4d6dee42c541648fc0d908bd2ddbc42 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 17 Jul 2022 13:14:11 +0000 Subject: [PATCH] Auto-update README --- README.md | 61 +++++---------------------------------------------- README_fr.md | 62 +++++----------------------------------------------- 2 files changed, 11 insertions(+), 112 deletions(-) diff --git a/README.md b/README.md index 8ef412a..7261aab 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,13 @@ Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, ## Disclaimers / important information -## 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 Gogs: ```bash PubkeyAuthentication yes -AuthorizedKeysFile /home/yunohost.app/%u/.ssh/authorized_keys +AuthorizedKeysFile %h/.ssh/authorized_keys ChallengeResponseAuthentication no PasswordAuthentication no UsePAM no @@ -55,67 +55,16 @@ UsePAM no You also need to 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`: +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 ``` -### Upgrade +## Private Mode -By default, a backup is performed before upgrading. To avoid this, you have the following options: -- Pass the `NO_BACKUP_UPGRADE` env variable with `1` at each upgrade. For example `NO_BACKUP_UPGRADE=1 yunohost app upgrade gitea`. -- Set `disable_backup_before_upgrade` to `1`. You can set it with this command: - -`yunohost app setting gitea disable_backup_before_upgrade -v 1` - -After that, the settings will be applied for **all** the next updates. - -From command line: - -`yunohost app upgrade gitea` - -### 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 with this command: - -`systemctl stop gitea.service` - -- Launch Gitea backup with this command: - -`yunohost backup create --app gitea` - -- 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/gitea`. -- Restart Gitea service with theses command: - -`systemctl start gitea.service` - -### Remove - -Due of the backup core only feature the data directory in `/home/yunohost.app/gitea` **is not removed**. It must be manually deleted to purge user data from the app. - -### LFS setup -To use a repository with an `LFS` setup, you need to activate it on `/opt/gitea/custom/conf/app.ini` - -```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/my.domain.tld.d/gitea.conf`. -``` -client_max_body_size 200M; -``` -Don't forget to restart Gitea `sudo systemctl restart gitea.service`. - -> These settings are restored to the default configuration when updating Gitea. Remember to restore your configuration 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**. +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. ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index 27e372d..96fb587 100644 --- a/README_fr.md +++ b/README_fr.md @@ -28,80 +28,30 @@ Gitea est un service Git auto-hébergé. Il est similaire à GitHub, Bitbucket e ## Avertissements / informations importantes -## 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 Gogs: ```bash PubkeyAuthentication yes -AuthorizedKeysFile /home/yunohost.app/%u/.ssh/authorized_keys +AuthorizedKeysFile %h/.ssh/authorized_keys ChallengeResponseAuthentication no PasswordAuthentication no UsePAM no ``` You also need to 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`: + +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 ``` -### Upgrade +## Private Mode -By default, a backup is performed before upgrading. To avoid this, you have the following options: -- Pass the `NO_BACKUP_UPGRADE` env variable with `1` at each upgrade. For example `NO_BACKUP_UPGRADE=1 yunohost app upgrade gitea`. -- Set `disable_backup_before_upgrade` to `1`. You can set it with this command: - -`yunohost app setting gitea disable_backup_before_upgrade -v 1` - -After that, the settings will be applied for **all** the next updates. - -From command line: - -`yunohost app upgrade gitea` - -### 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 with this command: - -`systemctl stop gitea.service` - -- Launch Gitea backup with this command: - -`yunohost backup create --app gitea` - -- 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/gitea`. -- Restart Gitea service with theses command: - -`systemctl start gitea.service` - -### Remove - -Due of the backup core only feature the data directory in `/home/yunohost.app/gitea` **is not removed**. It must be manually deleted to purge user data from the app. - -### LFS setup -To use a repository with an `LFS` setup, you need to activate it on `/opt/gitea/custom/conf/app.ini` - -```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/my.domain.tld.d/gitea.conf`. -``` -client_max_body_size 200M; -``` -Don't forget to restart Gitea `sudo systemctl restart gitea.service`. - -> These settings are restored to the default configuration when updating Gitea. Remember to restore your configuration 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**. +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. ## Documentations et ressources