Python X2Go Broker API Documentation (v0.0.4.4)

x2gobroker.defaults module

«  x2gobroker.config module   ::   Contents   ::   x2gobroker.loadchecker module  »

x2gobroker.defaults module

X2Go Session Brokers uses many hard-coded defaults, that can be overridden in various ways:

  • environment variables of the same name as the variable name in Python
  • for SysV init system: environment variables set in a default configuration file under /etc/default; normally the naming scheme is /etc/default/<executable-name>
  • for systemd init system: in the file /etc/x2go/broker/defaults.conf: this file should be installed on your system, the file needs to be provided in INI file format
x2gobroker.defaults.DAEMON_BIND_ADDRESS = ''

Bind address for the X2Go Session Broker standalone daemon.

x2gobroker.defaults.X2GOBROKER_AGENT_CMD = '/usr/lib/x2go/x2gobroker-agent'

Path to the X2Go Broker Agent executable on remote X2Go Servers.

x2gobroker.defaults.X2GOBROKER_AGENT_USER = 'x2gobroker'

The system user to use when launching X2Go Broker Agent on remote X2Go Servers.

x2gobroker.defaults.X2GOBROKER_AUTHSERVICE_SOCKET = '/var/run/x2gobroker/x2gobroker/x2gobroker-authservice.socket'

Location of the X2Go Broker Auth Service’s authentication socket file.

x2gobroker.defaults.X2GOBROKER_CONFIG = '/etc/x2go/x2gobroker.conf'

Location of X2Go Broker’s global configuration file.

x2gobroker.defaults.X2GOBROKER_CONFIG_DEFAULTS = {'broker_ldap': {'uri': 'ldap://localhost:389', 'user-search-filter': '(&(objectClass=posixAccount)(uid=*))', 'starttls': False, 'group-search-filter': '(&(objectClass=posifxGroup)(cn=*))', 'auth-mech': 'ldap', 'load-checker': True, 'user-db': 'ldap', 'group-db': 'ldap', 'agent-query-mode': 'SSH', 'base': 'dc=example,dc=org', 'enable': False, 'host-search-filter': '(&(objectClass=ipHost)(serial=X2GoServer)(cn=*))'}, 'broker_zeroconf': {'load-checker': False, 'user-db': 'libnss', 'enable': False, 'auth-mech': 'pam', 'group-db': 'libnss', 'desktop-shell': 'KDE'}, 'broker_inifile': {'use-load-checker': True, 'user-db': '', 'auth-mech': '', 'group-db': '', 'enable': True, 'session-profiles': '/etc/x2go/broker/x2gobroker-sessionprofiles.conf'}, 'broker_base': {'enable': False}, 'global': {'enable-uccs-output': False, 'enable-json-output': True, 'select_session_scripts': [], 'default-use-load-checker': False, 'use-static-cookie': False, 'my-cookie-file': '/etc/x2go/broker/x2gobroker.authid', 'default-session-autologin': False, 'pre_auth_scripts': [], 'check-credentials': True, 'default-authorized-keys': '%h/.x2go/authorized_keys', 'default-agent-query-mode': 'NONE', 'default-user-db': 'libnss', 'verify-ip': True, 'auth-timeout': 36000, 'default-auth-mech': 'pam', 'load-checker-intervals': 300, 'require-password': True, 'require-cookie': False, 'default-sshproxy-authorized-keys': '%h/.x2go/authorized_keys', 'my-cookie': None, 'default-agent-hostkey-policy': 'RejectPolicy', 'default-portscan-x2goservers': True, 'enable-plain-output': True, 'cookie-directory': '/var/lib/x2gobroker/cookies', 'post_auth_scripts': [], 'ignore-primary-group-memberships': True, 'my-uccs-url-base': 'http://localhost:8080/', 'default-group-db': 'libnss'}}

Defaults of the global configuration file, see X2GOBROKER_CONFIG.

x2gobroker.defaults.X2GOBROKER_DEBUG_INTERACTIVELY = False

When set to True, the X2Go Broker component this parameter is set for, runs in foreground and debugging mode.

x2gobroker.defaults.X2GOBROKER_DEFAULT_BACKEND = 'inifile'

The broker backend to use by default.

x2gobroker.defaults.X2GOBROKER_GROUP = '<some-group>'

The (system) group, X2Go Session Broker runs under. Whether this is a system user or e.g. the x2gobroker-users group is dependent on what component of the broker is used.

x2gobroker.defaults.X2GOBROKER_HOME = '~x2gobroker'

Home directory of the user that an X2Go Broker component runs under.

x2gobroker.defaults.X2GOBROKER_LATEST_UCCS_API_VERSION = 5

Latest known API of the UCCS protocol that we support.

x2gobroker.defaults.X2GOBROKER_LOADCHECKER_SOCKET = '/var/run/x2gobroker/x2gobroker/x2gobroker-loadchecker.socket'

Location of the X2Go Broker Load Checker’s communication socket file.

x2gobroker.defaults.X2GOBROKER_SESSIONPROFILES = '/etc/x2go/broker/x2gobroker-sessionprofiles.conf'

Location of the INI file based broker backend ‘s session profiles configuration file.

x2gobroker.defaults.X2GOBROKER_SESSIONPROFILE_DEFAULTS = {'DEFAULT': {'acl-users-order': '', 'soundtunnel': True, 'acl-any-order': 'deny-allow', 'sshport': 22, 'layout': '', 'export': '', 'speed': 2, 'iconvto': 'UTF-8', 'acl-clients-allow': [], 'acl-groups-deny': [], 'acl-users-allow': [], 'iconvfrom': 'UTF-8', 'setdpi': 0, 'acl-groups-allow': [], 'acl-clients-deny': [], 'pack': '16m-jpeg', 'acl-groups-order': '', 'command': 'TERMINAL', 'directrdp': False, 'sndport': 4713, 'useiconv': False, 'user': 'BROKER_USER', 'xinerama': True, 'sshproxyport': 22, 'type': 'auto', 'applications': ['TERMINAL', 'WWWBROWSER', 'MAILCLIENT', 'OFFICE'], 'quality': 9, 'rootless': True, 'sound': True, 'fullscreen': False, 'host': ['localhost'], 'variant': '', 'print': True, 'fstunnel': True, 'useexports': True, 'dpi': 96, 'defsndport': True, 'soundsystem': 'pulse', 'acl-clients-order': '', 'usekbd': True, 'width': 800, 'acl-users-deny': [], 'height': 600, 'kdrive': False, 'multidisp': False}}

Default setting of a broker’ish session profile.

x2gobroker.defaults.X2GOBROKER_SSL_CERTFILE = ''

Path to the SSL/TLS public certificate file.

x2gobroker.defaults.X2GOBROKER_SSL_KEYFILE = ''

Path to the SSL/TLS secret key file.

x2gobroker.defaults.X2GOBROKER_USER = '<some-user>'

The (system) user, X2Go Session Broker runs under. Whether this is a system user or e.g. your own user account depends on what component of the broker is used.

x2gobroker.defaults.X2GO_DESKTOP_SESSIONS = ['KDE', 'GNOME', 'XFCE', 'CINNAMON', 'MATE', 'XFCE', 'LXDE', 'TRINITY', 'UNITY', 'ICEWM', 'OPENBOX', 'XDMCP']

Desktop environment session types supported by X2Go.

«  x2gobroker.config module   ::   Contents   ::   x2gobroker.loadchecker module  »