Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to include interacting with Receptor via unix sockets #1212

Merged
merged 3 commits into from
Nov 20, 2024
Merged

Update docs to include interacting with Receptor via unix sockets #1212

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e4de93
Update docs to include interacting with Receptor via unix sockets
matoval Nov 16, 2024
8563248
Update doc
matoval Nov 16, 2024
25077b7
reword description
matoval Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/source/developer_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,21 @@ Receptor is an open source project that lives at `ansible/receptor repository <h

See the :ref:`contributing:contributing` for more general details.

---------
Debugging
---------

^^^^^^^^^^^
Unix Socket
^^^^^^^^^^^
To send commands to unix socket without receptorctl by using socat to send data to the receptor socket directly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you rephrase this a little please?

It seems a tricky sentence to read 😄


Example:

.. code-block:: bash

echo -e '{"command": "work", "subcommand": "submit", "node": "execution", "worktype": "cat", }\n"Hi"' | socat - UNIX-CONNECT:/tmp/control.sock

-------
Linters
-------
Expand Down