Panel | |
---|---|
|
Installing and Configuring the Components
UDMG Admin UI
Note |
---|
The following steps require root privilege, make sure that you have the correct access before continuing. |
Extract the distribution file for UDMG Admin UI, under the directory web server root directory, see the NGINX Service configuration above.
Panel |
---|
|
- Validate that the service is working properly:
Panel |
---|
|
UDMG User setup
Create a dedicated user for running the UDMG modules and to be the owner of the files that will be transferred by UDMG.
Panel |
---|
|
UDMG Server
Create the configuration file
/etc/udmg/udmg_server
/server.ini
with the following parameters:
Panel |
---|
|
...
[global]
; The name given to identify this gateway instance. If the the database is shared between multiple gateways, this name MUST be unique across these gateways.
GatewayName = udmg
; Default OS permission for created files
; FilePermissions = 700
; Default OS permission for created directories
; DirPermissions = 750
[paths]
; The root directory of the gateway. By default, it is the working directory of the process.
GatewayHome = /home/udmg
; The directory for all incoming files.
; DefaultInDir = in
; The directory for all outgoing files.
; DefaultOutDir = out
; The directory for all running transfer files.
; DefaultTmpDir = tmp
[log]
; All messages with a severity above this level will be logged. Possible values are DEBUG, INFO, WARNING, ERROR and CRITICAL.
Level = DEBUG
; The path to the file where the logs must be written. Special values 'stdout' and 'syslog' log respectively to the standard output and to the syslog daemon
; LogTo = stdout
; If LogTo is set on 'syslog', the logs will be written to this facility.
; SyslogFacility = local0
[admin]
; The address used by the admin interface.
Host = 0.0.0.0
; The port used by the admin interface. If the port is 0, a free port will automatically be chosen.
Port = 18080
; Path of the TLS certificate for the admin interface.
; TLSCert =
; Path of the key of the TLS certificate.
; TLSKey =
[database]
; Name of the RDBMS used for the gateway database. Possible values: sqlite, mysql, postgresql
Type = postgresql
; Address of the database
Address = localhost
; The name of the database
Name = udmg
; The name of the gateway database user
User = udmg_user
; The password of the gateway database user
Password = udmg_password
; Path of the database TLS certificate file.
; TLSCert =
; Path of the key of the TLS certificate file.
; TLSKey =
; The path to the file containing the passphrase used to encrypt account passwords using AES
; AESPassphrase = passphrase.aes
[controller]
; The frequency at which the database will be probed for new transfers
Delay = 300s
; The maximum number of concurrent incoming transfers allowed on the gateway (0 = unlimited).
; MaxTransferIn = 0
; The maximum number of concurrent outgoing transfers allowed on the gateway (0 = unlimited).
; MaxTransferOut = 0
[sftp]
; Set to true to allow legacy and weak cipher algorithms: 3des-cbc, aes128-cbc, arcfour, arcfour128, arcfour256
; AllowLegacyCiphers = false
- Install the binaries under
/usr/local/bin:
Panel |
---|
|
UDMG Authentication Proxy
Create a directory under
/etc/udmg/:
Panel |
---|
|
- Create a configuration file for the service:
Panel |
---|
|
...
# Proxy Configuration
[proxy]
# Port, default "5000"
port = "5000"
# Network interface, default "0.0.0.0"
inet = "127.0.0.1"
# Enable recover on panic, default true, should be true for production environment
recover = true
# Enable Cross-Origin Resource Sharing (CORS), should be true for production environment
cors = true
# Enable Request Track ID, default true
tracker = true
# Enable Request Logguer, default true
logger = true
# Rate Limit IP Request over 1 second, default 0 (unlimited)
limit = 0
# Enable the Prometheus Metric Endpoint '/metric', default false
metrics = false
...
[[service.local.targets]]
# UDMG Server Hostname or IP
hostname = "localhost"
#
UDMG Server
Portport = 18080
# Service 'mft' with direct authentication on the
UDMG Server
[service.mft]
#
UDMG Server
Listen Protocolprotocol = "http"
[[service.mft.targets]]
#
UDMG Server
Hostname or IPhostname = "localhost"
#
UDMG Server
Portport = 18080
- Install the binary under
/usr/local/bin:
Panel |
---|
|
Configuration for LDAP Authentication
The UDMG Authentication Proxy is capable to use a LDAP Service to authenticate users for UDMG Admin UI:
...
Panel | |
---|---|
|
Pre-Installation / Upgrade Backups
The installation process overwrites the current files (exception: the configuration files are kept), effectively removing your modifications. Backing up these files will optimize the time it takes you to get up and running after installing or upgrading.
After upgrading RPM or DEB packages, review the new configuration file templates (with the extension .rpmnew or .dpk-new) and edit the current configuration files to add new parameters or remove deprecated parameters.
Note | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
If you are upgrading an installation of UDMG from any release prior to 1.3.0.0, you must uninstall the older version before installing the new version.
It may be required to modify the work and data directories ownership or access rights and to update UDMG Server transfer rules to use paths that are accessible by the 'udmg' user. The configuration files must be reviewed and compared between the old and new locations. Special attention is required for the AESpassphrase parameter for UDMG Server. It must be the path for the file that was used by the previous release and must be accessible by the new service user. It is recommened to set an absolute path in the configuration file. |
Upgrading UDMG Server
The UDMG release version is stored in the database to ensure the data structure is compatbile with the version of the UDMG components.
After upgrading the component binaries and before starting the UDMG server it is required to perform the release migration step.
The udmg-server "migrate" command handles the necessay database updates and the setting of the internal version.
Code Block |
---|
$ /opt/udmg/bin/udmg-server migrate --help
Usage:
udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]
Help Options:
-h, --help Show this help message
[migrate command options]
-c, --config= The configuration file to use
-d, --dry-run Simulate the migration but does not commit the changes
-l, --list List Migrations
-f, --file= Writes the migration commands into a file instead of sending them to the database
-v, --verbose Show verbose debug information. Can be repeated to increase verbosity
[migrate command arguments]
version: The version to which the database should be migrated |
The configuration file is the one that will be used for the server mode, with the parameter for accessing the target database.
To get the list of supported target version, use the list parameter. The last version is the release version of the udmg-server.
Code Block |
---|
$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini --list | tail -n 5
0.7.1
0.7.1-sb.1
0.7.1-sb.2
0.7.1-sb.3
1.3.0 |
It is recommended to set the verbose parameter (3 times) to follow the progress.
Code Block |
---|
$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini -vvv 1.3.0.0
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Fix the 'sb_generic_group_join' table foreign keys'
[INFO ] Migration: Applying migration 'Fix the 'sb_user_group_member' table foreign keys'
[INFO ] Migration: Applying migration 'Fix the 'sb_user_group_permission' table foreign keys'
[INFO ] Migration: Applying migration 'Bump database version to 0.7.1-sb.2'
[INFO ] Migration: Applying migration 'Add description under 'local_agents' and 'remote_accounts''
[INFO ] Migration: Applying migration 'Add a 'revoked' column to the 'crypto_credentials' table'
[INFO ] Migration: Applying migration 'Bump database version to 0.7.1-sb.3'
[INFO ] Migration: Applying migration 'Add a 'email' column to the 'users' table'
[INFO ] Migration: Applying migration 'Create the 'access_token' table'
[INFO ] Migration: Applying migration 'Bump database version to 1.3.0' |
After the migration, the service for UDMG Server can be started.
Installing and Configuring the Components
UDMG Admin UI
Note |
---|
The following steps require root privilege, make sure that you have the correct access before continuing. |
Extract the distribution file for UDMG Admin UI, under the directory web server root directory, see the NGINX Service configuration above.
Panel |
---|
|
- Validate that the service is working properly:
Panel |
---|
|
UDMG User setup
Create a dedicated user for running the UDMG modules and to be the owner of the files that will be transferred by UDMG.
Panel |
---|
|
UDMG Server
Create the configuration file /opt/udmg/etc/udmg-server/server.ini with the following parameters:
Panel |
---|
|
Note | ||
---|---|---|
| ||
The lines starting with a semicolon ';' or a hash '#' are comments, describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
Panel |
---|
; The directory for the log files of the local servers, partners, and transfers. No default, if not provided then the detailled log feature is disabled.
; LogPath = /var/opt/udmg/logs
|
Note | ||
---|---|---|
| ||
AESPassphrase file is generated on first run if it does not exist. It is recommended to set an absolute path, otherwise it is created in the curent directory. Make sure to set verify the file location during an upgrade and to have a backup. Without the correct AESPassphrase file, the passwords, the keys and the certificates will not be usable. |
- Install the binaries under /opt/udmg/bin
:
Panel |
---|
|
UDMG Authentication Proxy
Create a directory under
/etc/udmg/:
Panel |
---|
|
- Create a configuration file for the service:
Panel |
---|
|
...
Panel |
---|
|
The LDAP replication requires a user with permission for creating and updating users. For example to create the 'ldap_sync' user with the command line interface:
Panel |
---|
|
In case of successful authentication on the LDAP, the user is created with default read permission in the internal UDMG database if it does not exist. Otherwise the credentials are updated in the database to allow for authentication on the REST and CLI interfaces.
|
Please refer to Authentication Methods for the LDAP and SSO authentication options.
- Install the binary under
/opt/udmg/bin:
Panel |
---|
|
UDMG Agent Proxy
Create a directory under /opt/udmg/etc/mftudmg
:
Panel |
---|
|
- Install the binaries under
/usropt/localudmg/bin:
Panel |
---|
|
Agent Proxy Server Configuration
Generate a SSH Key for the service:
Panel |
---|
|
- Change the agent key permissions:
...
Panel |
---|
|
...
|
...
|
...
Panel |
---|
|
Panel |
|
- Create a configuration file as /opt/udmg/etc/udmg/agent
...
- /
agent.toml:
Panel |
---|
|
Panel |
---|
|
The password key will be used for the client authentication.
Client Configuration
...
|
...
Panel |
---|
|
Panel |
|
The password key will be used for the client authentication.
Agent Proxy Client Configuration
Create a configuration file as
/etc/
udmg
/agent_proxy/client
...
.toml:
Panel |
---|
|
Panel |
---|
|
...
Panel |
---|
[Unit]
Description=UDMG Server
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
ExecStart=/bin/sh -c ' |
...
Panel |
---|
|
Make sure that the listen port and network interface is reachable by UDMG Authentication Proxy and UDMG Agent Client.
...
Panel |
---|
|
...
Panel |
---|
|
Make sure that the listen port and network interface is reachable by NGINX Server.
...
Panel |
---|
[Unit] Description=UDMG Agent Proxy server
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AGENT_PROXY_CONFIG=/opt/udmg/etc/udmg/agent/server.toml"
ExecStart=/bin/sh -c 'exec /usropt/localudmg/bin/udmg-agent-proxy-server'
Restart=on-failure
[Install]
WantedBy=multi-user.target |
...
Panel |
---|
|
...
Panel |
---|
|
- Enable the new service:
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
...
Ports
...
Configuration
Using UDMG with SELinux
- Modify the file label so that NGINX (as a process labeled with the
httpd_t
context) can access the configuration file
...
Panel |
---|
|
- Allow NGINX to reverse proxy through the authentication proxy by setting the
httpd_can_network_connect
boolean
...