From 975fc775c1131a29cde68d52006f9a8cf3bb02c4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?L=C3=A9o?= <leo@pitro.eu>
Date: Fri, 31 Dec 2021 13:45:28 +0100
Subject: [PATCH] docs(README): how to enable SSH

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index af36ce3..5f1b5da 100644
--- a/README.md
+++ b/README.md
@@ -32,3 +32,30 @@ abra app run YOURAPPNAME app gitea -c /etc/gitea/app.ini admin user create --use
 ```
 
 See the [Gitea command-line documentation](https://docs.gitea.io/en-us/command-line/) for more options.  Make sure not to forget the `-c /etc/gitea/app.ini`.
+
+## Enable SSH
+
+You most certainly want to be able to access your repository over SSH.  To do so, make sure you uncomment the right lines in the configuration for `traefik`.
+```
+abra app config YOURTRAEFIKAPP
+```
+There uncomment or add these lines:
+```
+GITEA_SSH_ENABLED=1
+COMPOSE_FILE="compose.yml:compose.gitea.yml"
+```
+Then redeploy traefik:
+```
+abra app undeploy YOURTRAEFIKAPP
+abra app deploy YOURTRAEFIKAPP
+```
+You might need to wait a bit.  To check if it worked, you can run
+```
+telnet my.gitea.example.com 2222
+```
+Once you have added a public SSH key, you can check that you can connect to your gitea server with
+```
+ssh -T -p 2222 git@my.gitea.example.com
+```
+
+Note that gitea should be configured to listen to port 2222, i.e. `GITEA_SSH_PORT=2222` in the gitea config.