Skip to content

Commit fcf1096

Browse files
committed
Minor changes: updated requirements and readme
1 parent c3d419a commit fcf1096

File tree

3 files changed

+33
-18
lines changed

3 files changed

+33
-18
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,16 @@ In parallel, it:
7676

7777
## 🧱 Prerequisites
7878

79+
You will only need one of the following:
7980
* Python **3.11+**
8081
* Docker (optional, but recommended)
8182

8283
---
8384

8485
## 🔧 Installation
8586

87+
*Only needed if you want to run it locally with Python*
88+
8689
### Clone the Repository
8790

8891
```bash
@@ -95,6 +98,8 @@ cd s3dns
9598
(Using a virtual environment is recommended)
9699

97100
```bash
101+
python3 -m venv venv
102+
source venv/bin/activate
98103
pip install -r requirements.txt
99104
```
100105

@@ -110,6 +115,8 @@ Port 53 requires elevated privileges:
110115
sudo python s3dns.py
111116
```
112117

118+
*If the command with `sudo` claims missing a module, try using: `sudo venv/bin/python s3dns.py`*
119+
113120

114121
* If you build the image yourself, be sure to tag it the same as the Docker Hub version for consistency: `docker build -t ozimmermann/s3dns:latest .`
115122

@@ -120,22 +127,7 @@ sudo python s3dns.py
120127

121128
```bash
122129
docker pull ozimmermann/s3dns:latest
123-
```
124-
125-
When using S3DNS on the same machine where you perform analysis, it may help to set the `--network host` flag:
126-
127-
```bash
128130
docker run --rm -p 53:53/udp \
129-
-v "./bucket_findings/:/app/buckets/" \
130-
--network host \
131-
--name "s3dns" \
132-
ozimmermann/s3dns:latest
133-
```
134-
135-
Since port 53 requires elevated privileges, some users (e.g., Mac users) may need `sudo`:
136-
137-
```bash
138-
sudo docker run --rm -p 53:53/udp \
139131
-v "./bucket_findings/:/app/buckets/" \
140132
--name "s3dns" \
141133
ozimmermann/s3dns:latest
@@ -158,6 +150,25 @@ docker run --rm -p 53:53/udp \
158150
* In the **terminal**, and/or
159151
* In `./bucket_findings/`
160152

153+
### Troubleshooting
154+
When using S3DNS on the same machine where you perform analysis, it may help to set the `--network host` flag:
155+
156+
```bash
157+
docker run --rm -p 53:53/udp \
158+
-v "./bucket_findings/:/app/buckets/" \
159+
--network host \
160+
--name "s3dns" \
161+
ozimmermann/s3dns:latest
162+
```
163+
164+
Since port 53 requires elevated privileges, some users (e.g., Mac users) may need `sudo`:
165+
166+
```bash
167+
sudo docker run --rm -p 53:53/udp \
168+
-v "./bucket_findings/:/app/buckets/" \
169+
--name "s3dns" \
170+
ozimmermann/s3dns:latest
171+
```
161172

162173
---
163174

requirements.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1+
certifi==2025.8.3
2+
charset-normalizer==3.4.3
13
dnspython==2.7.0
2-
requests==2.32.3
4+
idna==3.10
35
ipaddress==1.0.23
4-
pyyaml==6.0
6+
PyYAML==6.0.2
7+
requests==2.32.5
8+
urllib3==2.5.0

s3dns.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
# configuration possible below
3030

31-
version = "0.1.0"
31+
version = "0.1.1"
3232
logo = r"""
3333
_____ ____ _____ _ _ _____ _____ _ _
3434
/ ____|___ \ | __ \| \ | |/ ____| | __ \ | | | |

0 commit comments

Comments
 (0)