1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
adenosine-pds(1) "adenosine PDS Server Manual Page"
# NAME
adenosine-pds: small-world atproto.com Personal Data Server
# SYNOPSIS
adenosine-pds [OPTIONS] <COMMAND> <ARGS>
# DESCRIPTION
This is a simple, enthusiast-grade AT Protocol (atproto.com) personal data
server ("PDS") implementation. It targets "small-world" uses cases of the
protocol, for example personal or organizational self-hosting.
This is a work-in-progress, is not spec-compliant, will not be
backwards/forwards compatible, and does not have an upgrade/migration path.
# COMMANDS
*generate-secret*
Creates a new random secret key for PDS use
*serve* [OPTIONS]
Runs the server. See options below
*import* <car-path> [--alias <alias>]
Loads a CAR file into the repository blockstore
*inspect*
Prints information about repositories in the blockstore (likely to deprecate)
# OPTIONS
*-h, --help*
Prints help information
*-V, --version*
Prints version information
*-v, --verbose*
Pass many times for more log output
By default, it'll only report errors. Passing `-v` one time also prints warnings, `-vv` enables info logging, `-vvv` debug, and `-vvvv` trace.
*--atp-db <path>* [env: ATP_ATP_DB]
File path of sqlite database holding system/application data
*--block-db <path>* [env: ATP_BLOCK_DB]
File path of sqlite database holding repository data (blockstore)
## SERVE OPTIONS
*--homepage-handle <homepage-handle>* [env: ATP_PDS_HOMEPAGE_HANDLE]
Optionally, override domain name check and force the homepage to display the account page for this handle
*--invite-code <invite-code>* [env: ATP_PDS_INVITE_CODE]
Optionally, require an invite code to sign up. This is just a single secret value
*--pds-secret-key <pds-secret-key>* [env: ATP_PDS_SECRET_KEY]
Secret key, encoded in hex. Use 'generate-secret' to create a new one
*--port <port>* [env: ATP_PDS_PORT] [default: 3030]
Localhost port to listen on
*--public-url <public-url>* [env: ATP_PDS_PUBLIC_URL]
A "public URL" for the PDS gets embedded in DID documents. If one is not
provided, a localhost value will be used, which will not actually work for
inter-PDS communication
*--registration-domain <registration-domain>* [env: ATP_PDS_REGISTRATION_DOMAIN]
If provided, allow registration for the given base domain name
# GETTING STARTED
TODO
|
