fbi-proxy 1.5.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,23 +2,7 @@
2
2
 
3
3
  FBI-Proxy provides easy HTTPS access to your local services with intelligent domain routing.
4
4
 
5
- ## Usage
6
-
7
- ```sh
8
- # launch
9
- bunx fbi-proxy
10
-
11
- # expose to LAN
12
- bunx fbi-proxy --host 0.0.0.0 --port=2432
13
-
14
- # with caddy, forwarding *.fbi.com
15
- bunx fbi-proxy --caddy=fbi.com
16
-
17
- # or
18
- docker start
19
- ```
20
-
21
- ### Routing Examples
5
+ ## Routing Examples
22
6
 
23
7
  ```bash
24
8
  # Port forwarding
@@ -39,6 +23,22 @@ https://myserver.fbi.com → myserver:80
39
23
 
40
24
  WebSocket connections are supported for all patterns.
41
25
 
26
+ ## Usage
27
+
28
+ ```sh
29
+ # launch
30
+ bunx fbi-proxy
31
+
32
+ # expose to LAN
33
+ bunx fbi-proxy --host 0.0.0.0 --port=2432
34
+
35
+ # with caddy, forwarding *.fbi.com
36
+ bunx fbi-proxy --caddy=fbi.com
37
+
38
+ # run with docker, forwarding *.your-domain.com to host.
39
+ docker run --rm --name fbi-proxy --network=host -v caddy_data:/etc/caddy/data snomiao/fbi-proxy --reverse-proxy=your-domain.com
40
+ ```
41
+
42
42
  ## Development
43
43
 
44
44
  ```bash
@@ -60,8 +60,24 @@ bun run build && bun run start
60
60
 
61
61
  ### Configuration
62
62
 
63
+ #### Environment Variables
64
+
65
+ FBI-Proxy supports the following environment variables for configuration:
66
+
67
+ | Variable | Description | Default |
68
+ |----------|-------------|---------|
69
+ | `FBI_PROXY_PORT` | Port for the proxy server to listen on | `2432` |
70
+ | `FBI_PROXY_HOST` | Host/IP address to bind to | `127.0.0.1` |
71
+ | `RUST_LOG` | Log level for the Rust proxy (error, warn, info, debug, trace) | `info` |
72
+ | `FBIPROXY_PORT` | Internal proxy port (auto-assigned) | Auto |
73
+
74
+ Command-line arguments take precedence over environment variables.
75
+
76
+ #### CLI Options
77
+
63
78
  - Default domain: `fbi.com` (change with `--fbihost`)
64
- - Internal proxy port: Auto-assigned to `FBIPROXY_PORT`
79
+ - Host binding: `--host` or `FBI_PROXY_HOST` env var
80
+ - Port binding: `--port` or `FBI_PROXY_PORT` env var
65
81
 
66
82
  ## License
67
83