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
+2-29
Original file line number
Diff line number
Diff line change
@@ -63,46 +63,19 @@ While focused on AWS, Luminaut can be extended to support other cloud providers
63
63
64
64
## Installation
65
65
66
-
### via python
67
-
68
66
Luminaut is available on PyPI and can be installed with pip:
69
67
70
68
```bash
71
69
pip install luminaut
72
70
```
73
71
74
-
You can also download a release artifact from the [GitHub releases page](https://github.com/luminaut-org/luminaut/releases) and install it with pip.
75
-
76
-
Once installed, you can run luminaut from the command line.
77
-
78
-
```bash
79
-
luminaut --help
80
-
```
81
-
82
-
**Note:** Luminaut requires Python 3.11 or later. If you would like to leverage nmap or whatweb, you will need to install these tools separately.
83
-
84
-
### via docker
85
-
86
-
The docker image is available on GitHub, you can pull it locally by running:
72
+
There is also a docker image available on GitHub, you can pull it locally by running:
87
73
88
74
```bash
89
75
docker pull ghcr.io/luminaut-org/luminaut
90
76
```
91
77
92
-
If you would like to run it locally with just the name `luminaut`, you can then run:
93
-
94
-
```bash
95
-
docker tag ghcr.io/luminaut-org/luminaut luminaut:latest
96
-
```
97
-
98
-
For development, clone the repository and run `docker build --tag luminaut:latest` to build the container.
99
-
100
-
You can then run the container with:
101
-
102
-
```bash
103
-
docker run -it luminaut --help
104
-
```
105
-
78
+
Additional installation information is available within the [Luminaut documentation](https://luminaut-org.github.io/luminaut/installation.html)
0 commit comments