generated from Ostorlab/template_agent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathostorlab.yaml
82 lines (62 loc) · 2.37 KB
/
ostorlab.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
kind: Agent
name: nebula
version: 0.1.1
image: images/logo.png
description: |
_The Nebula Agent is responsible for persisting all types of messages locally._
## Getting Started
To perform your first scan, simply run the following command:
```shell
ostorlab scan run --install --agent agent/ostorlab/nebula link --url www.yourdomain.com --method GET
```
This command will download and install `agent/ostorlab/nebula` and target `www.yourdomain.com` with the `GET` method.
For more information, please refer to the [Ostorlab Documentation](https://github.com/Ostorlab/ostorlab/blob/main/README.md)
## Usage
Agent Nebula can be installed directly from the ostorlab agent store or built from this repository.
### Install directly from ostorlab agent store
```shell
ostorlab agent install agent/ostorlab/nebula
```
You can then run the agent with the following command:
```shell
ostorlab scan run --agent agent/ostorlab/nebula link --url www.yourdomain.com --method GET
```
### Build directly from the repository
1. To build nebula agent you need to have [ostorlab](https://pypi.org/project/ostorlab/) installed in your machine. If you have already installed ostorlab, you can skip this step.
```shell
pip3 install ostorlab
```
2. Clone this repository.
```shell
git clone https://github.com/Ostorlab/agent_nebula.git && cd agent_nebula
```
3. Build the agent image using ostorlab cli.
```shell
ostorlab agent build --file=ostorlab.yaml
```
You can pass the optional flag `--organization` to specify your organisation. The organization is empty by default.
4. Run the agent using on of the following commands:
* If you did not specify an organization when building the image:
```shell
ostorlab scan run --agent agent//nebula ip 8.8.8.8
```
* If you specified an organization when building the image:
```shell
ostorlab scan run --agent agent/[ORGANIZATION]/nebula link --url www.yourdomain.com --method GET
```
### License
[Apache-2.0](./LICENSE)
license: Apache-2.0
source: https://github.com/Ostorlab/agent_nebula
in_selectors:
- v3
out_selectors: []
docker_file_path : Dockerfile
docker_build_root : .
mounts:
- '$CONFIG_HOME/:/output/'
args:
- name: "file_type"
type: "string"
description: "The type of the file where the message will be persisted."
value: "json"