From 8a18c8d449caf7f665b22496a89c190c86bdd52a Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Aug 23 2017 18:19:32 +0000 Subject: Document the possibility to customize {username} in the SSH URL --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 671b734..6af2ccc 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -74,6 +74,13 @@ The URL should end with a slash ``/``. Defaults to: ``'ssh://git@pagure.org/'`` +.. note:: If you are using a custom setup for your deployment where every + user has an account on the machine you may want to tweak this URL + to include the username. If that is the case, you can use + ``{username}`` in the URL and it will be expanded to the username + of the user viewing the page when rendered. + For example: ``'ssh://{username}@pagure.org/'`` + GIT_URL_GIT ~~~~~~~~~~~