Skip to content

Commit c51a949

Browse files
committed
docs: fix README
1 parent 3e17350 commit c51a949

File tree

1 file changed

+51
-2
lines changed

1 file changed

+51
-2
lines changed

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,55 @@ flag is **ALSO** specified.
131131
132132
<!--diana::dynamic:protonwire-help:begin-->
133133
<pre>
134+
135+
ProtonVPN WireGuard Client
136+
137+
Usage: protonwire [OPTIONS...]
138+
or: protonwire [OPTIONS...] c|connect [SERVER]
139+
or: protonwire [OPTIONS...] d|disconnect
140+
or: protonwire [OPTIONS...] check
141+
or: protonwire [OPTIONS...] disable-killswitch
142+
or: protonwire [OPTIONS...] server-info [SERVER]
143+
144+
Options:
145+
-k, --private-key FILE|KEY Wireguard private key or
146+
file containing private key
147+
--service Run as service
148+
--service-status-file Use status file created by --service
149+
for healthchecks. Only valid when both process
150+
are running within the same container.
151+
--metadata-url URL Server metadata endpoint URL
152+
--check-interval INT IP check interval in seconds (default 60)
153+
--check-url URL IP check endpoint URL
154+
--skip-dns-config Skip configuring DNS.
155+
(Useful for Kubernetes and Consul)
156+
--kill-switch Enable killswitch (Experimental)
157+
--p2p Verify if specified server supports P2P
158+
--streaming Verify if specified server supports streaming
159+
--tor Verify if specified server supports Tor
160+
--secure-core Verify if specified server supports secure core
161+
-q, --quiet Show only errors
162+
-v, --verbose Show debug logs
163+
-h, --help Display this help and exit
164+
--version Display version and exit
165+
166+
Examples:
167+
protonwire connect nl-1 Connect to server nl-1
168+
protonwire d --kill-switch Disconnect from current server and disable kill-switch
169+
protonwire verify [SERVER] Check if connected to a server
170+
171+
Files:
172+
/etc/protonwire/private-key WireGuard private key
173+
174+
Environment:
175+
WIREGUARD_PRIVATE_KEY WireGuard private key or file
176+
PROTONVPN_SERVER ProtonVPN server
177+
IPCHECK_INTERVAL Custom IP check interval in seconds (default 60)
178+
IPCHECK_URL IP check endpoint URL (must be https://)
179+
SKIP_DNS_CONFIG Set to '1' to skip configuring DNS
180+
KILL_SWITCH Set to '1' to enable killswitch (Experimental)
181+
DEBUG Set to '1' to enable debug logs
182+
</pre>
134183
<!--diana::dynamic:protonwire-help:end-->
135184
136185
## Health-checks
@@ -235,7 +284,7 @@ This section covers running containers via podman. But for deployments use
235284
--tmpfs=/tmp \
236285
--name=protonwire \
237286
--secret="protonwire-private-key,mode=600" \
238-
--env=PROTONVPN_SERVER="nl-free-127.protonvpn.net" \
287+
--env=PROTONVPN_SERVER="node-nl-03.protonvpn.net" \
239288
--env=DEBUG=0 \
240289
--env=KILL_SWITCH=1 \
241290
--cap-add=NET_ADMIN \
@@ -369,8 +418,8 @@ Building requires [`task`](https://taskfile.dev/installation/),
369418
[releases]: https://github.com/tprasadtp/protonwire/releases/latest
370419
[Troubleshooting]: ./docs/help.md
371420
[FAQ]: ./docs/faq.md
421+
[cosign]: https://docs.sigstore.dev/system_config/installation/
372422
[slsa-verify-docs]: ./docs/slsa.md
373423
[slsa-badge-level3]: ./docs/images/slsa-level3-logo.svg
374424
[slsa-level3]: https://slsa.dev/spec/v1.0/levels#build-l3
375-
376425
[slsa-badge]: https://img.shields.io/badge/SLSA-level%203-39AC60?labelColor=3a3a3a&logoColor=959da5&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAMAAAAolt3jAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABMlBMVEXvMQDvMADwMQDwMADwMADvMADvMADwMADwMQDvMQDvMQDwMADwMADvMADwMADwMADwMQDvMQDvMQDwMQDvMQDwMQDwMADwMADwMQDwMADwMADvMADvMQDvMQDwMADwMQDwMADvMQDwMADwMQDwMADwMADwMADwMADwMADwMADvMQDvMQDwMADwMQDwMADvMQDvMQDwMADvMQDvMQDwMADwMQDwMQDwMQDvMQDwMADvMADwMADwMQDvMQDwMADwMQDwMQDwMQDwMQDvMQDvMQDvMADwMADvMADvMADvMADwMQDwMQDvMADvMQDvMQDvMADvMADvMQDwMQDvMQDvMADvMADvMADvMQDwMQDvMQDvMQDvMADvMADwMADvMQDvMQDvMQDvMADwMADwMQDwMAAAAAA/HoSwAAAAY3RSTlMpsvneQlQrU/LQSWzvM5DzmzeF9Pi+N6vvrk9HuP3asTaPgkVFmO3rUrMjqvL6d0LLTVjI/PuMQNSGOWa/6YU8zNuDLihJ0e6aMGzl8s2IT7b6lIFkRj1mtvQ0eJW95rG0+Sid59x/AAAAAWJLR0Rltd2InwAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAAd0SU1FB+YHGg0tGLrTaD4AAACqSURBVAjXY2BgZEqGAGYWVjYGdg4oj5OLm4eRgZcvBcThFxAUEk4WYRAVE09OlpCUkpaRTU6WY0iWV1BUUlZRVQMqUddgSE7W1NLS1gFp0NXTB3KTDQyNjE2Sk03NzC1A3GR1SytrG1s7e4dkBogtjk7OLq5uyTCuu4enl3cyhOvj66fvHxAIEmYICg4JDQuPiAQrEmGIio6JjZOFOjSegSHBBMpOToxPAgCJfDZC/m2KHgAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMi0wNy0yNlQxMzo0NToyNCswMDowMC8AywoAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjItMDctMjZUMTM6NDU6MjQrMDA6MDBeXXO2AAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAAABJRU5ErkJggg==

0 commit comments

Comments
 (0)