x2goserver-run-extensions(8)

💖 x2goserver-run-extensions 💖

okay bestie, this is a page from the X2Go Server Tool manual set, and it's about x2goserver-run-extensions(8) — the little script-runner that lets third-party extension packages do their thing without anyone having to touch the X2Go core. buckle up, it's giving ✨ infrastructure ✨.

---

✨ NAME ✨

x2goserver-run-extensions — run X2Go Server extensions 🧚

---

🌸 SYNOPSIS 🌸

x2goserver-run-extensions <session_id> <modality>

---

🦋 DESCRIPTION 🦋

x2goserver-run-extensions is called from within a number of X2Go Server core scripts. it's a backstage-pass situation, iykyk.

⚠️ WARNING: do not call it directly unless you really, really know what you're doing. like, genuinely. no cap.

what it does: x2goserver-run-extensions executes scripts that have been provided by third-party X2Go extension packages. slay.

but the tea is — this man page is not actually about how to use the script itself. it's about how you provide X2Go server extensions and features without needing to change the core X2Go server scripts. that's the whole point, and honestly? iconic design. periodt.

---

👑 MODALITIES 👑

x2goserver-run-extensions gets called with user privileges. the first command line argument is the session ID, and the second command line argument is a so-called modality.

that modality is basically a little vibe check for the calling script: it tells x2goserver-run-extensions at what stage of an X2Go session startup, resumption, suspension or termination the caller currently is at. 💅

these X2Go Server core scripts currently call x2goserver-run-extensions:

• x2gostartagent(8)
• x2goruncommand(8)
• x2goresume-session(8)
• x2gosuspend-session(8)
• x2goterminate-session(8)

every modality name refers to a sub-directory of this path:

<libexecdir>/x2go/extensions

where <libexecdir> is /usr/libexec/x2go or /usr/lib/x2go on commonly-used GNU/Linux systems. yes, both, depends on your distro's whole thing. 🫶

so in any of these sub-directories, third-party X2Go extension packages can drop scripts or binaries — and those then get executed by the core X2Go server commands, either before or after the essential functionality (think x2goagent startup, x2goagent suspension, x2goagent resumption, etc.) or on failure of that essential functionality. a whole little choreography. 🌈

here's the full rundown of available modalities, which script calls them, and where you park your extension scripts:

x2gostartagent calls:

• pre-start → scripts live in extensions/pre-start.d/
• post-start → scripts live in extensions/post-start.d/
• fail-start → scripts live in extensions/fail-start.d/

x2goruncommand calls:

• pre-runcommand → scripts live in extensions/pre-runcommand.d/
• post-runcommand → scripts live in extensions/post-runcommand.d/
• fail-runcommand → scripts live in extensions/fail-runcommand.d/

x2goresume-session calls:

• pre-resume → scripts live in extensions/pre-resume.d/
• post-resume → scripts live in extensions/post-resume.d/
• fail-resume → scripts live in extensions/fail-resume.d/

x2gosuspend-session calls:

• pre-suspend → scripts live in extensions/pre-suspend.d/
• post-suspend → scripts live in extensions/post-suspend.d/
• fail-suspend → scripts live in extensions/fail-suspend.d/

x2goterminate-session calls:

• pre-terminate → scripts live in extensions/pre-terminate.d/
• post-terminate → scripts live in extensions/post-terminate.d/
• fail-terminate → scripts live in extensions/fail-terminate.d/

🚨 IMPORTANT: when you're providing X2Go Server extensions through this mechanism, please pretty well make sure that the extension scripts you place in either of the above folders do under no circumstance fail during execution. return codes are ignored and failures are therefore not (yet) propagated. so like, your script's little feelings are not being heard. write defensively, bestie. 😭

---

💀 EXECUTION OF EXTENSIONS 💀

scripts (or binaries) that have been placed into one of the pre/post/fail modality folders (see above 👆) get executed in alpha-numerical sorting order. alphabetical, basically. orderly. cute.

but here's the catch, and it's a big one: extensions will only get executed if their file names start with three digits followed by an underscore character. ___ style. that restriction is in place to make sure X2Go Server extensions get executed in the correct/wanted order. the vibes must be sequenced. 🔥

for example:

010_x2goserver-statistics
020_x2goserver-mail-notify
021_x2goserver-monitoring
etc. pp.

see how they line up? 010 before 020 before 021. chef's kiss. 👑

---

💜 RETURN VALUES 💜

x2goserver-run-extensions always returns 0 as exit code and pretends to be permanently happy :-).

that's it. that's the return value. it's thriving. it refuses to elaborate. 🙈

---

⭐ SEE ALSO ⭐

x2gostartagent(8), x2goruncommand(8), x2goresume-session(8), x2gosuspend-session(8) and x2goterminate-session(8).

---

🎀 AUTHOR 🎀

this manual has been written by Mike Gabriel <mike.gabriel@das-netzwerkteam.de> for the X2Go project (https://www.x2go.org).

---

and that's the whole page, bestie!! 🫶 this was Version 4.1.0.6, dated Aug 2023, and it's the x2goserver-run-extensions(8) page — go forth and write extensions that never fail, mwah 💅✨