Skip to content

Commit a5e2f59

Browse files
alebeckalebeck
committed
Fix table formatting in README.md
1 parent 16bfa78 commit a5e2f59

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,16 +69,16 @@ identity = "~/.ssh/id_prod" # will try default ones if not set
6969

7070
Currently, supported options at tunnel level are:
7171

72-
| **Option** | **Description** |
73-
|---------------|---------------------------------------------------------------------------------------------------------------------|
74-
| `name` | Alias for the tunnel. **Required.** |
72+
| **Option** | **Description** |
73+
|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
74+
| `name` | Alias for the tunnel. **Required.** |
7575
| `local` | Local address. Can be a `"$host:$port"` network address or a Unix socket. Can be abbreviated as `"$port"` in local and socks modes. **Required** in local, remote and socks modes. |
76-
| `remote` | Remote address. As above, but can be abbreviated in remote and socks-remote modes. **Required** in local, remote and socks-remote modes. |
77-
| `host` | Either a host alias that matches SSH configs or the actual hostname. **Required.** |
78-
| `mode` | Mode of the tunnel. Can be either `"local"`, `"remote"`, `"socks"` or `"socks-remote"`. Default is `"local"`. |
79-
| `user` | SSH user. If not set, tries to read it from SSH config, defaulting to `$USER`. |
80-
| `identity` | SSH identity file. If not set, tries to read it from SSH config and `ssh-agent`, defaulting to standard identity files. |
81-
| `port` | SSH port. If not set, tries to read it from SSH config, defaulting to `22`. |
76+
| `remote` | Remote address. As above, but can be abbreviated in remote and socks-remote modes. **Required** in local, remote and socks-remote modes. |
77+
| `host` | Either a host alias that matches SSH configs or the actual hostname. **Required.** |
78+
| `mode` | Mode of the tunnel. Can be either `"local"`, `"remote"`, `"socks"` or `"socks-remote"`. Default is `"local"`. |
79+
| `user` | SSH user. If not set, tries to read it from SSH config, defaulting to `$USER`. |
80+
| `identity` | SSH identity file. If not set, tries to read it from SSH config and `ssh-agent`, defaulting to standard identity files. |
81+
| `port` | SSH port. If not set, tries to read it from SSH config, defaulting to `22`. |
8282

8383
Options that can be provided at global and tunnel level (tunnel level takes precedence):
8484

@@ -94,7 +94,7 @@ You can influence the behavior of `boring` via a couple of environment variables
9494
|--------------------|------------------------|------------------------------------------------------------------------------------|
9595
| `$BORING_CONFIG` | Config file location | `~/.boring.toml` (Mac & Windows) and `$XDG_CONFIG_HOME/boring/.boring.toml`(Linux) |
9696
| `$BORING_LOG_FILE` | Log file location | `/tmp/boringd.log` |
97-
| `$BORING_SOCK` | Socket location | `/tmp/boringd.sock"` |
97+
| `$BORING_SOCK` | Socket location | `/tmp/boringd.sock` |
9898
| `$DEBUG` | Enable verbose logging | ` ` |
9999

100100

0 commit comments

Comments
 (0)