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

Jump to bottom

[docs] Update Imix Docs #512

Merged
merged 1 commit into from
Jan 27, 2024
Merged

[docs] Update Imix Docs #512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 3 additions & 33 deletions docs/_docs/user-guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,15 @@ description: Getting started with Realm
permalink: user-guide/getting-started
---

# Getting Started
## Getting Started

*To deploy a production ready instance see the [tavern setup guide](https://docs.realm.pub/user-guide/tavern).*

### Start the server

```bash
git clone https://github.com/spellshift/realm.git
cd realm
go run ./tavern
cd realm && go run ./tavern

# If you'd like to test without deploying an agent use the test data.
ENABLE_TEST_DATA=1 go run ./tavern
Expand All @@ -25,36 +24,7 @@ ENABLE_TEST_DATA=1 go run ./tavern

```bash
git clone https://github.com/spellshift/realm.git
cd realm/implants/imix

# Create the config file
cat <<EOF > /tmp/imix-config.json
{
"service_configs": [
{
"name": "imix",
"description": "Imix c2 agent",
"executable_name": "imix",
"executable_args": ""
}
],
"target_forward_connect_ip": "127.0.0.1",
"target_name": "test1234",
"callback_config": {
"interval": 4,
"jitter": 1,
"timeout": 4,
"c2_configs": [
{
"priority": 1,
"uri": "http://127.0.0.1/grpc/"
}
]
}
}
EOF

cargo run -- -c /tmp/imix-config.json
cd realm/implants/imix && cargo run
```

Want to work with the API? Check out the [sample queries](https://docs.realm.pub/dev-guide/tavern#graphql-api)
17 changes: 2 additions & 15 deletions docs/_docs/user-guide/imix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,10 @@ The install subcommand executes embedded tomes similar to golem.
It will loop through all embedded files looking for main.eldritch.
Each main.eldritch will execute in a new thread. This is done to allow imix to install redundantly or install additional (non dependent) tools.

The install subcommand allows some variables to be passed from the user into the tomes through the -c flag.
When specified input_params['custom_config'] is set to the file path of the config specified Eg.
./imix install -c /tmp/imix-config.json will result in input_params['custom_config'] = "/tmp/imix-config.json

Tomes can parse this with the following:

```python
def main():
if 'custom_config' in input_params:
config_data = crypto.from_json(file.read(input_params['custom_config']))
print(config_data)

main()
```

Installation scripts are specified in the `realm/implants/imix/install_scripts` directory.

This feature is currently under active development, and may change. We'll do our best to keep these docs updates in the meantime.

## Functionality

Imix derives all it's functionality from the eldritch language.
Expand Down
Loading