docs: Enable Github pages and add troubleshooting docs

.github/ISSUE_TEMPLATE/connectivity-issue.md

@@ -1,26 +1,15 @@
+---
+name: Connectivity Issue
+about: Use this template for connectivty issues.
+---
+
+## Debugging with debugging compose file
+
+- [ ] I have tried debugging with compose file provided as mentioned in [TROUBLESHOOTING](./TROUBLESHOOTING.md).
+- [ ] I have attached output/outcome of debugging steps below
+
+<!-- Please Provide details on your errors when you tried debugging with provided compose file -->
 
-## Debugging with default compose file
-
-1. Stop and delete existing containers named `protonvpn` and `pyload` (if any).
-1. Please export credentials as environment variables `PROTONVPN_USERNAME` and `PROTONVPN_PASSWORD` and optionally `PROTONVPN_TIER`.
-This depends on your shell. Please consult your shell's manpage/docs for how to export environment variables.
-1. Get your debugging [compose file][] and create a temporary folder required to save pyload downloads.
- ```bash
- curl -sSfLO https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/k8s/docker-compose.yml
- mkdir -p ./downloads
- ```
-1. Try to run downloaded [compose file][]
- ```bash
- docker-compose up
- ```
-1. We intentionally do not expose in this config, `pyload` to outside world. depending on your system and runtime constraints IP address of your container will vary. To obtain IP address/URL of your `pyload` service,run
- ```bash
- docker inspect --format='{{range .NetworkSettings.Networks}}{{printf "http://%s:8000\\n" .IPAddress}}{{end}}' protonvpn
- ```
-1. Visit the link in your browser.
-1. If for some reason you get timeout errors, please specify output of following when running inside protonvpn container via `docker exec -it protonvpn bash`.
- - `ip r`
- - `curl -sSfL ipinfo.io`
 
 ## Runtime configuration
 
@@ -35,12 +24,13 @@ This depends on your shell. Please consult your shell's manpage/docs for how to
 
 ## Docker configuration
 
-- [ ] Using custom runtime
+- [ ] Using custom runtime like gvisor (specify your runtime):
 - [ ] Using user namespaces
 - [ ] Using rootless containers
 - [ ] Using with podman
 - [ ] Using with k8s/Kubernetes/Openshift
 
+
 ## Redacted PII & Credential validation
 
 - [ ] I have redacted any personally identifying information like public IP address, hostnames, usernames and passwords if they are present in the output.

README.md

@@ -170,6 +170,10 @@ networks:
 
 There is a `healthcheck` script available under /usr/local/bin (Added in 2.2.2-hotfix2). It will use `https://ipinfo.io` to verify the country to which VPN is connected. By default service will keep checking every `PROTONVPN_CHECK_INTERVAL` _(default = 60)_ seconds using the same api endpoint, script is only added for convenience.
 
+## Troubleshooting
+
+See [Troubleshooting](./TROUBLESHOOTING.md)
+
 ## Known issues
 
 - Kill switch is **NOT** reliable. This is due to the way protonvpn cli works because on issuing reconnect they remove

TROUBLESHOOTING.md

@@ -0,0 +1,40 @@
+
+---
+layout: default
+title: Troubleshooting
+permalink: /troubleshooting/
+nav_order: 5
+---
+
+# Troubleshooting
+
+If you are unable to run the container as desired, please try the following before opening an issue
+on GitHub.
+
+## Troubleshooting with default compose file
+
+1. Stop and delete existing containers named `protonvpn` and `pyload` (if any).
+1. Please export credentials as environment variables `PROTONVPN_USERNAME` and `PROTONVPN_PASSWORD` and optionally `PROTONVPN_TIER`.
+This depends on your shell. Please consult your shell's manpage/docs for how to export environment variables.
+1. Get your debugging [compose file][] and create a temporary folder required to save pyload downloads.
+ ```bash
+ curl -sSfLO https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/k8s/docker-compose.yml
+ mkdir -p ./downloads
+ ```
+1. Try to run downloaded [compose file][]
+ ```bash
+ docker-compose up
+ ```
+1. We intentionally do not expose in this config, `pyload` to outside world. depending on your system and runtime constraints IP address of your container will vary. To obtain IP address/URL of your `pyload` service,run
+ ```bash
+ docker inspect --format='{{range .NetworkSettings.Networks}}{{printf "http://%s:8000\\n" .IPAddress}}{{end}}' protonvpn
+ ```
+1. Visit the link in your browser.
+1. If for some reason you get timeout errors, please specify output of following when running inside protonvpn container via `docker exec -it protonvpn bash`.
+ - `ip r`
+ - `curl -sSfL ipinfo.io`
+
+## DNS and Healthchecks
+
+- Healthchecks use `ipinfo.io` service. If your DNS or gateway is blocking it, please add it to your exceptions.
+- If your are unable to do so, please open an issue so that we can find some alternatives.

_config.yml

@@ -0,0 +1,24 @@
+# domain
+baseurl: "/protonvpn-docker"
+url: "https://tprasadtp.github.io"
+
+# meta
+title: ProtonVPN docker image
+description: ProtonVPN docker image. Supports ARMv7(32-bit), ARMv8 (64-bit ) and x86 (64-Bit).
+show_downloads: false
+remote_theme: pmarsceill/just-the-docs
+# Logo
+logo: "https://static.prasadt.com/logos/projects/artemis/scalable/sysadmin.svg"
+# Enable Search
+search_enabled: true
+
+# Misc
+permalink: pretty
+
+# Aux links for the upper right navigation
+aux_links:
+ "View on GitHub":
+ - "https://github.com/tprasadtp/protonvpn-docker/"
+
+# Makes Aux links open in a new tab
+aux_links_new_tab: true