Panel | |
---|---|
|
Installing and Configuring the Components
UDMG Admin UI
Uncompress the tar file for UDMG Admin UI, under the directory that we created during the configuration.
Panel |
---|
|
- Validate that the service is working properly with curl
Panel |
---|
|
or with the browser:
UDMG Server
Create a directory
C:\UDMG\
UDMG Server
Install the binaries as
andudmg-server.exe
udmg-client.exe
- Create the configuration file
C:\UDMG\
UDMG Server\server.ini
...
[global]
; The name given to identify this UDMG Server instance. If the the database is shared between multiple servers, this name MUST be unique across these
servers
.GatewayName = udmg
; Default OS permission for created files
; FilePermissions = 700
; Default OS permission for created directories
; DirPermissions = 750
...
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.
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 new paths. The configuration files must be reviewed and compared between the old and new versions. 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 recommended 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 |
---|
C:\UDMG\UDMG Server>udmg-server migrate /?
Usage:
udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]
Help Options:
/? Show this help message
/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 |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /list
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 |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /v /v /v 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
Extract the zip file for UDMG Admin UI, under the directory that was created during the NGINX installation.
Panel |
---|
|
- Validate that the service is working properly with curl
Panel |
---|
|
or with the browser:
UDMG Server
Create a directory
C:\UDMG\
UDMG Server
Install the binaries as
andudmg-server.exe
udmg-client.exe
- Create the configuration file
C:\UDMG\
UDMG Server\server.ini
Note | ||
---|---|---|
| ||
The lines starting with a colon ';' or a hash '#' are comments, describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
Panel |
---|
; API rate limiter: number of allowed requests per client IP, per second. After that HTTP code 429 is returned. Disabled if 0 or not provided.
; RateLimit = 0
|
Note | ||
---|---|---|
| ||
AESPassphrase file is generated on first run if it does not exist. Make sure to set verify the file location during upgrade and to have a backup. Without the correct AESPassphrase file, the passwords, the keys and the certificates will not be usable. |
UDMG Authentication Proxy
Create a directory
C:\UDMG\MFT Auth UDMG
Auth Proxy
Install the binaries as
udmg-auth-proxy.exe
Create the configuration file
C:\UDMG\MFT UDMG Auth Proxy\config.toml
Panel |
---|
|
Configuration for LDAP Authentication
The UDMG Authentication Proxy is capable to use a LDAP Service to authenticate users for UDMG Admin UI:
...
# Service 'local' with direct authentication on the UDMG Server
[service.local]
# UDMG Server Listen Protocol
protocol = "http"
[[service.local.targets]]
# UDMG Server Hostname or IP
hostname = "localhost"
# UDMG Server Port
port = 18080
...
[[service.mft.targets]]
# UDMG Server Hostname or IP
hostname = "localhost"
# UDMG Server Port
port = 18080
# User for Sync Password Between Ldap and Proxy
[service.mft.credential]
# Pre - Setup user under UDMG Server
username = "ldap_sync"
password = "ldap_password"
# LDAP Configuration
[service.mft.auth.ldap]
# LDAP Server DC with OU
dn = "ou=users,dc=stonebranch,dc=com"
# LDAP Server FQDN or IP
hostname = "myldap.server.fqdn.com"
# LDAP Server pORT
port = 1389
Note |
---|
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:
|
UDMG Agent Proxy
Create a directory
C:\UDMG\UDMG Agent
Install the binaries as
udmg-agent-proxy-client.exe
andudmg-agent-proxy-server.exe
Agent Configuration
Generate a SSH Key for the service.
For example with the ssh-keygen tool that is provided by Windows OpenSSH tools (Key-based authentication in OpenSSH for Windows), or by 3PP packages like Copssh - OpenSSH for Windows or Portable Git for Windows
Panel |
---|
|
If OpenSSH is not installed or not available, the PuTTY tool can be used instead.
Use PuTTYgen to generate a key pair for the agent, more detailled instructions can be found here: Using public keys for SSH authentication
After generating the key, export it with OpenSSH format:
Create a configuration file as
C:\UDMG\UDMG Agent\agent\agent.toml
Panel |
---|
|
The password key will be used for the client authentication.
Client Configuration
Create a configuration file as
C:\UDMG\UDMG Agent\client\client.toml
Panel |
---|
|
The password key will be used for the client authentication.
Setup the Windows Services
The UDMG components can be installed as Windows service with the WinSX tool.
NGINX Server
- Download WinSX and copy
winsw.exe
underC:\UDMG\nginx
with the following name:nginx-service
.exe
- Create a new service definition file:
nginx-service
.yml
Panel |
---|
|
- Create a stop script:
nginx-stop.cmd
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
UDMG Server
- Download WinSX and copy
winsw.exe
underC:\UDMG\UDMG Server
with the following name:udmg-server-service
.exe
- Create a new service definition file:
udmg-server-service
.yml
Panel |
---|
|
Please refer to Authentication Methods for the LDAP and SSO authentication options.
UDMG Agent Proxy
Create a directory
C:\UDMG\UDMG Agent
Install the binaries as
udmg-agent-proxy-client.exe
andudmg-agent-proxy-server.exe
Agent Proxy Server Configuration
Generate a SSH Key for the service.
For example with the ssh-keygen tool that is provided by Windows OpenSSH tools (Key-based authentication in OpenSSH for Windows), or by 3PP packages like Copssh - OpenSSH for Windows or Portable Git for Windows
Panel |
---|
|
If OpenSSH is not installed or not available, the PuTTY tool can be used instead.
Use PuTTYgen to generate a key pair for the agent, more detailled instructions can be found here: Using public keys for SSH authentication
After generating the key, export it with OpenSSH format:
Create a configuration file as
C:\UDMG\UDMG Agent\agent\agent.toml
Panel |
---|
|
The password key will be used for the client authentication.
Agent Proxy Client Configuration
Create a configuration file as
C:\UDMG\UDMG Agent\client\client.toml
Panel |
---|
|
The password key will be used for the client authentication.
Setup the Windows Services
The UDMG components can be installed as Windows service with the WinSw tool.
NGINX Server
- Download WinSW and copyy
winsw.exe
underC:\UDMG\nginx
with the following name:nginx-service
.exe
- Create a new service definition file:
nginx-service
.yml
Panel |
---|
|
- Create a stop script:
nginx-stop.cmd
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
UDMG Server
- Download WinSW and copy
winsw.exe
underC:\UDMG\UDMG Server
with the following name:udmg-server-service
.exe
- Create a new service definition file:
udmg-server-service
.yml
Here is the minimal version of the file with the required configuration parameters, make sure that the paths are correct
Panel |
---|
|
Here is another version with the full set of parameters and their description, it can be used as a template for tweaking the service settings.
Panel |
---|
|
Note | ||
---|---|---|
| ||
The rollover of the service log file is disabled as it causes a bug of the WinSW application, see |
- Start the service and check the status:
...
UDMG Authentication Proxy
- CopyDownload WinSW and copy
winsw.exe
underC:\UDMG\
with the following name:UDMG Auth Proxy
udmg-auth-proxy-service
.exe
- Create a new service definition file:
udmg-auth-proxy
-service
.yml
...
Agent Proxy Server Service
- CopyDownload WinSW and copy
winsw.exe
underC:\UDMG\UDMG Agent\agent
with the following name:udmg-agent-proxy-server-service.exe
- Create a new service definition file:
udmg-agent-proxy-server-service
.yml
...
Agent Proxy Client Service
- CopyDownload WinSW and copy
winsw.exe
underC:\UDMG\UDMG Agent\client
with the following name:udmg-agent-proxy-client-service.exe
- Create a new service definition file:
udmg-agent-proxy-client-service
.yml
...
Panel |
---|
|
...
Ports
...
Configuration
References
This document references the following documents.
Name | Location |
---|---|
PostgreSQL Client Authentication | |
PostgreSQL Password Authentication | |
Guide on setting up Nginx as a service on Windows | https://github.com/sheggi/win-service-nginx |
...