Skip to content

Commit

Permalink
tidy, docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
devinivy committed Feb 26, 2024
1 parent ed97d0a commit 5a60f5d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
3 changes: 3 additions & 0 deletions packages/bsky/src/data-plane/server/subscription/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ export class PerfectMap<K, V> extends Map<K, V> {
export type ProcessableMessage =
| message.Commit
| message.Handle
| message.Identity
| message.Migrate
| message.Tombstone

Expand All @@ -127,6 +128,8 @@ export function loggableMessage(msg: RepoMessage) {
}
} else if (message.isHandle(msg)) {
return msg
} else if (message.isIdentity(msg)) {
return msg
} else if (message.isMigrate(msg)) {
return msg
} else if (message.isTombstone(msg)) {
Expand Down
13 changes: 8 additions & 5 deletions services/bsky/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,18 @@ This is the service entrypoint for the bsky appview. The entrypoint command shou
- `BSKY_DID_PLC_URL` - (required) the url of the PLC service used for looking up did documents, e.g. `https://plc.directory`.
- `BSKY_DATAPLANE_URL` - (required) the url where the backing dataplane service lives.
- `BSKY_SERVICE_SIGNING_KEY` - (required) the public signing key in the form of a `did:key`, used for service-to-service auth. Advertised in the appview's `did:web`` document.
- `BSKY_ADMIN_PASSWORD` - (required) the admin password used for role-based auth.
- `BSKY_ADMIN_PASSWORDS` - (alt. `BSKY_ADMIN_PASSWORD`) (required) comma-separated list of admin passwords used for role-based auth.
- `NODE_ENV` - (recommended) for production usage, should be set to `production`. Otherwise all responses are validated on their way out. There may be other effects of not setting this to `production`, as dependencies may also implement debug modes based on its value.
- `BSKY_VERSION` - (recommended) version of the bsky service. This is advertised by the health endpoint.
- `BSKY_PORT` - (recommended) the port that the service will run on.
- `BSKY_IMG_URI_ENDPOINT` - (recommended) the base url for resized images, e.g. `https://cdn.bsky.app/img`. When not set, sets-up an image resizing service directly on the appview.
- `BSKY_SERVER_DID` - (recommended) the did of the appview service. When this is a `did:web` that matches the appview's public url, a `did:web` document is served.
- `BSKY_FEED_PUBLISHER_DID` - indicates the publisher did of any feedgen records which the appview supports.
- `BSKY_FEED_GEN_DID` - the did of the appview's feed generator service. When present the appview implements `app.bsky.feed.describeFeedGenerator`.
- `BSKY_HANDLE_RESOLVE_NAMESERVERS` - alternative domain name servers used for handle resolution, comma-separated.
- `BSKY_BLOB_CACHE_LOC` - when `BSKY_IMG_URI_ENDPOINT` is not set, this determines where resized blobs are cached by the image resizing service.
- `BSKY_MODERATOR_PASSWORD` - the moderator password used for role-based auth.
- `BSKY_TRIAGE_PASSWORD` - the triage password used for role-based auth.
- `BSKY_COURIER_URL` - URL of courier service.
- `BSKY_COURIER_API_KEY` - API key for courier service.
- `BSKY_BSYNC_URL` - URL of bsync service.
- `BSKY_BSYNC_API_KEY` - API key for bsync service.
- `BSKY_SEARCH_URL` - (alt. `BSKY_SEARCH_ENDPOINT`) -
- `BSKY_LABELS_FROM_ISSUER_DIDS` - comma-separated list of labelers to always use for record labels.
- `MOD_SERVICE_DID` - the DID of the mod service, used to receive service authed requests.

0 comments on commit 5a60f5d

Please sign in to comment.