Skip to content

Commit 4d7b244

Browse files
blink-so[bot]f0ssel
andcommitted
remove installation prerequisites and TLS interception sections from README
Simplified README by removing detailed sections: ## Removed Installation Prerequisites - Linux kernel version requirements - iptables/pfctl dependencies - Go version requirements - sudo access notes ## Removed TLS Interception Section - CA certificate storage details - Environment variable explanations - Certificate generation process - Usage examples with --no-tls-intercept ## Kept Essential Information - --no-tls-intercept flag in command-line options (without description) - Core functionality and usage examples - Installation and development instructions Rationale: Users will discover missing dependencies when they try to use the tool. TLS interception details are implementation specifics that users don't need to understand upfront. The README is now more focused and less intimidating for new users. Co-authored-by: f0ssel <[email protected]>
1 parent 44912b8 commit 4d7b244

File tree

1 file changed

+0
-31
lines changed

1 file changed

+0
-31
lines changed

README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -154,22 +154,6 @@ sudo mv jail /usr/local/bin/
154154

155155
### Build from Source
156156

157-
#### Prerequisites
158-
159-
**Linux:**
160-
- Linux kernel 3.8+ (network namespace support)
161-
- iptables
162-
- Go 1.25+ (for building)
163-
- sudo access
164-
165-
**macOS:**
166-
- macOS 10.15+ (Catalina or later)
167-
- pfctl (included)
168-
- Go 1.25+ (for building)
169-
- sudo access
170-
171-
#### Building
172-
173157
```bash
174158
git clone https://github.com/coder/jail
175159
cd jail
@@ -181,21 +165,6 @@ make build
181165
go build -o jail .
182166
```
183167

184-
## TLS Interception
185-
186-
jail automatically generates a Certificate Authority (CA) to intercept HTTPS traffic:
187-
188-
- CA stored in `~/.config/jail/` (or `$XDG_CONFIG_HOME/jail/`)
189-
- CA certificate provided via `JAIL_CA_CERT` environment variable
190-
- Certificates generated on-demand for intercepted domains
191-
- CA expires after 1 year
192-
193-
### Disable TLS Interception
194-
195-
```bash
196-
jail --no-tls-intercept --allow "*" -- ./app
197-
```
198-
199168
## Command-Line Options
200169

201170
```text

0 commit comments

Comments
 (0)