diff --git a/CHANGELOG.md b/CHANGELOG.md index 33fdd37..c326eec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## Unreleased +## 0.3.1 (2024-12-31) ### Added diff --git a/Cargo.lock b/Cargo.lock index dd0a56e..709fd90 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3437,7 +3437,7 @@ dependencies = [ [[package]] name = "sandhole" -version = "0.3.0" +version = "0.3.1" dependencies = [ "anyhow", "async-trait", diff --git a/Cargo.toml b/Cargo.toml index bb71f34..a2743e8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "sandhole" -version = "0.3.0" +version = "0.3.1" edition = "2021" rust-version = "1.82.0" description = "Expose HTTP/SSH/TCP services through SSH port forwarding." diff --git a/book/src/docker_compose.md b/book/src/docker_compose.md index d932888..cd395a8 100644 --- a/book/src/docker_compose.md +++ b/book/src/docker_compose.md @@ -12,4 +12,4 @@ Then, simply run: docker compose up -d ``` -You should also re-run this command whenever you make changes to your configuration. See the [official Docker Compose documentation](https://docs.docker.com/compose/) for more information. +You should also re-run this command whenever you make changes to your configuration and/or after you update to the latest image (`docker compose pull`). See the [official Docker Compose documentation](https://docs.docker.com/compose/) for more information. diff --git a/book/src/faq.md b/book/src/faq.md index 78c9682..dce4432 100644 --- a/book/src/faq.md +++ b/book/src/faq.md @@ -30,12 +30,12 @@ With the `--disable--http`, `--disable-tcp`, and `--disable-aliasing` [CLI flags ## How do I prevent multiple services from load-balancing? -With the `--load-balancing=deny` or `--load-balancing=replace` [CLI flag](./cli.md). This is currently a global setting. +With the `--load-balancing=deny` or `--load-balancing=replace` [CLI flag](./cli.md). ## How do I force HTTP requests to get redirected to HTTPS? -With the `--force-https` [CLI flag](./cli.md). This is currently a global setting. +With the `--force-https` [CLI flag](./cli.md). ## How do I allow/block certain IP ranges? -With the `--ip-allowlist` and `--ip-blocklist` [CLI flags](./cli.md) respectively. These are currently a global setting. +With the `--ip-allowlist` and `--ip-blocklist` [CLI flags](./cli.md) respectively. diff --git a/book/src/quick_start.md b/book/src/quick_start.md index b21a9f2..86c92b6 100644 --- a/book/src/quick_start.md +++ b/book/src/quick_start.md @@ -3,6 +3,6 @@ In order to run Sandhole, you'll need: - A server with at least one public address. -- A domain pointing to said server (in this example, `server.com`). +- A domain (for example, `server.com`) and its subdomains (`*.server.com`) pointing to said server. Then, install the Sandhole binary in your server. Currently, you can do so [through Docker Compose](./docker_compose.md), by downloading [a binary from the latest release](https://github.com/EpicEric/sandhole/releases/latest), or by [compiling it yourself](./compiling_from_source.md).