From 16f53c1f0256d8baa0fb75a02d49538edd2474e6 Mon Sep 17 00:00:00 2001 From: black-desk <me@black-desk.cn> Date: Thu, 10 Oct 2024 10:35:09 +0800 Subject: [PATCH] docs: update README Related: #205 Signed-off-by: black-desk <me@black-desk.cn> --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 7b20812..5098c23 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,30 @@ systemctl restart cgtproxy.service [configuration guide]: ./docs/configuration.md +## Tips + +1. cgproxy has CLI utilities `cgproxy` and `cgnoproxy` + to temporarily run program with(out) proxy. + + If you use the [example configuration] of `cgtproxy`, + you can write a bash alias as this: + + ```bash + alias cgtproxy-direct="systemd-run --user --slice cgtproxy-direct.slice" + ``` + + Then use it like this: + + ```bash + cgtproxy-direct /some/command/to/run/without/proxy + ``` + + Go check the comments in example configuration + about the `cgtproxy-direct.slice`, `cgtproxy-drop.slice` + and `cgtproxy-proxy.slice`. + +[example configuration]: ./misc/config/example.yaml + ## The way how `cgtproxy` works. Netfliter can be configured to filter network traffic [by cgroup],