Documentation about restoring a backup is incomplete

Open Beginner friendly
#26 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
linux
Domain
documentation

Research direction

Start with the migrating PiVPN WireGuard page at https://docs.pivpn.io/wireguard/#migrating-pivpn-wireguard and compare its restore steps with the reported setupVars.conf and Alpine /etc/iptables/rules-save changes. Update the page to cover matching the backup network values and restarting wg-quick and iptables services or rebooting; done means the restore procedure includes all reported steps.

Written by the indexing model from the issue text.

Description

Hi,

the documentation about restoring a backup is incomplete: https://docs.pivpn.io/wireguard/#migrating-pivpn-wireguard

After setting up a new pivpn instance and restoring the backup the following issues arise:

  • The pivpnNET in /etc/pivpn/wireguard/setupVars.conf seems to be chosen randomly during initial setup. So it will differ from the one that is used in the backup in /etc/wireguard/wg0.conf. You need to edit /etc/pivpn/wireguard/setupVars.conf to set it to the value, that is used in the backup.
  • Also the iptables rules contain this network and must be changed. On Alpine Linux you have to edit /etc/iptables/rules-save and change it to the one from backup.
  • Restart wg-quick and iptables services or reboot.
Dominant language
Dockerfile
Stars
39
Forks
16
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.