hosting/mash-playbook
1
0
Fork 0
Code Pull requests Activity

Update soft-serve.md

Browse source
This commit is contained in:
Slavi Pantaleev 2023-03-28 16:47:07 +03:00 committed by GitHub
parent 5b9800e70b
commit a513f04215
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/services/soft-serve.md
View file

@ -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.