Skip to content

Commit

Permalink
chore: update docs (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
cottand authored Nov 14, 2023
1 parent ea40357 commit eeaa9cc
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 8 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ You can also
- use the [Nix flake](https://github.com/Cottand/leng/tree/master/flake.nix)
- `nix run github:cottand/leng`

Detailed guides and resources can be found on the [wiki](https://github.com/cottand/leng/wiki).
Detailed guides and resources can be found in the [docs website](https://cottand.github.com/leng).

# Configuration

By default, leng binds DNS to `0.0.0.0:53` and loads a few known blocklists. The default settings should be enough for
most.
See [the wiki](https://github.com/Cottand/leng/wiki/Configuration) for the full config, including defaults and dynamic
See [the wiki](https://cottand.github.io/leng/Configuration) for the full config, including defaults and dynamic
config reloading.

### CLI Flags
Expand Down Expand Up @@ -82,11 +82,6 @@ with `0.0.0.0` to ensure that the API interface is available.
curl -H "Accept: application/json" http://127.0.0.1:55006/application/active
```

# Daemonize

You can find examples of different daemon scripts for leng on
the [wiki](https://github.com/cottand/leng/wiki/Daemon-Scripts).

# Objectives

- [x] ~~ARM64 Docker builds~~
Expand Down
37 changes: 37 additions & 0 deletions doc/src/Docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Docker

Leng is also distributed as a Docker image.
[You can find published images here](https://github.com/Cottand/leng/pkgs/container/leng).
The image is small (v1.3.1 is under 13MB).

Supported architectures are linux AMD64, ARM64, ARMv6, ARMv7.

> If you think leng ought to support more OSs or architectures, please
[make an issue](https://github.com/Cottand/leng/issues/new).

## Running

With the default configuration:

```bash
docker run -d \
-p 53:53/udp \
-p 53:53/tcp \
-p 8080:8080/tcp \
ghcr.io/cottand/leng
```

With a specific `leng.toml`:

```bash
docker run -d \
-p 53:53/udp \
-p 53:53/tcp \
-p 8080:8080/tcp \
-v leng.toml:/leng.toml \
ghcr.io/cottand/leng \
-config /leng.toml

```

See [Configuratin](./Configuration.md) for the full config.
1 change: 1 addition & 0 deletions doc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

# Deployment

- [Docker](Docker.md)
- [As systemd service on Debian-based distro](./Deploying-on-Debian.md)
- [Securing with a Firewall on Linux](./Securing-on-linux.md)
- [Nix](./Nix.md)
Expand Down
7 changes: 6 additions & 1 deletion doc/src/Securing-on-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,9 @@ ufw allow from <ip or range> to any port 53
ufw reload
```

Now only the client(s) you whitelisted can access the dns server.
Now only the client(s) you whitelisted can access the dns server.

> ⚠ For Docker deployments, keep in mind `ufw` will **not** stop
> outside connections to your containers if you bind their ports.
> See the [Docker docs](https://docs.docker.com/network/packet-filtering-firewalls/#docker-and-ufw)
> about the issue.

0 comments on commit eeaa9cc

Please sign in to comment.