From c248b59fe1113572664b2e23becf2b2114706009 Mon Sep 17 00:00:00 2001 From: Qian Wang Date: Sun, 4 Aug 2019 21:15:17 +0100 Subject: [PATCH] Update README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 1e4878c..14e4380 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,8 @@ Then run `make client` or `make server`. Output binary will be in `build` folder `AdminUID` is the UID of the admin user in base64. +`BypassUID` is a list of UIDs that are authorised without any bandwidth or credit limit restrictions + `DatabasePath` is the path to userinfo.db. If userinfo.db doesn't exist in this directory, Cloak will create one automatically. **If Cloak is started as a Shadowsocks plugin and Shadowsocks is started with its working directory as / (e.g. starting ss-server with systemctl), you need to set this field as an absolute path to a desired folder. If you leave it as default then Cloak will attempt to create userinfo.db under /, which it doesn't have the permission to do so and will raise an error. See Issue #13.** ### Client