smokesignal.events
The smokesignal.events web application
documentation: Updating README and example launch config
+20
-6
.vscode/launch.example.json
+20
-6
.vscode/launch.example.json
···
18
18
"args": [],
19
19
"cwd": "${workspaceFolder}",
20
20
"env": {
21
+
"ADMIN_DIDS": "",
22
+
"AIP_CLIENT_ID": "PLACEHOLDER",
23
+
"AIP_CLIENT_SECRET": "PLACEHOLDER",
24
+
"AIP_HOSTNAME": "auth.smokesignal.events",
25
+
"CONTENT_STORAGE": "/path/to/content/storage/",
26
+
"DATABASE_URL": "postgresql://smokesignal:smokesignal_dev_password@localhost:5436/smokesignal_dev",
21
27
"DEBUG": "true",
28
+
"DESTINATION_KEY": "did:key:z42tzxqTPLACEHOLDER",
29
+
"ENABLE_OPENSEARCH": "false",
30
+
"ENABLE_TASK_OAUTH_REQUESTS_CLEANUP": "false",
31
+
"ENABLE_TASK_OPENSEARCH": "false",
32
+
"ENABLE_TASK_WEBHOOKS": "false",
33
+
"ENABLE_WEBHOOKS": "false",
34
+
"EXTERNAL_BASE": "smokesignal.tunn.dev",
35
+
"HTTP_COOKIE_KEY": "PLACEHOLDER",
22
36
"HTTP_PORT": "3100",
23
-
"EXTERNAL_BASE": "yourhostname",
24
-
"HTTP_COOKIE_KEY": "7omSYPNPwxT2gZPf0sQ51kPhaWKAqBu22M0j2il81LyIWP79jR4lrS1rBRX5ZIQS9qxATh469XL0k4G8c67r+A",
25
-
"OAUTH_ACTIVE_KEYS": "01JV8430MGTTA692WBYFGRMWRG",
26
-
"DESTINATION_KEY": "01JV8430MGTTA692WBYFGRMWRG",
27
-
"SIGNING_KEYS": "eyJrZXlzIjpbeyJraWQiOiIwMUpWODQzME1HVFRBNjkyV0JZRkdSTVdSRyIsImFsZyI6IkVTMjU2Iiwia3R5IjoiRUMiLCJjcnYiOiJQLTI1NiIsIngiOiJYb3dFbHpXMFhTeXVXUWJOaVFpTDFmbm9RQlhZRmkwWk9BQ2U3S3JONU1jIiwieSI6IkFXLWpFNWYtcXNZYVBoRFhCUUNuNjVCaVRKRWtJRVEzYXFONXV2b1U1TkkiLCJkIjoiNXNvT2RZWko2MzVoWnJWMmlRcFgya1dPR19wdFB0eHJVN1J4eFFaUTNJSSJ9XX0K",
28
-
"RUST_LOG": "smokesignal=debug,html5ever=info,info"
37
+
"OAUTH_BACKEND": "pds",
38
+
"OPENSEARCH_ENDPOINT": "https://your.opensearch.endpoint.local",
39
+
"RUST_BACKTRACE": "1",
40
+
"RUST_LOG": "smokesignal=debug,html5ever=info,info",
41
+
"SERVICE_KEY": "did:key:z42tikyfPLACEHOLDER",
42
+
"SIGNING_KEYS": "did:key:z42tj1piPLACEHOLDER"
29
43
}
30
44
}
31
45
]
+8
-12
README.md
+8
-12
README.md
···
96
96
#### For PDS OAuth (default):
97
97
```bash
98
98
OAUTH_BACKEND=pds
99
-
SIGNING_KEYS=/path/to/keys.json
99
+
SIGNING_KEYS=did:key:foobarbaz
100
100
```
101
101
102
102
#### For AIP OAuth:
···
134
134
135
135
```bash
136
136
# Generate HTTP cookie key
137
-
cargo run --bin crypto -- key
137
+
$ cargo run --bin crypto -- key
138
138
139
-
# Generate JWK for OAuth signing
140
-
cargo run --bin crypto -- jwk
141
-
```
139
+
# Generate a private key OAuth signing
140
+
$ goat key generate -t p256
141
+
Key Type: P-256 / secp256r1 / ES256 private key
142
+
Secret Key (Multibase Syntax): save this securely (eg, add to password manager)
143
+
z42tmsxs...
142
144
143
-
Create a `keys.json` file with your JWKs:
144
-
```json
145
-
{
146
-
"keys": [
147
-
{ "kid": "01J7PM272ZF0DYZAPR3499VBTM", ... }
148
-
]
149
-
}
145
+
export SIGNING_KEYS=did:key:z42tmsxs...
150
146
```
151
147
152
148
## Running the Application