mirrors/dae
1
0
Fork 0
mirror of https://github.com/daeuniverse/dae.git synced 2025-07-09 15:30:06 +07:00
Code Issues Packages Projects Releases Wiki Activity

docs: add a known issue and fix typos

Browse Source
This commit is contained in:
mzz2017
2023-02-25 02:55:17 +08:00
parent 8bd6a77398
commit c5fb8dc028
4 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -78,7 +78,11 @@ sudo sysctl --system
## Getting Started ## 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 ## TODO

4
docs/getting-started/README.md
View File

@ -38,7 +38,7 @@ make GOFLAGS="-buildvcs=false" CC=clang
**Runtime Dependencies** **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 ```shell
mkdir -p /usr/local/share/dae/ mkdir -p /usr/local/share/dae/
@ -62,5 +62,5 @@ After fine tuning, run dae:
./dae run -c example.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).

2
docs/getting-started/kernel-upgrade.md
View File

@ -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. 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** > **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 ### Upgrade Kernel on Debian-based Linux

4
docs/getting-started/run-as-daemon.md
View File

@ -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. [systemd](https://wiki.debian.org/systemd) allows you to create and manage services in extremely powerful and flexible ways.
> **Note** > **Note**
> If your distribution's service manager is provided by systemd. > 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 ## Prerequisites