You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -41,13 +41,13 @@ Luminaut is a framework that assembles tools and APIs commonly used to understan
41
41
The docker image is available on GitHub, you can pull it locally by running:
42
42
43
43
```bash
44
-
$ docker pull ghcr.io/luminaut-org/luminaut
44
+
docker pull ghcr.io/luminaut-org/luminaut
45
45
```
46
46
47
47
If you would like to run it locally with just the name `luminaut`, you can then run:
48
48
49
49
```bash
50
-
$ docker tag ghcr.io/luminaut-org/luminaut luminaut:latest
50
+
docker tag ghcr.io/luminaut-org/luminaut luminaut:latest
51
51
```
52
52
53
53
For development, clone the repository and run `docker build --tag luminaut:latest` to build the container.
@@ -93,13 +93,13 @@ options:
93
93
By default, Luminaut will run all available tools. It requires your AWS profile to be configured with the necessary permissions, otherwise the first step of public IP detection on ENIs will fail.
94
94
95
95
```bash
96
-
$ luminaut
96
+
luminaut
97
97
```
98
98
99
99
The AWS Config scanner takes at least 50 seconds to run per resource type. If you would like to disable this, you can do so as shown in the provided `configs/disable_aws_config.toml` configuration file. You can provide this configuration with `-c configs/disable_aws_config.toml`.
100
100
101
101
```bash
102
-
$ luminaut -c configs/disable_aws_config.toml
102
+
luminaut -c configs/disable_aws_config.toml
103
103
```
104
104
105
105
Similarly, if you'd like to enable Shodan, you will need to specify a configuration file that includes the Shodan API key. See the [Configuration](#configuration) section for more information on the configuration file specification.
@@ -110,12 +110,12 @@ You may run luminaut with docker by mounting the configuration file and running
110
110
111
111
Bash, zsh, and similar terminals:
112
112
```bash
113
-
$ docker run -it -v ~/.aws:/home/app/.aws -v $(pwd)/configs:/app/configs luminaut --help
113
+
docker run -it -v ~/.aws:/home/app/.aws -v $(pwd)/configs:/app/configs luminaut --help
114
114
```
115
115
116
116
Powershell:
117
117
```powershell
118
-
$ docker run -it -v $env:USERPROFILE\.aws:/home/app/.aws -v ${PWD}\configs:/app/configs luminaut --help
118
+
docker run -it -v $env:USERPROFILE\.aws:/home/app/.aws -v ${PWD}\configs:/app/configs luminaut --help
0 commit comments