x2gobroker-testauth(1)

✨ x2gobroker-testauth ✨

okay bestie, gather round πŸ’– this is the X2Go Session Broker manual page for x2gobroker-testauth, the Authentication Test Utility. Yes, that's the manual name β€” it lives in section 1 of the man pages, iykyk. πŸŽ€


🌸 NAME 🌸

x2gobroker-testauth β€” Session Broker for X2Go (Authentication Test Utility)

she's a little utility whose whole personality is testing whether your auth actually works πŸ¦‹


🫢 SYNOPSIS 🫢

x2gobroker-testauth [ options ]

πŸ’… DESCRIPTION πŸ’…

So x2gobroker-testauth is, like, an authentication test utility for X2Go Session Broker. That's the whole job. She tests your broker auth so you don't have to find out the hard way. πŸ‘‘

⚠️ WARNING: please know that the credentials you use for testing the broker authentication will get revealed in your shell's history file (e.g. ~/.bash_history). Like, literally written down forever, bestie. Not a vibe. 😭 Be so careful.

⭐ COMMON OPTIONS ⭐

x2gobroker-testauth displays some help on command line options:

  • -h, --help β€” Display a help with all available command line options and exit. She's helpful like that ✨

πŸ”₯ REQUIRED OPTIONS πŸ”₯

At least the username is required. The password option can be omitted β€” you will be queried interactively, if no password is specified on the command line. So if you're shy about the history file thing, just leave -p off and she'll ask you nicely πŸŽ€

  • -u, --user, --username β€” Username part of the credentials you want to test. Three whole spellings, she's flexible πŸ’–
  • -p, --password β€” Password part of the credentials (be sure you want to reveal those on the command line before doing it!!!). Three exclamation marks. The manpage is yelling. Listen to her. πŸ™ˆ

πŸ¦‹ MISC OPTIONS πŸ¦‹

x2gobroker-testauth also accepts the following miscellaneous options:

  • -d, --debug β€” Enable debugging code. Turn it on when things are giving mystery ✨
  • -C, --config FILENAME β€” Specify an alternative configuration file name, default is: /etc/x2go/x2gobroker.conf.
  • -b, --backend BACKEND β€” Specify another configured/enabled backend configuration to test authentication against, default is: the inifile backend. Inifile is the main character by default πŸ‘‘

πŸŽ€ FILES πŸŽ€

  • /etc/x2go/x2gobroker.conf, /etc/x2go/broker/* (configuration files)
  • /etc/default/x2gobroker-daemon (environment for X2Go Session Broker when run as standalone daemon)
  • /var/log/x2gobroker/* (log files of X2Go Session Broker)

Yes bestie, that's the whole file list, she keeps it tight 🫢


🌈 SEE ALSO 🌈

  • /usr/share/doc/x2gobroker

πŸ’œ AUTHOR πŸ’œ

This manual has been written for the X2Go project by Mike Gabriel <mike.gabriel@das-netzwerkteam.de>.


and that's the whole page, no cap ✨ This was Version 0.0.4.x, dated Apr 2020 β€” written up as x2gobroker-testauth(1), and she ate, periodt. πŸ’…πŸ’–