Skip to content

Commit 58b18a2

Browse files
committed
HOSTING: add some WebSocket notes
1 parent 4d66e7b commit 58b18a2

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

HOSTING.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ In your cloud provider's console, the following ports should be open to inbound
4545
- 80/tcp (Used only for TLS certification verification)
4646
- 443/tcp (Used for all application requests)
4747

48+
Note that WebSockets (over HTTPS) will be used to pull labels from your Ozone instance in to the network.
49+
4850
> [!TIP]
4951
> There is no need to set up TLS or redirect requests from port 80 to 443 because the Caddy web server, included in the Docker compose file, will handle this for you.
5052
@@ -153,6 +155,9 @@ sudo mkdir --parents /ozone/caddy/etc/caddy
153155

154156
#### Create the Caddyfile
155157

158+
> [!TIP]
159+
> The most common problems with getting Ozone labels consumed in the live network are when folks substitute the supported Caddy configuration for manual nginx, apache, or similar reverse proxies. Getting TLS certificates, WebSockets, and virtual server names all correct can be tricky. We are not currently providing tech support for other configurations.
160+
156161
Be sure to replace `ozone.example.com` with your own domain.
157162

158163
```bash
@@ -287,10 +292,18 @@ sudo docker ps
287292
You can check if your server is online and healthy by requesting the healthcheck endpoint, and by visiting the UI in browser at https://ozone.example.com/.
288293

289294
```bash
290-
curl https://ozone.example.com/xrpc/_health
291-
{"version":"0.2.2-beta.2"}
295+
curl https://ozone.EXAMPLE.COM/xrpc/_health
296+
{"version":"0.1.1"}
297+
```
298+
299+
You can check that the WebSocket label stream is working with the command:
300+
301+
```bash
302+
wsdump "wss://ozone.EXAMPLE.COM/xrpc/com.atproto.label.subscribeLabels?cursor=0"
292303
```
293304

305+
Note that there will be no labels output on the WebSocket until they are created in Ozone, so the above command may continue to run with no output if things are configured successfully.
306+
294307
### Announcing Ozone to the network
295308

296309
Once you've successfully started running your service, there is a final step to make the rest of the network aware of it, so that users can find your labeler in the Bluesky app and so that Bluesky can consume the labels that you publish. This step can be completed from within the Ozone UI.

0 commit comments

Comments
 (0)