clean README

This commit is contained in:
Domingo Dirutigliano
2025-08-04 13:29:58 +02:00
parent 23e6d2a90c
commit 81f5ea817a

View File

@@ -69,46 +69,6 @@ All the configuration at the startup is customizable in [firegex.py](./start.py)
- Port Hijacking allows you to redirect the traffic on a specific port to another port. Thanks to this you can start your own proxy, connecting to the real service using the loopback interface. Firegex will be resposable about the routing of the packets using internally [nftables](https://netfilter.org/projects/nftables/)
- EXPERIMENTAL: Netfilter Proxy uses [nfqueue](https://netfilter.org/projects/libnetfilter_queue/) to simulate a python proxy, you can write your own filter in python and use it to filter the traffic. There are built-in some data handler to parse protocols like HTTP, and before apply the filter you can test it with fgex command (you need to install firegex lib from pypi).
## Deployment Modes
### Docker Mode
The default and recommended deployment method using Docker containers. Provides complete isolation and easy management.
### Standalone Mode
When Docker is not available or when running in environments where Docker cannot be used (e.g., rootless containers, restricted environments), Firegex can run in standalone mode.
**How Standalone Mode Works:**
1. **Automatic Detection**: If Docker is unavailable or in rootless mode, standalone mode is automatically enabled
2. **Rootfs Download**: Downloads pre-built filesystem archives from GitHub releases based on your architecture
3. **Chroot Environment**: Creates an isolated chroot environment with necessary system mounts
4. **Daemon Process**: Runs as a background daemon with PID management
5. **Process Control**: Provides start/stop/status commands for service management
**Standalone Mode Commands:**
```bash
# Start (automatically detects if standalone needed)
python3 start.py start
# Force standalone mode
python3 start.py --standalone start
# Check if running
python3 start.py status
# Stop the service
python3 start.py stop
# Clean up rootfs (removes downloaded files)
python3 start.py --clear-standalone
```
**Technical Details:**
- Downloads `firegex-rootfs-{arch}.tar.gz` from latest GitHub release
- Creates chroot environment in `~/.firegex/rootfs/`
- Bind mounts `/dev`, `/proc`, and network configuration files
- Manages daemon process with PID file in `~/.firegex/firegex.pid`
- Automatically handles privilege escalation using sudo when needed
## Documentation
Documentation about how the filters works, what features are available and how to use them are available on firegex interface.