mirror of
https://github.com/YunoHost-Apps/forgejo_ynh.git
synced 2024-09-03 18:36:26 +02:00
Auto-update README
This commit is contained in:
parent
58cf916870
commit
2e00840d7f
2 changed files with 1 additions and 93 deletions
46
README.md
46
README.md
|
@ -40,52 +40,6 @@ Brought to you by an inclusive community under the umbrella of Codeberg e.V., a
|
||||||
|
|
||||||
![Screenshot of Forgejo](./doc/screenshots/screenshot.png)
|
![Screenshot of Forgejo](./doc/screenshots/screenshot.png)
|
||||||
|
|
||||||
## Disclaimers / important information
|
|
||||||
|
|
||||||
## Additional informations
|
|
||||||
|
|
||||||
### Notes on SSH usage
|
|
||||||
|
|
||||||
If you want to use Forgejo 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 Forgejo:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
PubkeyAuthentication yes
|
|
||||||
ChallengeResponseAuthentication no
|
|
||||||
PasswordAuthentication no
|
|
||||||
```
|
|
||||||
|
|
||||||
You must also add your public key to your Forgejo 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
|
|
||||||
```
|
|
||||||
|
|
||||||
### Private Mode
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
### Remove
|
|
||||||
|
|
||||||
To remove the data directory in `/home/yunohost.app/forgejo`, use the `--purge` option:
|
|
||||||
`sudo yunohost remove forgejo --purge`.
|
|
||||||
|
|
||||||
### Uploaded files size
|
|
||||||
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/forgejo.conf`.
|
|
||||||
```
|
|
||||||
client_max_body_size 200M;
|
|
||||||
```
|
|
||||||
Don't forget to restart Forgejo `sudo systemctl restart forgejo.service`.
|
|
||||||
|
|
||||||
> These settings are restored to the default configuration when updating Forgejo. 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
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: <https://forgejo.org>
|
* Official app website: <https://forgejo.org>
|
||||||
|
|
48
README_fr.md
48
README_fr.md
|
@ -40,52 +40,6 @@ Brought to you by an inclusive community under the umbrella of Codeberg e.V., a
|
||||||
|
|
||||||
![Capture d’écran de Forgejo](./doc/screenshots/screenshot.png)
|
![Capture d’écran de Forgejo](./doc/screenshots/screenshot.png)
|
||||||
|
|
||||||
## Avertissements / informations importantes
|
|
||||||
|
|
||||||
## Additional informations
|
|
||||||
|
|
||||||
### Notes on SSH usage
|
|
||||||
|
|
||||||
If you want to use Forgejo 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 Forgejo:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
PubkeyAuthentication yes
|
|
||||||
ChallengeResponseAuthentication no
|
|
||||||
PasswordAuthentication no
|
|
||||||
```
|
|
||||||
|
|
||||||
You must also add your public key to your Forgejo 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
|
|
||||||
```
|
|
||||||
|
|
||||||
### Private Mode
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
### Remove
|
|
||||||
|
|
||||||
To remove the data directory in `/home/yunohost.app/forgejo`, use the `--purge` option:
|
|
||||||
`sudo yunohost remove forgejo --purge`.
|
|
||||||
|
|
||||||
### Uploaded files size
|
|
||||||
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/forgejo.conf`.
|
|
||||||
```
|
|
||||||
client_max_body_size 200M;
|
|
||||||
```
|
|
||||||
Don't forget to restart Forgejo `sudo systemctl restart forgejo.service`.
|
|
||||||
|
|
||||||
> These settings are restored to the default configuration when updating Forgejo. 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
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site officiel de l’app : <https://forgejo.org>
|
* Site officiel de l’app : <https://forgejo.org>
|
||||||
|
@ -106,4 +60,4 @@ ou
|
||||||
sudo yunohost app upgrade forgejo -u https://github.com/YunoHost-Apps/forgejo_ynh/tree/testing --debug
|
sudo yunohost app upgrade forgejo -u https://github.com/YunoHost-Apps/forgejo_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||||
|
|
Loading…
Reference in a new issue