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

Contribute configs guidelines #118

Open
2 of 3 tasks
Forage opened this issue Jun 15, 2022 · 2 comments
Open
2 of 3 tasks

Contribute configs guidelines #118

Forage opened this issue Jun 15, 2022 · 2 comments

Comments

@Forage
Copy link
Contributor

Forage commented Jun 15, 2022

Do you have the latest provider files?

  • I have checked that the provider are the latest

Have you tested the provider files?

  • I have tested the provider files

Can you create a PR for this config?

  • I can create a PR for this

Provider details

The CONTRIBUTING.md file does not actually talk about contributing, only about how to use custom configs. It would be good to have it include contributing guidelines or to have a wiki page for it.

As I only have "experience" with one VPN provider and I don't know all the stuff that could be needed for others I only have a short list:

  • Make sure not the include any account related directives/certificates (examples needed for user name, password, etc)
  • Config directives up and down need to be removed from the config files or commented out with # at the start of the line
  • The auth-user-pass config directive needs to be added/replaced and point to /config/openvpn-credentials.txt
  • Touch the original configs provided by the provider as less as possible(?) (file names, config directives, etc.)
  • Creating a config download script is preferred over storing all configs in this repository when the provider has an API for doing so(?)

What is not 100% clear to me:

  • Do you require or prefer a default.ovpn symlink to be present? If so, where should it point to?
  • <vpn-technology>/<provider>/<bundle-name>/configs.ovpn is the described folder structure, but privatevpn is basically the only provider that has a <bundle-name> subfolder at the moment. Is this folder strictly organisational for us and can it have any name or does it corresponde to some provider specific parameter? If the former is the case, do we need to take file name uniqueness across all folders into account? Can it have additional subfolders as well? I'm thinking <vpn-technology>/<provider>/free/udp/configs.ovpn and <vpn-technology>/<provider>/free/tcp/configs.ovpn, etc
  • Should symlinks be added for profiles that don't exist any more when updating all profile of a provider and have it point to something similar?
  • If a provider has p2p specific configs, but the non-p2p work just as well, should both be included anyway or do we stick to what the provider indicates/prefers?
  • Should tor openvpn configs be included if provided by the provider?

What else is preferred/recommended/required?

Anything else?

No response

@shdwkeeper
Copy link

ExpressVPN Los Angeles 1 needs updating

@Forage
Copy link
Contributor Author

Forage commented Jul 5, 2022

ExpressVPN Los Angeles 1 needs updating

Than please create a separate ticket for it instead of adding it as a comment to a ticket of a different subject.

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

No branches or pull requests

2 participants