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_base': {'enable': False}, 'broker_inifile': {'auth-mech': '', 'enable': True, 'group-db': '', 'session-profiles': '/etc/x2go/broker/x2gobroker-sessionprofiles.conf', 'use-load-checker': True, 'user-db': ''}, 'broker_ldap': {'agent-query-mode': 'SSH', 'auth-mech': 'ldap', 'base': 'dc=example,dc=org', 'enable': False, 'group-db': 'ldap', 'group-search-filter': '(&(objectClass=posifxGroup)(cn=*))', 'host-search-filter': '(&(objectClass=ipHost)(serial=X2GoServer)(cn=*))', 'load-checker': True, 'starttls': False, 'uri': 'ldap://localhost:389', 'user-db': 'ldap', 'user-search-filter': '(&(objectClass=posixAccount)(uid=*))'}, 'broker_zeroconf': {'auth-mech': 'pam', 'desktop-shell': 'KDE', 'enable': False, 'group-db': 'libnss', 'load-checker': False, 'user-db': 'libnss'}, 'global': {'auth-timeout': 36000, 'check-credentials': True, 'cookie-directory': '/var/lib/x2gobroker/cookies', 'default-agent-hostkey-policy': 'RejectPolicy', 'default-agent-query-mode': 'NONE', 'default-auth-mech': 'pam', 'default-authorized-keys': '%h/.x2go/authorized_keys', 'default-group-db': 'libnss', 'default-portscan-x2goservers': True, 'default-session-autologin': False, 'default-sshproxy-authorized-keys': '%h/.x2go/authorized_keys', 'default-use-load-checker': False, 'default-user-db': 'libnss', 'enable-json-output': True, 'enable-plain-output': True, 'enable-uccs-output': False, 'ignore-primary-group-memberships': True, 'load-checker-intervals': 300, 'my-cookie': None, 'my-cookie-file': '/etc/x2go/broker/x2gobroker.authid', 'my-uccs-url-base': 'http://localhost:8080/', 'post_auth_scripts': [], 'pre_auth_scripts': [], 'require-cookie': False, 'require-password': True, 'select_session_scripts': [], 'use-static-cookie': False, 'verify-ip': True}}¶ 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-any-order': 'deny-allow', 'acl-clients-allow': [], 'acl-clients-deny': [], 'acl-clients-order': '', 'acl-groups-allow': [], 'acl-groups-deny': [], 'acl-groups-order': '', 'acl-users-allow': [], 'acl-users-deny': [], 'acl-users-order': '', 'applications': ['TERMINAL', 'WWWBROWSER', 'MAILCLIENT', 'OFFICE'], 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'dpi': 96, 'export': '', 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['localhost'], 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'layout': '', 'multidisp': False, 'pack': '16m-jpeg', 'print': True, 'quality': 9, 'rootless': True, 'setdpi': 0, 'sndport': 4713, 'sound': True, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyport': 22, 'type': 'auto', 'useexports': True, 'useiconv': False, 'usekbd': True, 'user': 'BROKER_USER', 'variant': '', 'width': 800, 'xinerama': True}}¶ 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.