Mirror/intercept
1
0
Fork 0
mirror of https://github.com/smittix/intercept.git synced 2026-07-04 15:53:39 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: add sudo to start.sh usage comments and USAGE.md examples

Browse Source 
All other docs already reference sudo ./start.sh but the inline usage
comments in start.sh itself and the --help example in USAGE.md were
missing it, which could lead users to run without root privileges.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Smittix
2026-02-28 17:51:02 +00:00
parent a6e62f4674
commit bcbadac995
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/USAGE.md
+3 -1
View File
@@ -525,7 +525,7 @@ Example: `INTERCEPT_PORT=8080 sudo ./start.sh`
### Production server (recommended) ### Production server (recommended)
``` ```
./start.sh --help sudo ./start.sh --help
-p, --port PORT Port to listen on (default: 5050) -p, --port PORT Port to listen on (default: 5050)
-H, --host HOST Host to bind to (default: 0.0.0.0) -H, --host HOST Host to bind to (default: 0.0.0.0)
@@ -534,6 +534,8 @@ Example: `INTERCEPT_PORT=8080 sudo ./start.sh`
--check-deps Check dependencies and exit --check-deps Check dependencies and exit
``` ```
> **Note:** `sudo` is required for SDR hardware access, WiFi monitor mode, and Bluetooth low-level operations.
`start.sh` auto-detects gunicorn + gevent and runs a production WSGI server with cooperative greenlets — this handles multiple SSE streams and WebSocket connections concurrently without blocking. Falls back to the Flask dev server if gunicorn is not installed. `start.sh` auto-detects gunicorn + gevent and runs a production WSGI server with cooperative greenlets — this handles multiple SSE streams and WebSocket connections concurrently without blocking. Falls back to the Flask dev server if gunicorn is not installed.
### Development server ### Development server
start.sh
+7 -5
View File
@@ -4,12 +4,14 @@
# Starts INTERCEPT with gunicorn + gevent for production use. # Starts INTERCEPT with gunicorn + gevent for production use.
# Falls back to Flask dev server if gunicorn is not installed. # Falls back to Flask dev server if gunicorn is not installed.
# #
# Requires sudo for SDR, WiFi monitor mode, and Bluetooth access.
#
# Usage: # Usage:
# ./start.sh # Default: 0.0.0.0:5050 # sudo ./start.sh # Default: 0.0.0.0:5050
# ./start.sh -p 8080 # Custom port # sudo ./start.sh -p 8080 # Custom port
# ./start.sh --https # HTTPS with self-signed cert # sudo ./start.sh --https # HTTPS with self-signed cert
# ./start.sh --debug # Debug mode (Flask dev server) # sudo ./start.sh --debug # Debug mode (Flask dev server)
# ./start.sh --check-deps # Check dependencies and exit # sudo ./start.sh --check-deps # Check dependencies and exit
set -euo pipefail set -euo pipefail