Skip to content

DockerSolver: Configuration for DPS Network #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mageddo merged 26 commits into from
Dec 17, 2025
Merged

DockerSolver: Configuration for DPS Network #661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
2cd33a9
adjusts
mageddo Dec 17, 2025
8b77109
adjusts
mageddo Dec 17, 2025
bccad51
adjusts
mageddo Dec 17, 2025
4fcc43e
adjusts
mageddo Dec 17, 2025
9c61eaf
adjusts
mageddo Dec 17, 2025
6c722e7
adjusts
mageddo Dec 17, 2025
f38a90f
adjusts
mageddo Dec 17, 2025
043f55e
adjusts
mageddo Dec 17, 2025
e4daf12
adjusts
mageddo Dec 17, 2025
90a6b26
adjusts
mageddo Dec 17, 2025
6c1bcb7
adjusts
mageddo Dec 17, 2025
ddb6c20
adjusts
mageddo Dec 17, 2025
8c76bfa
adjusts
mageddo Dec 17, 2025
bff7c57
adjusts
mageddo Dec 17, 2025
b68a795
adjusts
mageddo Dec 17, 2025
964eb3f
adjusts
mageddo Dec 17, 2025
405d12c
adjusts
mageddo Dec 17, 2025
e08f36c
adjusts
mageddo Dec 17, 2025
4ccd1de
adjusts
mageddo Dec 17, 2025
681b53c
adjusts
mageddo Dec 17, 2025
3099132
adjusts
mageddo Dec 17, 2025
6c79fa2
Merge branch 'feat/627-docs' into feat/627
mageddo Dec 17, 2025
9efbcb3
adjusts
mageddo Dec 17, 2025
c8ffafd
adjusts
mageddo Dec 17, 2025
1ca6de9
adjusts
mageddo Dec 17, 2025
75b42f5
adjusts
mageddo Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions RELEASE-NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
## 5.2.0
Docker Solver
* Fixing DPS Docker Network IP Range
* Created option to customize the docker network

Breaking Changes
* Changed default DPS Network IP settings as the actual are not being accepted by docker

New Settings
```yaml
---
- subNet: 172.20.0.0/16
ipRange: 172.20.5.0/24
gateway: 172.20.5.1
- subNet: fc00:5c6f:db50::/64
gateway: fc00:5c6f:db50::1
```

## 5.1.3
* Changed resolv.conf handling format to make it compatible with alpine linux see [#627][5_1_0_1][1].
* Refactoring Linux amd64 static build to work on Github Actions
Expand Down
105 changes: 63 additions & 42 deletions docs/content/3-configuration/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,30 @@ weight: 3
pre: "<b>3. </b>"
---

Current Version: `3`. See [how to set the configurations][5].
Current Version: `3`. See [how to set the configurations][5].

### Server

| Name | Description | Default Value |
|------|-------------|---------------|
| `server.protocol` | Protocol to start the DNS server. | `UDP_TCP` |
| Name | Description | Default Value |
|-------------------|-----------------------------------|---------------|
| `server.protocol` | Protocol to start the DNS server. | `UDP_TCP` |

---

### DNS Server

| Name | Description | Default Value |
|------|-------------|---------------|
| `server.dns.port` | Port where the DNS server listens. | `53` |
| `server.dns.noEntriesResponseCode` | Response code returned when no entries are resolved by any solver. | `3` |
| Name | Description | Default Value |
|------------------------------------|--------------------------------------------------------------------|---------------|
| `server.dns.port` | Port where the DNS server listens. | `53` |
| `server.dns.noEntriesResponseCode` | Response code returned when no entries are resolved by any solver. | `3` |

---

### WEB Server

| Name | Description | Default Value |
|------|-------------|---------------|
| `server.web.port` | Web GUI port. | `5380` |
| Name | Description | Default Value |
|-------------------|---------------|---------------|
| `server.web.port` | Web GUI port. | `5380` |

---

Expand All @@ -39,72 +39,87 @@ Common DNS resolution mechanisms used by DPS. Solvers are evaluated according to

### Remote Solver

| Name | Description | Default Value |
|------|-------------|---------------|
| `solver.remote.active` | Enables or disables querying remote DNS servers. | `true` |
| `solver.remote.dnsServers` | Remote DNS servers to be queried when resolution cannot be done locally or via Docker. | `[8.8.8.8]` |
| Name | Description | Default Value |
|----------------------------|----------------------------------------------------------------------------------------|---------------|
| `solver.remote.active` | Enables or disables querying remote DNS servers. | `true` |
| `solver.remote.dnsServers` | Remote DNS servers to be queried when resolution cannot be done locally or via Docker. | `[8.8.8.8]` |

---

### Docker Solver

| Name | Description | Default Value |
|------|-------------|---------------|
| `solver.docker.registerContainerNames` | Whether container or service names should be registered as DNS hostnames. | `false` |
| `solver.docker.domain` | Domain suffix used when registering Docker containers and services. | `docker` |
| `solver.docker.hostMachineFallback` | Whether the host machine IP should be returned when a container is found but has no IP. | `true` |
| `solver.docker.dockerDaemonUri` | Docker daemon URI used to connect to Docker. | OS dependent |
| `solver.docker.dpsNetwork.autoCreate` | Whether DPS should automatically create a Docker bridge network. | `false` |
| `solver.docker.dpsNetwork.autoConnect` | Whether all containers should be auto-connected to the DPS network. | `false` |
| Name | Description | Default Value |
|----------------------------------------------|-----------------------------------------------------------------------------------------|-----------------|
| `solver.docker.registerContainerNames` | Whether container or service names should be registered as DNS hostnames. | `false` |
| `solver.docker.domain` | Domain suffix used when registering Docker containers and services. | `docker` |
| `solver.docker.hostMachineFallback` | Whether the host machine IP should be returned when a container is found but has no IP. | `true` |
| `solver.docker.dockerDaemonUri` | Docker daemon URI used to connect to Docker. | OS dependent |
| `solver.docker.dpsNetwork.autoCreate` | Whether DPS should automatically create a Docker bridge network. | `false` |
| `solver.docker.dpsNetwork.autoConnect` | Whether all containers should be auto-connected to the DPS network. | `false` |
| `solver.docker.dpsNetwork.configs` | Docker network IP configuration | |
| `solver.docker.dpsNetwork.configs[].subNet` | Subnet | `172.20.0.0/16` |
| `solver.docker.dpsNetwork.configs[].ipRange` | Ip Range | `172.20.5.0/24` |
| `solver.docker.dpsNetwork.configs[].gateway` | Gateway | `172.20.5.1` |

Default DPS network settings

```yaml
---
- subNet: 172.20.0.0/16
ipRange: 172.20.5.0/24
gateway: 172.20.5.1
- subNet: fc00:5c6f:db50::/64
gateway: fc00:5c6f:db50::1
```

---

### System Solver

| Name | Description | Default Value |
|------|-------------|---------------|
| Name | Description | Default Value |
|-------------------------------------|------------------------------------------------|---------------|
| `solver.system.hostMachineHostname` | Hostname that resolves to the host machine IP. | `host.docker` |

---

### Local Solver

| Name | Description | Default Value |
|------|-------------|---------------|
| Name | Description | Default Value |
|--------------------------|-------------------------------------------------------|-------------------|
| `solver.local.activeEnv` | Active environment used to resolve local DNS entries. | `` (empty string) |

---

### Stub Solver

| Name | Description | Default Value |
|------|-------------|---------------|
| `solver.stub.domainName` | Domain name used for stub solver resolved hostnames. | `stub` |
| Name | Description | Default Value |
|--------------------------|------------------------------------------------------|---------------|
| `solver.stub.domainName` | Domain name used for stub solver resolved hostnames. | `stub` |

---

### Default DNS

| Name | Description | Default Value |
|------|-------------|---------------|
| `defaultDns.active` | Whether DPS should be automatically configured as the system default DNS. | `false` |
| `defaultDns.resolvConf.overrideNameServers` | Whether existing nameservers should be commented out or DPS should be placed first. | `true` |
| `defaultDns.resolvConf.paths` | Resolv.conf or systemd-resolved configuration paths used to apply default DNS. | /host/etc/systemd/resolved.conf,/host/etc/resolv.conf,/etc/systemd/resolved.conf,/etc/resolv.conf |
| Name | Description | Default Value |
|---------------------------------------------|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| `defaultDns.active` | Whether DPS should be automatically configured as the system default DNS. | `false` |
| `defaultDns.resolvConf.overrideNameServers` | Whether existing nameservers should be commented out or DPS should be placed first. | `true` |
| `defaultDns.resolvConf.paths` | Resolv.conf or systemd-resolved configuration paths used to apply default DNS. | /host/etc/systemd/resolved.conf,/host/etc/resolv.conf,/etc/systemd/resolved.conf,/etc/resolv.conf |

---

### Logs

| Name | Description | Default Value |
|------|-------------|---------------|
| `log.level` | Logging level used by DPS. | `INFO` |
| `log.file` | Output target for logs (file path or console). | `console` |

| Name | Description | Default Value |
|-------------|------------------------------------------------|---------------|
| `log.level` | Logging level used by DPS. | `INFO` |
| `log.file` | Output target for logs (file path or console). | `console` |

### File Configuration Example

* [Solver remote circuit breaker configuration][3]

```json
```yaml
version: 3
server:
dns:
Expand Down Expand Up @@ -132,6 +147,12 @@ solver:
name: dps
autoCreate: false
autoConnect: false
configs:
- subNet: 172.20.0.0/16
ipRange: 172.20.5.0/24
gateway: 172.20.5.1
- subNet: fc00:5c6f:db50::/64
gateway: fc00:5c6f:db50::1
dockerDaemonUri:
system:
hostMachineHostname: host.docker
Expand All @@ -156,8 +177,8 @@ log:
file: console
```


### Legacy Configuration

[[ref][4]]

[1]: {{%relref "2-features/auto-configuration-as-default-dns/_index.md" %}}
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version=5.1.3-snapshot
version=5.2.0-snapshot
Loading