diff --git a/docs/nordvpn-script.md b/docs/nordvpn-script.md index aaf8c7c02..118512bf7 100644 --- a/docs/nordvpn-script.md +++ b/docs/nordvpn-script.md @@ -1,18 +1,19 @@ ## NORDVPN API -The update script is based on the NordVpn API. The API sends back the best recommended config file based on the filters given. +The update script is based on the NordVPN API. The API sends back the best recommended OpenVPN configuration file based on the filters given. -Available ENV variables in the container to define via the NORDNVPN API the file to use are: -* NORDVPN_COUNTRY: (values code: https://api.nordvpn.com/v1/servers/countries) -* NORDVPN_CATEGORY: (values identifier: https://api.nordvpn.com/v1/servers/groups) -* NORDVPN_PROTOCOL: tcp or udp (values identifier more available at https://api.nordvpn.com/v1/technologies, may need script adaptation) +Available ENV variables in the container to define via the NordVPN API the file to use are: +| Variable | Function | Example | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | +| `NORDVPN_COUNTRY` | Two character country code. See [/servers/countries](https://api.nordvpn.com/v1/servers/countries) for full list. | `NORDVPN_COUNTRY=US` | +| `NORDVPN_CATEGORY` | Server type (P2P, Standard, etc). See [/servers/groups](https://api.nordvpn.com/v1/servers/groups) for full list. Use either `title` or `identifier` from the list. | `NORDVPN_CATEGORY=legacy_p2p` | +| `NORDVPN_PROTOCOL` | Either `tcp` or `udp`. (values identifier more available at https://api.nordvpn.com/v1/technologies, may need script adaptation) | `NORDVPN_PROTOCOL=tcp` | -the file is then download using the API to find the best server according to the variables, here an albanian, using tcp: +The file is then downloaded using the API to find the best server according to the variables, here an albanian, using tcp: * selecting server (limit answer to 1): [ANSWER]= https://api.nordvpn.com/v1/servers/recommendations?filters[country_id]=2&filters[servers_technologies][identifier]=openvpn_tcp&filters[servers_group][identifier]=legacy_group_category&limit=1 * download selected server's config: https://downloads.nordcdn.com/configs/files/ovpn_[NORDVPN_PROTOCOL]/servers/[ANSWER.0.HOSTNAME][] => https://downloads.nordcdn.com/configs/files/ovpn_tcp/servers/al9.nordvpn.com.tcp.ovpn - A possible evolution would be to check server's load to select the most available one. * limit numbers of returned server to 10 * use https://api.nordvpn.com/server/stats to collect cpu's load -* select the more available server. \ No newline at end of file +* select the more available server.