Skip to content

Commit

Permalink
Merge pull request #193 from sambarza/fix-example-ws-token
Browse files Browse the repository at this point in the history
The last backslash must not be there
  • Loading branch information
pieroit authored Oct 19, 2024
2 parents d4363f5 + 5e43607 commit 4ee9e08
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion mkdocs/production/administrators/env-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ By default, WebSocket endpoints are open to the public.
If you want to lock them down, set this environment variable, e.g. `CCAT_API_KEY_WS=meows`.

To pass the gate, call the WS endpoint using a `token` query parameter:
Example `ws://localhost:1865/ws/<user_id>/?token=<ccat_api_key_ws>`.
Example `ws://localhost:1865/ws/<user_id>?token=<ccat_api_key_ws>`.

Keep in mind that api keys are intended for machine-2-machine communication; If you are talking to the Cat from a browser, set the api keys to secure your installation, but only communicate with the Cat via JWT (TODO: insert JWT tutorial).

Expand Down

0 comments on commit 4ee9e08

Please sign in to comment.