mirror of
https://github.com/YunoHost-Apps/gitea_ynh.git
synced 2024-09-03 20:36:22 +02:00
Merge branch 'version-2' of https://github.com/YunoHost-Apps/gitea_ynh into version-2
This commit is contained in:
Éric Gaspar
commit
0c4bdc2140
2 changed files with 36 additions and 166 deletions
101
README.md
101
README.md
|
|
@ -16,99 +16,34 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
|||
|
||||
## Overview
|
||||
|
||||
Gitea is a fork of Gogs a self-hosted Git service written in Go. Alternative to GitHub.
|
||||
Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and GitLab. Gitea is a fork of Gogs. See the Gitea Announcement blog post to read about the justification for a fork.
|
||||
|
||||
### Features
|
||||
|
||||
- User dashboard, user profile and activity timeline.
|
||||
- User, organization and repository management.
|
||||
- Repository and organization webhooks, including Slack, Discord and Dingtalk.
|
||||
- Repository Git hooks, deploy keys and Git LFS.
|
||||
- Repository issues, pull requests, wiki, protected branches and collaboration.
|
||||
- Migrate and mirror repositories with wiki from other code hosts.
|
||||
- Web editor for quick editing repository files and wiki.
|
||||
- Jupyter Notebook and PDF rendering.
|
||||
- Authentication via SMTP, LDAP.
|
||||
- Customize HTML templates, static files and many others.
|
||||
|
||||
|
||||
**Shipped version:** 1.18.4~ynh1
|
||||
**Shipped version:** 1.18.5~ynh1
|
||||
|
||||
**Demo:** https://try.gitea.io/
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
## Additional informations
|
||||
|
||||
### Notes on SSH usage
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
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`:
|
||||
|
||||
```bash
|
||||
Host domain.tld
|
||||
port 2222 # change this with the port you use
|
||||
```
|
||||
|
||||
### Upgrade
|
||||
|
||||
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**.
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: <https://gitea.io/>
|
||||
* Official admin documentation: <https://docs.gitea.io/>
|
||||
* Official admin documentation: <https://docs.gitea.io/en-us/>
|
||||
* Upstream app code repository: <https://github.com/go-gitea/gitea>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_gitea>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/gitea_ynh/issues>
|
||||
|
|
|
|||
101
README_fr.md
101
README_fr.md
|
|
@ -16,99 +16,34 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
|
|||
|
||||
## Vue d’ensemble
|
||||
|
||||
Gitea is a fork of Gogs a self-hosted Git service written in Go. Alternative to GitHub.
|
||||
Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and GitLab. Gitea is a fork of Gogs. See the Gitea Announcement blog post to read about the justification for a fork.
|
||||
|
||||
### Features
|
||||
|
||||
- User dashboard, user profile and activity timeline.
|
||||
- User, organization and repository management.
|
||||
- Repository and organization webhooks, including Slack, Discord and Dingtalk.
|
||||
- Repository Git hooks, deploy keys and Git LFS.
|
||||
- Repository issues, pull requests, wiki, protected branches and collaboration.
|
||||
- Migrate and mirror repositories with wiki from other code hosts.
|
||||
- Web editor for quick editing repository files and wiki.
|
||||
- Jupyter Notebook and PDF rendering.
|
||||
- Authentication via SMTP, LDAP.
|
||||
- Customize HTML templates, static files and many others.
|
||||
|
||||
|
||||
**Version incluse :** 1.18.4~ynh1
|
||||
**Version incluse :** 1.18.5~ynh1
|
||||
|
||||
**Démo :** https://try.gitea.io/
|
||||
|
||||
## Captures d’écran
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Additional informations
|
||||
|
||||
### Notes on SSH usage
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
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`:
|
||||
|
||||
```bash
|
||||
Host domain.tld
|
||||
port 2222 # change this with the port you use
|
||||
```
|
||||
|
||||
### Upgrade
|
||||
|
||||
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**.
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l’app : <https://gitea.io/>
|
||||
* Documentation officielle de l’admin : <https://docs.gitea.io/>
|
||||
* Documentation officielle de l’admin : <https://docs.gitea.io/en-us/>
|
||||
* Dépôt de code officiel de l’app : <https://github.com/go-gitea/gitea>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_gitea>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/gitea_ynh/issues>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue