Skip to content

Commit

Permalink
Add example config to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
meowgorithm authored and Toby Padilla committed Oct 13, 2021
1 parent 5c0bb15 commit de72557
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,53 @@ Make sure `git` is installed, then run `soft`. That’s it.

## Configuration

The Soft Serve configuration is simple and straightforward:

```yaml
# The name of the server to show in the TUI.
name: Soft Serve

# The host and port to listen on. Defaults to 0.0.0.0:23231.
host: localhost
port: 23231

# The access level for anonymous users. Options are: read-write, read-only
# and no-access.
anon-access: read-write

# You can grant read-only access to users without private keys.
allow-keyless: false

# Which repos should appear in the menu?
repos:
- name: Home
repo: config
private: true
note: "Configuration and content repo for this server"
- name: Example Public Repo
repo: my-public-repo
private: false
note: "A publicly-accessible repo"
- name: Example Public Repo
repo: my-private-repo
private: true
note: "A private repo"

# Authorized users. Admins have full access to all repos. Regular users
# can read all repos and push to their collab-repos.
users:
- name: Beatrice
admin: true
public-key:
KEY TEXT
- name: Frankie
collab-repos:
- my-public-repo
- my-private-repo
public-key:
KEY TEXT
```
When `soft` is run for the first time, it creates a configuration repo
containing the main README displayed in the TUI as well as a config file for
user access control.
Expand Down

0 comments on commit de72557

Please sign in to comment.