49ec3aa2dc9143b2d4232510ffca32bfbcf7e78f

Message

docs: update readme (#360)

* docs: update readme in preparation of v0.6

* docs: add database section

Fixes: https://github.com/charmbracelet/soft-serve/issues/363

* docs: http auth

* fix: typos

Diff

This diff is truncated to protect this page.

 1diff --git a/README.md b/README.md
 2index bff43f38c7bf3a7e6005ce1870761c85f09fa872..9d7101df521c8fe9fe28f226c7eee7e1f448c26c 100644
 3--- a/README.md
 4+++ b/README.md
 5@@ -18,14 +18,17 @@ A tasty, self-hostable Git server for the command line. 🍦
 6 
 7 - Easy to navigate TUI available over SSH
 8 - Clone repos over SSH, HTTP, or Git protocol
 9+- Git LFS support with both HTTP and SSH backends
10 - Manage repos with SSH
11 - Create repos on demand with SSH or `git push`
12-- Browse repos, files and commits with SSH-accessible
13+- Browse repos, files and commits with SSH-accessible UI
14 - Print files over SSH with or without syntax highlighting and line numbers
15-- Easy access control with SSH
16+- Easy access control
17+  - SSH authentication using public keys
18   - Allow/disallow anonymous access
19   - Add collaborators with SSH public keys
20   - Repos can be public or private
21+  - User access tokens
22 
23 ## Where can I see it?
24 
25@@ -119,7 +122,7 @@ service units.
26 
27 [systemd]: https://github.com/charmbracelet/soft-serve/blob/main/systemd.md
28 
29-### Server Settings
30+### Server Configuration
31 
32 Once you start the server for the first time, the settings will be in
33 `config.yaml` under your data directory. The default `config.yaml` is
34@@ -190,6 +193,22 @@ http:
35   # Make sure to use https:// if you are using TLS.
36   public_url: "http://localhost:23232"
37 
38+# The database configuration.
39+db:
40+  # The database driver to use.
41+  # Valid values are "sqlite" and "postgres".
42+  driver: "sqlite"
43+  # The database data source name.
44+  # This is driver specific and can be a file path or connection string.
45+  data_source: "soft-serve.db"
46+
47+# Git LFS configuration.
48+lfs:
49+  # Enable Git LFS.
50+  enabled: true
51+  # Enable Git SSH transfer.
52+  ssh_enabled: true
53+
54 # The stats server configuration.
55 stats:
56   # The address on which the stats server will listen.
57@@ -210,10 +229,45 @@ name all in uppercase. Here are some examples:
58 - `SOFT_SERVE_HTTP_PUBLIC_URL`: HTTP public URL used for cloning
59 - `SOFT_SERVE_GIT_MAX_CONNECTIONS`: The number of simultaneous connections to git daemon
60 
61-## Configuration
62+#### Database Configuration
63+