diff --git a/README.md b/README.md index 15647ea..4d71de5 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,11 @@ sudo sysctl --system ## Getting Started -Please refer to [Quick Start Guide](./docs/getting-started/README.md) to start using `Dae` right away! +Please refer to [Quick Start Guide](./docs/getting-started/README.md) to start using `dae` right away! + +## Known Issues + +1. If you setup dae and also a shadowsocks server (or any UDP servers) on the same machine in public network, such as a VPS, don't forget to add `sport(your server ports) -> must_direct` rule for your UDP server port. Because states of UDP are hard to maintain, all outgoing UDP packets will potentially be proxied (depends on your routing), including traffic to your client. This is not what we want to see. `must_direct` means all traffic including DNS traffic will be direct. ## TODO diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 9e65049..a7cbdb2 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -38,7 +38,7 @@ make GOFLAGS="-buildvcs=false" CC=clang **Runtime Dependencies** -For traffic splitting, Dae relies on the following data sources, [geoip.dat](https://github.com/v2ray/geoip/releases/latest) and [geosite.dat](https://github.com/v2fly/domain-list-community/releases/latest). +For traffic splitting, dae relies on the following data sources, [geoip.dat](https://github.com/v2ray/geoip/releases/latest) and [geosite.dat](https://github.com/v2fly/domain-list-community/releases/latest). ```shell mkdir -p /usr/local/share/dae/ @@ -62,5 +62,5 @@ After fine tuning, run dae: ./dae run -c example.dae ``` -Alternatively, you may run Dae as a daemon(systemd) service. Check out more details [HERE](./run-as-daemon.md). +Alternatively, you may run dae as a daemon(systemd) service. Check out more details [HERE](./run-as-daemon.md). diff --git a/docs/getting-started/kernel-upgrade.md b/docs/getting-started/kernel-upgrade.md index a2f4f16..1dc73d1 100644 --- a/docs/getting-started/kernel-upgrade.md +++ b/docs/getting-started/kernel-upgrade.md @@ -18,7 +18,7 @@ Before you start upgrading your Linux kernel, you must know the Kernel’s `curr Various Linux distributions have different methods to upgrade the Linux kernel. This guide convers ways to upgrade the kernel to a desired version for most `Debian-based Linux`, `RedHar, Fedora based Linux`, and `Arch-based Linux` distributions. > **Note** -> Since `Dae` is builts with `eBPF`, your host must meet the minimum Kernel version, `>= 5.8` for dae to properly running. +> Since `dae` is builts with `eBPF`, your host must meet the minimum Kernel version, `>= 5.8` for dae to properly running. ### Upgrade Kernel on Debian-based Linux diff --git a/docs/getting-started/run-as-daemon.md b/docs/getting-started/run-as-daemon.md index 3e9a4a3..b338796 100644 --- a/docs/getting-started/run-as-daemon.md +++ b/docs/getting-started/run-as-daemon.md @@ -1,11 +1,11 @@ -# Run Dae as a Daemon Service +# Run dae as a Daemon Service [systemd](https://wiki.debian.org/systemd) allows you to create and manage services in extremely powerful and flexible ways. > **Note** > If your distribution's service manager is provided by systemd. -Dae can be running as a daemon(systemd) service so that it can run at boot. +dae can run as a daemon(systemd) service so that it can run at boot. ## Prerequisites