External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-01-09 23:12:08 -03:30
Code Issues Packages Projects Releases Wiki Activity

Update websockets.md

Browse Source 
- specify that the websockets are not meant for external usage/3rd party clients (see #10764)
- add a the missing slash at the '/websocket/' URL
This commit is contained in:
Georgi Baychev 2021-09-29 13:55:12 +02:00 committed by GitHub
parent b9ecf389c2
commit 1338aef2bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/websockets.md
View File

@ -1,6 +1,6 @@
# Channels Overview
Our channels/websocket implementation handles the communication between AWX API and updates in AWX UI.
Our channels/websocket implementation handles the communication between AWX API and updates in AWX UI. Note that the websockets are not meant for external use and 3rd party clients.
## Architecture
@ -34,7 +34,7 @@ Upon receiving the payload, AWX decrypts the `secret` header using the known sha
## Protocol
You can connect to the AWX channels implementation using any standard websocket library by pointing it to `/websocket`. You must
You can connect to the AWX channels implementation using any standard websocket library by pointing it to `/websocket/`. You must
provide a valid Auth Token in the request URL.
Once you've connected, you are not subscribed to any event groups. You subscribe by sending a `json` request that looks like the following: