diff --git a/README.md b/README.md index 63828d7..1a84b5c 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,31 @@ Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its part ![](./doc/screenshots/screenshot.png) +## Disclaimers / important information + +## Notes on SSH usage +If you want to use Gogs 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 %h/.ssh/authorized_keys +ChallengeResponseAuthentication no +PasswordAuthentication no +UsePAM no +``` + +You also need to add your public key to your Gogs 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 +``` + +## 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. + ## Documentation and resources * Official app website: http://gogs.io diff --git a/README_fr.md b/README_fr.md index 40ae0d1..794cf34 100644 --- a/README_fr.md +++ b/README_fr.md @@ -21,6 +21,31 @@ Gogs (Go Git Service) est une forge multiplateforme basée sur git écrite en Go ![](./doc/screenshots/screenshot.png) +## Avertissements / informations importantes + +## Notes on SSH usage +If you want to use Gogs 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 %h/.ssh/authorized_keys +ChallengeResponseAuthentication no +PasswordAuthentication no +UsePAM no +``` + +You also need to add your public key to your Gogs 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 +``` + +## 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. + ## Documentations et ressources * Site officiel de l'app : http://gogs.io