Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md: describe client RemoteHost option #233

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.md: describe client RemoteHost option #233

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ upstream proxy server. Zero or negative value disables it. Default is 0 (disable
`Transport` can be either `direct` or `CDN`. If the server host wishes you to connect to it directly, use `direct`. If
instead a CDN is used, use `CDN`.

`RemoteHost` required if direct connection is used. Format: `<IP or domain name>[:port]`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RemoteHost is configurable from the config file (so it should be documented), but it isn't required to be in the config file, as it could be supplied through the environment variable (used by Shadowsocks) or through the CLI options. The config file parser is called after these sources for RemoteHost are checked

https://github.com/cbeuw/Cloak/blob/master/cmd/ck-client/ck-client.go#L142


`PublicKey` is the static curve25519 public key in base64, given by the server admin.

`ProxyMethod` is the name of the proxy method you are using. This must match one of the entries in the
Expand Down