From e8726781f3e18bb8219c6a794f9ee3261ae4f409 Mon Sep 17 00:00:00 2001 From: bashbunni Date: Wed, 13 Apr 2022 09:27:16 -0700 Subject: [PATCH] docs: add managing and deleting repos --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bdcb11ded6b6c9de318c9f7162b64eacbb1dbfc4..cf5c144210f50372d618175b976931aacbf3c3a8 100644 --- a/README.md +++ b/README.md @@ -252,7 +252,21 @@ Both `git` and `reload` commands need admin access to the server to work. So make sure you have added your key as an admin user, or you’re using `anon-access: admin-access` in the configuration. -### A note about RSA keys +## Managing Repos + +`.repos` and `.ssh` directories are created when you first run `soft` at the paths specified for the `SOFT_SERVE_KEY_PATH` and `SOFT_SERVE_REPO_PATH` environment variables. +It's recommended to have a dedicated directory for your soft-serve repos and config. + +### Deleting a Repo + +To delete a repo from your soft serve server, you'll have to remove the repo from the .repos directory. + +### Renaming a Repo + +To rename a repo's display name in the menu, change its name in the config.yaml file for your soft serve server. +By default, the display name will be the repository name. + +## A note about RSA keys Unfortunately, due to a shortcoming in Go’s `x/crypto/ssh` package, Soft Serve does not currently support access via new SSH RSA keys: only the old SHA-1