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.

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

Conversation

selivan
Copy link

@selivan selivan commented Sep 6, 2023

No description provided.

@@ -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

@selivan selivan closed this Sep 9, 2023
@selivan selivan reopened this Sep 9, 2023
@selivan
Copy link
Author

selivan commented Sep 9, 2023

If Cloak is used as transport for OpenVPN, it can not take remote host from environment. Sometimes having it in config file is more convenient, than pass it by command argument.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants