Configuration

Server configuration

The sshGate server configuration is located in /etc/sshgate.conf file. This file contain main settings and can override some internal settings (mostly directories locations).

Before reading this page, read sshGate-server: Description of directories and files.

Main settings

Here is the list of all settings which must be set in /etc/sshgate.conf :

• SSHGATE_VERSION : version of sshGate (do not edit)
• SSHGATE_BUILD : the build number of sshGate (do not edit)
• SSHGATE_DIRECTORY : root directory of sshGate program
• SCRIPT_HELPER_DIRECTORY : ScriptHelper dependance directory
• SSHGATE_GATE_ACCOUNT : the unix account used by sshGate
• SSHGATE_ALLOW_REMOTE_COMMAND : Do we allow remote command like "sshg 'cmd list targets'" ? default: Y
• SSHGATE_USE_REMOTE_ADMIN_CLI : Do we allow remote administration CLI ? default: Y
• SSHGATE_USERS_MUST_ACCEPT_TOS : Do users have to accept TOS at the first connection ? default: Y
• SSHGATE_EDITOR : editor program to use by sshGate. default: ${EDITOR}
• SSHGATE_TARGETS_SCP_PATH : default SCP path when it's not specified. default: ~/
• SSHGATE_TARGET_DEFAULT_SSH_LOGIN : default ssh login to use when connecting to target host. default: root
• SSHGATE_MAIL_SEND : Is sshGate mail notification activated ? default: false
• SSHGATE_MAIL_TO : mail to this mail adresse if {SSHGATE_MAIL_SEND} is 'true'
• SSHGATE_MAIL_SUBJECT : E-mail subject to use
• SSHGATE_DEFAULT_LANGUAGE : Default language to use for template (TOS, mail) default: us

Other settings

Those settings are define in [SSHGATE_DIRECTORY]/data/sshgate.setup file in default settings. This file is a batch file which is interpret and set some default settings and internal settings.

Here is the list of settings defined in sshgate.setup file :

• SSHGATE_DIR_DATA : sshGate data root directory
• SSHGATE_DIR_TEMPLATES : Directory containing multi-language templates
• SSHGATE_DIR_BIN : binaries of sshGate.
• SSHGATE_DIR_CORE : all sshGate 'func' and 'core' files (internal sshGate library)
• SSHGATE_DIR_TEST : sshGate test files
• SSHGATE_DIR_USERS : users data (ssh keys and properties)
• SSHGATE_DIR_TARGETS : targets data (ssh keys, properties, access, logins, ...)
• SSHGATE_DIR_USERS_GROUPS : usergroups data
• SSHGATE_DIR_LOGS : logs root directory
• SSHGATE_DIR_LOGS_TARGETS : targets logs directory
• SSHGATE_DIR_LOGS_USERS : users logs directory
• SSHGATE_DIR_ARCHIVE : logs archives directory
• SSHGATE_TARGET_PRIVATE_SSHKEY_FILENAME : filename of the target private ssh key
• SSHGATE_TARGET_PUBLIC_SSHKEY_FILENAME : filename of the target public ssh key
• SSHGATE_TARGET_DEFAULT_PRIVATE_SSHKEY_FILE : path to the default target private ssh key file
• SSHGATE_TARGET_DEFAULT_PUBLIC_SSHKEY_FILE : path to the default target public ssh key file
• SSHGATE_TARGETS_USER_ACCESS_FILENAME : name of the target users access file
• SSHGATE_TARGETS_USERGROUP_ACCESS_FILENAME : name of the target usergroup access file
• SSHGATE_TARGETS_SSH_CONFIG_FILENAME : name of the target ssh configuration file
• SSHGATE_TARGETS_SSH_LOGINS_FILENAME : name of the target ssh login list file
• SSHGATE_LOGS_CURRENT_SESSION_FILE : path to the current session log file
• SSHGATE_TOS_FILENAME : name of the file containing the TOS (Term Of Service)

Default values :

• SSHGATE_DIR_DATA : {SSHGATE_DIRECTORY}/data/
• SSHGATE_DIR_TEMPLATES : {SSHGATE_DIR_DATA}/templates/
• SSHGATE_DIR_BIN : {SSHGATE_DIRECTORY}/bin/
• SSHGATE_DIR_CORE : {SSHGATE_DIR_BIN}/core/
• SSHGATE_DIR_TEST : {SSHGATE_DIR_BIN}/tests/
• SSHGATE_DIR_USERS : {SSHGATE_DIRECTORY}/users/
• SSHGATE_DIR_TARGETS : {SSHGATE_DIRECTORY}/targets/
• SSHGATE_DIR_USERS_GROUPS : {SSHGATE_DIRECTORY}/usergroups/
• SSHGATE_DIR_LOGS : {SSHGATE_DIRECTORY}/logs/
• SSHGATE_DIR_LOGS_TARGETS : {SSHGATE_DIR_LOGS}/targets-logs/
• SSHGATE_DIR_LOGS_USERS : {SSHGATE_DIR_LOGS}/users-logs/
• SSHGATE_DIR_ARCHIVE : {SSHGATE_DIRECTORY}/archive/
• SSHGATE_TARGET_PRIVATE_SSHKEY_FILENAME : sshkey.priv
• SSHGATE_TARGET_PUBLIC_SSHKEY_FILENAME : sshkey.pub
• SSHGATE_TARGET_DEFAULT_PRIVATE_SSHKEY_FILE : {SSHGATE_DIR_DATA}/{SSHGATE_TARGET_PRIVATE_SSHKEY_FILENAME}
• SSHGATE_TARGET_DEFAULT_PUBLIC_SSHKEY_FILE : {SSHGATE_DIR_DATA}/{SSHGATE_TARGET_PUBLIC_SSHKEY_FILENAME}
• SSHGATE_TARGETS_USER_ACCESS_FILENAME : access.users
• SSHGATE_TARGETS_USERGROUP_ACCESS_FILENAME : access.groups
• SSHGATE_TARGETS_SSH_CONFIG_FILENAME : ssh_conf
• SSHGATE_TARGETS_SSH_LOGINS_FILENAME : ssh_logins.conf
• SSHGATE_LOGS_CURRENT_SESSION_FILE : {SSHGATE_DIR_LOGS}/current_session.log
• SSHGATE_TOS_FILENAME : TOS.txt