Skip to content

Commit 16bfa78

Browse files
committed
Document env variables in README.md
1 parent e820bbe commit 16bfa78

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,21 @@ Options that can be provided at global and tunnel level (tunnel level takes prec
8484

8585
| **Option** | **Description** |
8686
|---------------|---------------------------------------------------------------------------------------------------------------------|
87-
| `keep_alive` | Keep-alive interval **in seconds**. Default: `120` (2 minutes). |
87+
| `keep_alive` | Keep-alive interval **in seconds**. Default: `120` (2 minutes). |
88+
89+
You can influence the behavior of `boring` via a couple of environment variables:
90+
<details>
91+
<summary>Show</summary>
92+
93+
| **Variable** | **Description** | **Default** |
94+
|--------------------|------------------------|------------------------------------------------------------------------------------|
95+
| `$BORING_CONFIG` | Config file location | `~/.boring.toml` (Mac & Windows) and `$XDG_CONFIG_HOME/boring/.boring.toml`(Linux) |
96+
| `$BORING_LOG_FILE` | Log file location | `/tmp/boringd.log` |
97+
| `$BORING_SOCK` | Socket location | `/tmp/boringd.sock"` |
98+
| `$DEBUG` | Enable verbose logging | ` ` |
99+
100+
101+
</details>
88102

89103
## Installation
90104

0 commit comments

Comments
 (0)