mirror of
				https://framagit.org/YunoHost-Apps/gitea_ynh.git
				synced 2025-10-30 21:35:36 +01:00 
			
		
		
		
	Auto-update README
This commit is contained in:
		
							
								
								
									
										93
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										93
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,48 +1,32 @@ | |||||||
| Gitea package for YunoHost | <!-- | ||||||
| ========================== | N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator | ||||||
|  | It shall NOT be edited by hand. | ||||||
|  | --> | ||||||
|  |  | ||||||
|  | # Gitea for YunoHost | ||||||
|  |  | ||||||
| [](https://dash.yunohost.org/appci/app/gitea)     | [](https://dash.yunohost.org/appci/app/gitea)     | ||||||
| [](https://install-app.yunohost.org/?app=gitea) | [](https://install-app.yunohost.org/?app=gitea) | ||||||
|  |  | ||||||
| > *This package allow you to install gitea quickly and simply on a YunoHost server.   | *[Lire ce readme en français.](./README_fr.md)* | ||||||
| If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* |  | ||||||
|  |  | ||||||
| Overview | > *This package allows you to install Gitea quickly and simply on a YunoHost server. | ||||||
| -------- | If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* | ||||||
|  |  | ||||||
|  | ## Overview | ||||||
|  |  | ||||||
| Gitea is a fork of Gogs a self-hosted Git service written in Go. Alternative to Github. | Gitea is a fork of Gogs a self-hosted Git service written in Go. Alternative to Github. | ||||||
|  |  | ||||||
| **Shipped version:** 1.16.5 |  | ||||||
|  |  | ||||||
| Screenshots | **Shipped version:** 1.16.5~ynh1 | ||||||
| ----------- |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| Documentation |  | ||||||
| ------------- |  | ||||||
|  |  | ||||||
|  * Official documentation: https://docs.gitea.io/ | ## Screenshots | ||||||
|  * YunoHost documentation: There no other documentations, feel free to contribute. |  | ||||||
|  |  | ||||||
| YunoHost specific features |  | ||||||
| -------------------------- |  | ||||||
|  |  | ||||||
| ### Multi-users support | ## Disclaimers / important information | ||||||
|  |  | ||||||
| LDAP and HTTP auth are supported. |  | ||||||
|  |  | ||||||
| ### Supported architectures |  | ||||||
|  |  | ||||||
| * x86-64 - [](https://ci-apps.yunohost.org/ci/apps/gitea/) |  | ||||||
| * ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/gitea/) |  | ||||||
|  |  | ||||||
| <!--Limitations |  | ||||||
| ------------ |  | ||||||
|  |  | ||||||
| * Any known limitations. |  | ||||||
| --> |  | ||||||
|  |  | ||||||
| Additional informations | Additional informations | ||||||
| ----------------------- | ----------------------- | ||||||
| @@ -68,10 +52,6 @@ Host domain.tld | |||||||
|     port 2222 # change this with the port you use |     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 | ### Upgrade | ||||||
|  |  | ||||||
| By default a backup is made before the upgrade. To avoid this you have theses following possibilites: | By default a backup is made before the upgrade. To avoid this you have theses following possibilites: | ||||||
| @@ -126,36 +106,23 @@ Don't forget to restart Gitea `sudo systemctl restart gitea.service`. | |||||||
|  |  | ||||||
| If you want to use the git command (like `git clone`, `git pull`, `git push`), you need to set this app as **public**. | If you want to use the git command (like `git clone`, `git pull`, `git push`), you need to set this app as **public**. | ||||||
|  |  | ||||||
| Links | ## Documentation and resources | ||||||
| ----- |  | ||||||
|  |  | ||||||
|  * Report a bug: https://framagit.org/YunoHost-Apps/gitea_ynh/issues | * Official app website: https://gitea.io/ | ||||||
|  * App website: http://gitea.io | * Official admin documentation: https://docs.gitea.io/ | ||||||
|  * YunoHost website: https://yunohost.org/ | * 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 | ||||||
|  |  | ||||||
| --- | ## Developer info | ||||||
|  |  | ||||||
| Install | Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gitea_ynh/tree/testing). | ||||||
| ------- |  | ||||||
|  |  | ||||||
| From command line: | To try the testing branch, please proceed like that. | ||||||
|  | ``` | ||||||
|  | sudo yunohost app install https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug | ||||||
|  | or | ||||||
|  | sudo yunohost app upgrade gitea -u https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug | ||||||
|  | ``` | ||||||
|  |  | ||||||
| `sudo yunohost app install -l gitea https://github.com/YunoHost-Apps/gitea_ynh` | **More info regarding app packaging:** https://yunohost.org/packaging_apps | ||||||
|  |  | ||||||
| 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 |  | ||||||
| ---- |  | ||||||
							
								
								
									
										124
									
								
								README_fr.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										124
									
								
								README_fr.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,124 @@ | |||||||
|  | # Gitea pour YunoHost | ||||||
|  |  | ||||||
|  | [](https://dash.yunohost.org/appci/app/gitea)     | ||||||
|  | [](https://install-app.yunohost.org/?app=gitea) | ||||||
|  |  | ||||||
|  | *[Read this readme in english.](./README.md)* | ||||||
|  | *[Lire ce readme en français.](./README_fr.md)* | ||||||
|  |  | ||||||
|  | > *Ce package vous permet d'installer Gitea rapidement et simplement sur un serveur YunoHost. | ||||||
|  | Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* | ||||||
|  |  | ||||||
|  | ## Vue d'ensemble | ||||||
|  |  | ||||||
|  | Gitea is a fork of Gogs a self-hosted Git service written in Go. Alternative to Github. | ||||||
|  |  | ||||||
|  |  | ||||||
|  | **Version incluse :** 1.16.5~ynh1 | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  | ## 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 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: | ||||||
|  |  | ||||||
|  | ```bash | ||||||
|  | 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`: | ||||||
|  |  | ||||||
|  | ```bash | ||||||
|  | Host domain.tld | ||||||
|  |     port 2222 # change this with the port you use | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### 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. | ||||||
|  |  | ||||||
|  | From command line: | ||||||
|  |  | ||||||
|  | `yunohost app upgrade gitea` | ||||||
|  |  | ||||||
|  | ### 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` | ||||||
|  | ```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**. | ||||||
|  |  | ||||||
|  | ## Documentations et ressources | ||||||
|  |  | ||||||
|  | * Site officiel de l'app : https://gitea.io/ | ||||||
|  | * Documentation officielle de l'admin : https://docs.gitea.io/ | ||||||
|  | * 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 | ||||||
|  |  | ||||||
|  | ## Informations pour les développeurs | ||||||
|  |  | ||||||
|  | Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gitea_ynh/tree/testing). | ||||||
|  |  | ||||||
|  | Pour essayer la branche testing, procédez comme suit. | ||||||
|  | ``` | ||||||
|  | sudo yunohost app install https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug | ||||||
|  | ou | ||||||
|  | sudo yunohost app upgrade gitea -u https://github.com/YunoHost-Apps/gitea_ynh/tree/testing --debug | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps | ||||||
		Reference in New Issue
	
	Block a user
	 yunohost-bot
					yunohost-bot