Getting Started
Follow these seven steps in order. Each panel tells you exactly what to do — on your LAN, on PME Server, or both.
1 — Discover
Where: this site
Before you install anything, understand the pieces: PME Edge runs on an always-on machine on your home LAN; PME Server on the web handles accounts and invites; invitees connect with a normal WireGuard app.
Do this:
- Skim How it works for the full path (Edge → Server → Relay → invitee)
- Confirm your host meets Requirements (always-on LAN machine)
- Optional: check Pricing if you care about Mesh Pro / relay later
2 — PME account
Where: PME Server (web)
Create your account on PME Server. Accounts and invite links live here — not on your home machine. You will use the same email and password when you register Edge in step 4.
Do this:
- Open PME Server and create an account (or sign in if you already have one)
- Optional: open the Setup wizard after sign-in — it tracks register → relay → invite progress from your account
3 — Install PME Edge
Where: always-on machine on your home LAN
Download and run PME Edge on the Mac, Linux box, or mini PC that stays powered on your LAN. Edge includes the WireGuard VPN server and the local console where you create invites.
Do this:
- Get the binary for your OS from ws-edge releases (or follow the full walkthrough on Download)
- Install OS deps first — macOS (Homebrew wireguard-tools, dnsmasq, sudoers) or Ubuntu (wireguard, dnsmasq, nftables)
-
Start Edge with relay enabled:
PME_RELAY_ENABLED=true edge run - Open the local UI: http://127.0.0.1:9191
Stuck? See troubleshooting — install.
4 — Register with PME
Where: Edge UI on your LAN → PME Server
Link this Edge node to your PME account. Edge connects outbound over a secure WebSocket — you do not open an inbound firewall port for management.
Do this:
- In the Edge UI at http://127.0.0.1:9191, sign in with the same email/password as PME Server
- Tap Register with PME Server
- Confirm the control stream is connected — Edge logs, the Edge dashboard, or the PME Setup wizard
Stuck? See troubleshooting — register.
5 — PME Relay (remote access)
Where: Edge + PME Relay
Many home routers block inbound UDP, so invitees on cellular cannot dial your WireGuard port directly. PME Relay gives them a public endpoint; Edge reaches that relay outbound. No UDP port forward on your router.
Do this:
- Start (or restart) Edge with PME_RELAY_ENABLED=true — env var, or /etc/default/edge on systemd
- In the Edge dashboard, confirm relay connected
- After you create an invite (next step), test from cellular or another network — not home Wi‑Fi
New accounts include a 30-day relay trial; keep remote access afterward with Mesh Pro. Stuck? See troubleshooting — PME Relay.
6 — First invitation
Where: Edge UI → send link → invitee on PME Server
Create a VPN invite and choose Allowed IPs — only those routes are reachable over the tunnel. Example: a NAS at 192.168.1.50/32, a printer, or your home subnet.
Do this:
- In the Edge UI → Invitations → create a VPN invite
- Set Allowed IPs to the LAN devices or subnets you want to share
- Copy the invite link and send it (email, chat, etc.)
- Ask the invitee to open the link on PME Server, sign in or create an account, and complete WireGuard setup
Stuck? See troubleshooting — invite.
7 — Invitee success
Where: invitee’s phone or laptop
Success means the invitee has VPN on and can reach only what you allowed — for example the NAS web UI or a shared folder — while the rest of your LAN stays private.
Ask your invitee to:
- Open the invite link and create or sign in to their PME account
- Complete WireGuard setup (scan the QR or import the config file)
- Turn the VPN on in the WireGuard app
- Open the shared service (hostname or IP you gave them) over the tunnel
If something fails, start with Troubleshooting or walk through How it works again.