Skip to content

Commit a289965

Browse files
Update docs: RS requires --activitypub for discovery and OAuth
Storage routes are always on, but WebFinger and OAuth are currently inside the AP plugin. Tracked in JavaScriptSolidServer#164 for standalone extraction.
1 parent 33e069b commit a289965

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A minimal, fast, JSON-LD native Solid server.
2020
- **ActivityPub Federation** - Fediverse integration with WebFinger, inbox/outbox, HTTP signatures
2121
- **Mastodon-compatible API** - Dynamic client registration, instance info, account verification
2222
- **OAuth 2.0 Authorization** - Shared auth flow for Mastodon clients, remoteStorage apps, and third-party panes
23-
- **remoteStorage Protocol** - [draft-dejong-remotestorage-22](https://remotestorage.io/spec/) file sync — always on, no flag needed
23+
- **remoteStorage Protocol** - [draft-dejong-remotestorage-22](https://remotestorage.io/spec/) file sync (requires `--activitypub` for WebFinger discovery + OAuth)
2424
- **LDP CRUD Operations** - GET, PUT, POST, DELETE, HEAD
2525
- **N3 Patch** - Solid's native patch format for RDF updates
2626
- **SPARQL Update** - Standard SPARQL UPDATE protocol for PATCH
@@ -602,7 +602,11 @@ curl http://localhost:3000/api/v1/instance
602602

603603
## remoteStorage
604604

605-
JSS implements the [remoteStorage protocol](https://remotestorage.io/spec/draft-dejong-remotestorage-22) — always on, no flag needed. Any remoteStorage-compatible app can store and sync data on your pod.
605+
JSS implements the [remoteStorage protocol](https://remotestorage.io/spec/draft-dejong-remotestorage-22). The storage routes are always available, but WebFinger discovery and OAuth require `--activitypub` (which provides the WebFinger and OAuth endpoints). Any remoteStorage-compatible app can store and sync data on your pod.
606+
607+
```bash
608+
jss start --activitypub --idp
609+
```
606610

607611
### Discovery
608612

0 commit comments

Comments
 (0)