one-click-apps icon indicating copy to clipboard operation
one-click-apps copied to clipboard

Adding: Wireguard VPN

Open Duckiduc opened this issue 2 years ago • 14 comments
trafficstars

☑️ Self Check before Merge

  • [ ] I have tested the template using the method described in README.md thoroughly
  • [x] I have ensured that I put as much default values as possible (except passwords) to ensure minimum effort required for end users to get started.
  • [x] I have ensured that I am not using the "latest" tag as this tag is dynamically changing and might break the one-click app. Use a fixed version.
  • [x] I have made sure that instructions.start and instructions.end are clear and self-explanatory.
  • [x] Icon is added as a png file to the logos directory.
  • [x] I've executed the checks if necessary by running npm ci && npm run validate_apps && npm run formatter
  • [ ] I will take responsibility addressing any issues that arises as a result of this PR (maintaining this app).

Duckiduc avatar Oct 19 '23 19:10 Duckiduc

Testing Note:

Testing this pull request might be a bit tricky due to the nature of the WireGuard VPN service and my current setup. Here are the details:

  1. Local Testing: Unfortunately, I cannot install CapRover locally on my system, which makes local testing of the WireGuard service within the CapRover environment infeasible.

  2. VPS Environment: I have a WireGuard VPN service running on a VPS using CapRover, and taking it down for testing purposes is not an option, as it would disrupt the existing service for other users.

Given these constraints, I've done my best to ensure that the changes adhere to best practices and have thoroughly reviewed the code. However, I understand the importance of proper testing.

If any other contributors or reviewers have suggestions for overcoming these testing challenges or have specific testing instructions, please feel free to share them. I appreciate your understanding and cooperation in this matter.

Please let me know if you have any questions or need further clarification regarding the changes in this pull request.

Duckiduc avatar Oct 19 '23 20:10 Duckiduc

Yes, overall it looks good to me as well! Probably someone can rest and once confirmed to be working, I'm happy to merge!

I don't know wiregaurd workings and what to test, so unfortunately I'm unable to test.

Alternatively, you can ping me on Slack (@kasra) and I get give you a VPS box for a few days to run some tests.

githubsaturn avatar Oct 20 '23 03:10 githubsaturn

OK thanks. I am going to try and find a solution to test the VPN. I'll ping you if needed.

FYI here is a list of what I will be testing:

  • [ ] Ensure VPN server is up and running
  • [ ] Connection to VPS using SSH
  • [ ] Test VPN connection from client side using WireGuard client app
  • [ ] Data Transfer testing - confirm data is passing through the VPN tunnel
  • [ ] IP Leak - Check visible IP address
  • [ ] Geo Location Testing - confirm virtual location is that of the VPS
  • [ ] Caprover restart - confirm VPN still works as expected
  • [ ] Test port prerouting to other caprover apps

Duckiduc avatar Oct 20 '23 13:10 Duckiduc

@Duckiduc Have you made any progress on this?

ak4zh avatar Nov 08 '23 21:11 ak4zh

@Duckiduc Have you made any progress on this?

Not at all. I've been quite busy the last few weeks... didn't have time to properly test it.

Duckiduc avatar Nov 12 '23 17:11 Duckiduc

Great work @Duckiduc, is there an update on this or anything we can support with?

brenner-tobias avatar Mar 31 '24 18:03 brenner-tobias

Great work @Duckiduc, is there an update on this or anything we can support with?

Hey @brenner-tobias! Thanks :) Actually yes I have tested it and it works fine but I won't have the time to maintain it...

Duckiduc avatar Apr 05 '24 11:04 Duckiduc

@Duckiduc Hi I was also interested of running this on my caprover VPS and everything worked fine except I couldn't turn on HTTPS and it just keeps returning a 1107 Verification Failed error inside the web ui. Any ideas about why this is happening? Thanks in advance

EDIT: I have been able to turn on HTTPS by turning on the WebSockets option first... Still no idea why this works but well!

Sardonyx001 avatar Jun 20 '24 10:06 Sardonyx001

@Duckiduc Hi I was also interested of running this on my caprover VPS and everything worked fine except I couldn't turn on HTTPS and it just keeps returning a 1107 Verification Failed error inside the web ui. Any ideas about why this is happening? Thanks in advance

EDIT: I have been able to turn on HTTPS by turning on the WebSockets option first... Still no idea why this works but well!

Hi! Glad that you managed to make it work. Thanks for the feedback I'll add that to the documentation.

Duckiduc avatar Jun 24 '24 08:06 Duckiduc

CAP_ADD is now added to caprover master branch. It should be officially release soon.

guilh22 avatar Aug 04 '24 20:08 guilh22

I did install using TEMPLATE in one click apps Worked fine for me

Thanks a lot.

cshahdev avatar Dec 05 '24 16:12 cshahdev

Works fine +1

codedoga avatar Apr 14 '25 21:04 codedoga

I did install using TEMPLATE in one click apps Worked fine for me

Thanks a lot.

Could you please share the template here?

navin-hariharan avatar May 16 '25 03:05 navin-hariharan

@navin-hariharan You can check the template on the files changes tab above! Here's a link for it.

Sardonyx001 avatar May 16 '25 06:05 Sardonyx001