---
name: "x2gobroker-authservice"
section: "8"
platform: "linux"
package: "x2gobroker-authservice"
version: "0.0.4.3-4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/x2gobroker-authservice"
---

# x2gobroker-authservice(8)

PAM authentication service for X2Go Session Broker

## NAME

x2gobroker-authservice - PAM authentication service for X2Go Session Broker

## SYNOPSIS

**x2gobroker-authservice**  \[ *options* \]

## DESCRIPTION

**x2gobroker-authservice** is a PAM authentication service for X2Go Session Broker. Whereas the X2Go Session Broker runs as a non-privileged user (standalone daemon mode) or as the also non-privileged httpd server's system user (WSGI mode), an authentication against PAM requires root privileges in most cases (esp. for pam\_unix.so).

Thus, the PAM authentication has been moved into a separate service. The communication between X2Go Session Broker and PAM Authentication Service is handled through a unix domain socket file (*\<RUNDIR\>/x2gobroker/x2gobroker-authservice.socket*).

This command is normally started through the host's init system.

## COMMON OPTIONS

**x2gobroker-authservice** accepts the following common options:

- FC**-h, --help**F\[0\]

  Display a help with all available command line options and exit.

- FC**-D, --daemonize**F\[0\]

  Fork this application to background and detach from the running terminal.

- FC**-P, --pidfile**F\[0\]

  Custom PID file location when daemonizing (default: *\<RUNDIR\>/x2gobroker/x2gobroker-authservice.pid*).

- FC**-L, --logdir**F\[0\]

  Directory where stdout/stderr will be redirected after having daemonized (default: */var/log/x2gobroker/*).

- FC**-s \<AUTHSOCKET\>, --socket \<AUTHSOCKET\>**F\[0\]

  File name of the unix domain socket file used for communication between broker and authentication service.

- FC**-o \<OWNER\>, --owner \<OWNER\>**F\[0\]

  User ownership of the *\<AUTHSOCKET\>* file.

- FC**-g \<GROUP\>, --group \<GROUP\>**F\[0\]

  Group ownership of the *\<AUTHSOCKET\>* file.

- FC**-p \<PERMISSIONS\>, --permissions \<PERMISSIONS\>**F\[0\]

  Set these file permissions for the *\<AUTHSOCKET\>* file. Use numerical permissions (e.g. 0640).

## FILES

\<RUNDIR\>/x2gobroker/x2gobroker-authservice.socket

## AUTHOR

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