~jan0sch/smederee

Showing details for patch 1d5115657911773c4fb64db6a7a213064db8678e.
2023-01-29 (Sun), 8:15 PM - Jens Grassel - 1d5115657911773c4fb64db6a7a213064db8678e

README: Add some instructions for working via ssh.

Summary of changes
1 files modified with 23 lines added and 0 lines removed
  • README.md with 23 added and 0 removed lines
diff -rN -u old-smederee/README.md new-smederee/README.md
--- old-smederee/README.md	2025-02-01 02:06:41.495999629 +0000
+++ new-smederee/README.md	2025-02-01 02:06:41.495999629 +0000
@@ -22,6 +22,29 @@
 During development you can start (and restart) the application via the `reStart`
 sbt task provided by the sbt-revolver plugin.
 
+Cloning via ssh has the following constraints currently:
+
+1. An RSA key is required!
+2. A custom port is used!
+
+To make darcs use the custom port either set the `SSH_PORT` environment
+variable (`SSH_PORT=30983 darcs clone ...`) or configure your ssh client
+accordingly in `~/.ssh/config`. Something like this should be sufficient:
+
+```
+# Only use configured identities even if there are more available.
+IdentitiesOnly yes
+IdentityFile ~/.ssh/id_ed25519
+
+Host darcs.smeder.ee
+  IdentityFile ~/.ssh/id_rsa
+  Port 30983
+  User darcs
+```
+
+With such a configuration you should be able to use `darcs clone` etc.
+without having to set the environment variable.
+
 ### Protecting endpoints ###
 
 If an endpoint is intended to be used only by guests (users that are not