Skip to content

Commit 9534fff

Browse files
committed
docs: note for AppArmor security
1 parent a2680ca commit 9534fff

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,24 @@
1212
<img src="https://github.com/grishy/go-avahi-cname/actions/workflows/release.yml/badge.svg" alt="Build Status">
1313
</p>
1414

15-
## TL;DR - How to start in subdomain mode
15+
## TL;DR: How to Start in Subdomain Mode
1616

17-
Redirect all "subdomains" to the machine( `*.hostname.local` -> `hostname.local`)
18-
Install:
17+
Redirect all subdomains to the machine (`*.hostname.local``hostname.local`).
1918

20-
1. _Binary_ (download from [Releases](https://github.com/grishy/go-avahi-cname/releases))
21-
```
19+
1. **Binary** (download from [Releases](https://github.com/grishy/go-avahi-cname/releases)):
20+
21+
```bash
2222
./go-avahi-cname subdomain
2323
```
24-
2. _Docker_
24+
25+
2. **Docker**:
26+
2527
```bash
2628
docker run -d --network host -v "/var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket" ghcr.io/grishy/go-avahi-cname:2.2.4
2729
```
2830

31+
_Note:_ If you [encounter issues](https://github.com/grishy/go-avahi-cname/issues/28) with AppArmor, check to add `--security-opt apparmor=unconfined` to the Docker command.
32+
2933
# What is go-avahi-cname?
3034

3135
It is a simple and lightweight project that allows you to publish CNAME records pointing to the local host over multicast DNS using the **Avahi** daemon, which is widely available in most Linux distributions. This means that you can access your local host using different names from any device on the same network, as long as they support mDNS.

0 commit comments

Comments
 (0)