Added Getting Started Page for the Remote API #237
Open
erik-graf wants to merge 1 commit into
Open
Conversation
…ote_config.rst to port actually used by default
whotwagner
requested changes
May 26, 2026
|
|
||
| * AttackMate installed on the server. | ||
| * attackmate-api-server installed and running on the server. | ||
| * attackmate-client installed on the client. |
Contributor
There was a problem hiding this comment.
why is an attackmate-client required?
| remote_config: | ||
| remote_server: | ||
| url: "https://10.0.0.5:5000" | ||
| attackmate-server: |
Contributor
There was a problem hiding this comment.
is there any specific reason for changing the name?
| * `attackmate-api-server <https://github.com/ait-testbed/attackmate-api-server>`__: | ||
| runs on the remote AttackMate host and exposes an HTTPS API. | ||
| * `attackmate-client <https://github.com/ait-testbed/attackmate-client>`__: | ||
| runs on the local/client host and sends commands or playbooks to the API |
Contributor
There was a problem hiding this comment.
specify what the client is and when it is required.
Comment on lines
+36
to
+37
| It is recommended to install AttackMate on the client too. This allows the | ||
| client to parse local wrapper playbooks and use the normal ``attackm8`` command. |
Contributor
There was a problem hiding this comment.
I would describe when to install just the attackmate-client and when to install the attackmate instead. It is not recommended to install AttackMate and the Client.
|
|
||
| uv run attackm8 --debug remote_wrapper.yml | ||
|
|
||
| The client should log in to the API server, send the referenced playbook, and |
Contributor
There was a problem hiding this comment.
Suggested change
| The client should log in to the API server, send the referenced playbook, and | |
| The local attackmate should log in to the remote API server, send the referenced playbook, and |
Comment on lines
+144
to
+149
| The systemd service logs are available with: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| journalctl -u attackmate-api -f | ||
|
|
Contributor
There was a problem hiding this comment.
where did you explain how to install attackmate-api using systemd?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added Getting Started Documentation for the Remote API.
Changed default port number in remote_config.rst doc.