eurephiadm(7)

💖 eurephiadm — bestie's guide to the eurephia admin tool 💖

okay so real talk, this is page eurephiadm(7) and it's literally the group chat you need if you're running the eurephia plug-in for OpenVPN. no cap. let's get into it 🫶

---

✨ NAME ✨

eurephiadm — the eurephia administration utility. that's it, that's the name, and she's iconic for it 💅

---

🌸 SYNOPSIS 🌸

eurephiadm <command> [-h|--help] [-V|--version] [<global options>]
[-l|--log <filename>] [-L|--log-level <log level>] [<command arguments>]

---

🦋 DESCRIPTION 🦋

eurephiadm is a generic command line tool for administering and configuring the eurephia plug-in for OpenVPN. it's giving "main character of your admin workflow", fr fr. lowkey she does a lot, so buckle up 🎀

---

👑 COMMANDS 👑

here's every command available in eurephiadm. yes, all of them. we don't skip. ✨

• help [<command>] — shows you this help screen when you don't give it any arguments. if you do hand it a command, it gives you the help screen for that specific command instead. it's literally so helpful, hence the name 💅
• logout — logs you out of an active eurephiadm session. here's the tea: most of the operations in eurephiadm require you to authenticate yourself first. once you do, the session stays active for a predefined amount of time, so you're not re-authenticating every five seconds like some kind of clown. but if the session times out, or you use the logout command, you'll have to authenticate yourself all over again 😭
• users [<arguments>] — the user management module. lists, adds, removes, activates, deactivates, and shows user account information for each eurephia user. she does it all 🧚
• lastlog — queries the eurephia lastlog. this log holds the info about OpenVPN sessions that were authenticated via eurephia. receipts, basically 📜
• attempts [<arguments>] — shows or resets the registered failed login attempts registrations.
• blacklist [<arguments>] — shows, adds, or deletes blacklisted user accounts, certificates, or IP addresses. bye felicia 👋
• certs [<arguments>] — SSL Certificate management for eurephia authentication. certs are the vibe, no cap 🔐
• usercerts [<arguments>] — manages the relations between eurephia user accounts and certificates. this combo is called a user access, and it defines which access level the authenticated eurephia user will have to the network. honestly obsessed with how clean that is ✨
• fwprofiles [<arguments>] — firewall profile management. add, list, or delete (iptables) profiles available for eurephia in the operating system. heads up bestie: this feature is only available if eurephiadm was compiled with firewall support. if it wasn't... yeah. 💀
• adminaccess [<arguments>] — manages eurephia user accesses to administration utilities like eurephiadm. very meta, very powerful 👑
• show-config — lists all config settings set in the database and in the ~/.eurephia/eurephiadm.cfg file. the full picture, periodt.
• show-configfile — similar to the show-config command, but lists only the parsed settings in the ~/.eurephia/eurephiadm.cfg file. just the file, nothing else 💅
• config [<arguments>] — add, delete, or show eurephia configuration settings stored in the database.

---

🎀 FILES 🎀

• ~/.eurephia/eurephiadm.cfg — the default configuration file. it defines the database driver and the needed database parameters. this is home base, bestie 🏠

---

🌈 CONFIGURATION FILE 🌈

so this file is a simple key-value based text file, where keys and values are separated by an equal sign ("="). and anything that comes after a hash ("#") gets ignored and treated as a comment. cute and simple 🍓

these are the variables eurephiadm actually uses:

• database_driver — contains a full path to the database driver eurephiadm needs to use.
• database_params — all the database arguments the database driver requires must go here. check the man page for the corresponding database driver for more info on valid options. iykyk 📖
• log — defines how to log. if you give it a file name, logging gets sent to that log file. other valid values are:
  • stderr: or stdout: — logging goes directly to stderr or stdout.
  • syslog:[local0..local7 | daemon | authpriv] — logging gets sent to syslog. the default syslog destination is daemon.
• log_level — sets the log verbosity. normally the values go from 0 to 10, where 0 is as little logging as possible and 10 is very verbose. and if eurephiadm or the database driver was compiled with debug logging, values up to 50 will be valid. 50!! that's so much logging 😭
• username — eurephiadm will always ask for a user name when logging into the administration application. but by setting this variable, you set a default user name that eurephiadm will use when logging in — so it only asks you for a password directly. the time-saver of the century, honestly 🫶

---

💜 ENVIRONMENT 💜

• EUREPHIA_DIR — the eurephiadm utility looks for a configuration file by default in ~/.eurephia/eurephiadm.cfg. this directory can be overridden by setting the EUREPHIA_DIR environment variable, and eurephiadm will use the eurephiadm.cfg file in this directory instead. relocating your config? slay ✨

---

⭐ SEE ALSO ⭐

• eurephiadm-users(7)
• eurephiadm-lastlog(7)
• eurephiadm-attempts(7)
• eurephiadm-blacklist(7)
• eurephiadm-certs(7)
• eurephiadm-usercerts(7)
• eurephiadm-fwprofiles(7)
• eurephiadm-adminaccess(7)
• eurephiadm-config(7)
• edb-sqlite(7)

---

🌟 AUTHOR 🌟

Copyright (C) 2008-2012 David Sommerseth <dazo@users.sourceforge.net>

---

okay bestie that's the whole page 💖 this version of eurephiadm(7) came out July 2010 from David Sommerseth, and yes she ate. go configure something iconic, you've got this 👑💅🌸