openvpn3-systemd(8)

📦
version 27.1 · 3 versions
, in nixpkgs unstable, ubuntu stonking

💖 openvpn3-systemd — the bestie who hooks your VPN up to systemd 💖

okay so, welcome to openvpn3-systemd(8), a page from the OpenVPN 3 Linux manual, section 8 (system administration, for the uninitiated). This little cutie is the glue between your VPN sessions and systemd, and honestly? she's carrying the whole vibe. 🫶

✨ NAME ✨

openvpn3-systemd — OpenVPN 3 Linux, but make it systemd service integration 🌈

🎀 SYNOPSIS 🎀

openvpn3-systemd [OPTIONS] CONFIG_PROFILE
openvpn3-systemd -h | --help

no cap, that's the whole shape of it 💅

🦋 DESCRIPTION 🦋

so basically this is a helper script. A supporting character. But like… a main character supporting character, yk? 👑

She's the one used by the openvpn3-session@.service unit file, and that unit file has one (1) job: run a single VPN session and scoop up the log events and all the related signals coming off that session. 📡

And the way those signals get used? Ma'am, they get used to update systemd with the appropriate status. So systemd always knows what's up. Communication, bestie. We love to see it. 💖

⚠️ important tea: using openvpn3-session@.service means the VPN configuration profile has to be imported in advance. Do it with openvpn3 config-import, and preferably as a persistent configuration — because that's what lets you start VPN sessions during boot. ✨

💅 OPTIONS 💅

  • -h, --help — prints the usage and help details right there in your terminal, no explanations needed 🌸
  • --start — start a brand new VPN session with the given configuration profile name. fresh start energy ✨
  • --restart — restarts a currently running VPN session with the given configuration profile name. she said "run it back" 🔥
  • --stop — stops a currently running VPN session with the given configuration profile name. periodt, we're done here 💀
  • --log-level LEVEL — sets the log verbosity for the log events. valid values are 0 to 6. the higher the value, the more verbose the log events will be. log level 6 will include all debug events. default is 5. so go off, but like, at the volume you actually want 🔊

🌸 EXAMPLE 🌸

first, a configuration profile gets imported as a persistent profile:

# openvpn3 config-import --persistent --name example --config client.ovpn

then start a VPN session via systemctl(1):

# systemctl start openvpn3-session@example

and check the logs for this session:

# journalctl --since today --unit openvpn3-session@example

look at her go. iconic. 👑

🍓 KNOWN ISSUES 🍓

ngl, right now the openvpn3-systemd helper does not support configuration profiles requiring any type of user authentication outside of X.509 certificates. so if your profile needs some other flavor of auth? not today, bestie 😭

🌟 SEE ALSO 🌟

go read those too, iykyk 💜

and that's the whole page, bestie!! this one came straight out of the OpenVPN 3 Linux manual — openvpn3-systemd(8), section 8, systemd service integration realness 🧚✨ stay slay, keep your sessions persistent, and may your status always update correctly 💖

📦 where this page comes from