Skip to content

Commit 64a8283

Browse files
docs: Add single-user mode section to README
1 parent a245fe4 commit 64a8283

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A minimal, fast, JSON-LD native Solid server.
66

77
## Features
88

9-
### Implemented (v0.0.78)
9+
### Implemented (v0.0.79)
1010

1111
- **Schnorr SSO** - Passwordless login via BIP-340 Schnorr signatures using NIP-07 browser extensions (Podkey, nos2x, Alby)
1212
- **Passkey Authentication** - WebAuthn/FIDO2 passwordless login with Touch ID, Face ID, or security keys
@@ -181,6 +181,31 @@ Then: `jss start --config config.json`
181181

182182
### Creating a Pod
183183

184+
### Single-User Mode
185+
186+
For personal pod servers where only one user needs access:
187+
188+
```bash
189+
# Basic single-user mode (creates pod at /me/)
190+
jss start --single-user --idp
191+
192+
# Custom username
193+
jss start --single-user --single-user-name alice --idp
194+
195+
# Root-level pod (pod at /, WebID at /profile/card#me)
196+
jss start --single-user --single-user-name '' --idp
197+
198+
# Via environment
199+
JSS_SINGLE_USER=true jss start --idp
200+
```
201+
202+
**Features:**
203+
- Pod auto-created on first startup with full structure (inbox, public, private, profile, Settings)
204+
- Registration endpoint disabled (returns 403)
205+
- Login still works for the single user
206+
- Proper ACLs generated automatically
207+
208+
184209
```bash
185210
curl -X POST http://localhost:3000/.pods \
186211
-H "Content-Type: application/json" \
@@ -694,7 +719,7 @@ jss start --idp
694719

695720
Passkeys are stored per-account and work across devices via platform sync (iCloud Keychain, Google Password Manager, etc.).
696721

697-
### Schnorr SSO (v0.0.78+)
722+
### Schnorr SSO (v0.0.79+)
698723

699724
Sign in with your Nostr key using NIP-07 browser extensions:
700725

0 commit comments

Comments
 (0)