From a513f0421554a83ad043a918a2530ef8c4b0ee12 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 28 Mar 2023 16:47:07 +0300 Subject: [PATCH] Update soft-serve.md --- docs/services/soft-serve.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/services/soft-serve.md b/docs/services/soft-serve.md index bfb6467..117e0a5 100644 --- a/docs/services/soft-serve.md +++ b/docs/services/soft-serve.md @@ -1,6 +1,6 @@ # Soft Serve -This playbook can configure [Soft Serve](https://github.com/charmbracelet/soft-serve). +[Soft Serve](https://github.com/charmbracelet/soft-serve) is a tasty, self-hostable [Git](https://git-scm.com/) server for the command line. ## Configuration @@ -14,11 +14,16 @@ To enable this service, add the following configuration to your `vars.yml` file ######################################################################## soft_serve_enabled: true + # The hostname of this system. # It will be used for generating git clone URLs (e.g. ssh://mash.example.com/repository.git) soft_serve_hostname: mash.example.com -soft_serve_container_bind_port: 2222 # Expose Soft Serve's port. For git servers the usual git-over-ssh port is 22 -soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE # This key will be able to authenticate with ANY user until you configure Soft Serve + +# Expose Soft Serve's port. For git servers the usual git-over-ssh port is 22 +soft_serve_container_bind_port: 2222 + +# This key will be able to authenticate with ANY user until you configure Soft Serve +soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE ######################################################################## # # @@ -29,6 +34,6 @@ soft_serve_initial_admin_key: YOUR PUBLIC SSH KEY HERE # This key will be able t ## Usage -After you've installed Soft Serve, you can `ssh your-user@mash.example.com -p 2222` with the ssh key you defined in `soft_serve_initial_admin_key` to see TUI and follow the instructions to configure Soft Serve further. +After you've installed Soft Serve, you can `ssh your-user@mash.example.com -p 2222` with the SSH key defined in `soft_serve_initial_admin_key` to see its [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) and follow the instructions to configure Soft Serve further. -Note that you have to [finish the configuration yourself](https://github.com/charmbracelet/soft-serve#configuration), otherwise any user with `soft_serve_initial_admin_key` will work as admin. +Note that you have to [finish the configuration yourself](https://github.com/charmbracelet/soft-serve#configuration), otherwise any user with `soft_serve_initial_admin_key` will work as an admin.