Skip to main content

Access Management On-Prem Linux

Specifications​

Minimum Specifications​

  • Linux Ubuntu 22.04 (Server or Desktop) ISO (Installed on VMWare, Hyper-V, Bare Metal)
  • 8GB RAM
  • 50GB Hard Disk Space
  • 2 CPUs
  • Linux Ubuntu 22.04 or newer (Server or Desktop) ISO (Installed on VMWare, Hyper-V, Bare Metal)
  • 12GB RAM
  • 100GB Hard Disk Space
  • 4 CPUs
  • Linux Ubuntu 22.04 or newer (Server or Desktop) ISO (Installed on VMWare, Hyper-V, Bare Metal)
  • 16GB RAM
  • 200GB Hard Disk Space
  • 6 CPUs
  • Linux Ubuntu 22.04 or newer (Server or Desktop) ISO (Installed on VMWare, Hyper-V, Bare Metal)
  • 32GB RAM
  • 500GB Hard Disk Space
  • 8 CPUs

Pre-requisites​

  • A linux server with internet access
  • A user account capable of running commands with elevated permissions (sudo membership)
  • A DNS A record that matches the FQDN that will be used to access Access Management.
DNS

If you are using the pre-configured SSL Certificate and would like to publish your Access Management Tenant externally, please email SecurEnvoy support with this requirement, along with your tenant name and Public IP address that this will resolve to, and we can register this in our DNS records.

Setup​

1. Download and run the installer​

Use "wget" to download the latest Access Management On-Premise executable from SecurEnvoy: wget https://software.securenvoy.com/am/80589bfc-d587-4cc2-9284-4301b6cd6901/AccessManagement.
Change the permissions on the downloaded file to allow execution: sudo chmod +x AccessManagement.
Run the Access Management installer sudo ./AccessManagement.

The installer will now present the interactive installation steps.

2. Choose a language for the installation process.​

Language

3. Accept the EULA.​

EULA

4. Select 'New' to install a new installation.​

New

5. Specify the installation path.​

By default this is /usr/local/bin/securenvoy/access-management.

Path

6. Specify Single Tenant or MSP.​

Choose if the installation is for a single tenant (most common) or for multiple tenants (for MSPs).

Tenant Type

7. Enter the initial admin credentials.​

The email address will be used for the default administrator account. The password will be changed upon first login.

Admin Password

8. Choose a certificate.​

Select whether to use the preconfigured SSL certificate provided by SecurEnvoy (companyname.access-mgmt.directory) or provide a custom SSL certificate.

Preconfigured Cert

9. This step will differ depending on which certificate option you selected:​

Use Pre-Configured Domain and Certificate

Specify the sub domain that you will use for Access Management. We recommend using your company name here.

Your server will be configured to respond to requests to <sub domain>.access-mgmt.directory.

Subdomain

Use Your Own Custom Domain and Certificate

Enter the path to the certificate file.

Cert1

Note on Certificates

This must be a client certificate (i.e. not a CA certificate), and must be in .pfx format. The CN of the certificate will depend on whether you chose single or multiple tenant support:

Single Tenant Support

The CN should be the full hostname that you intend to use for Access Management (e.g. accessmanagement.company.com)

Multiple Tenant Support

The CN should be a wildcard domain that will cover all hostnames you intend to use for Access Management (e.g. *.accessmanagement.company.com)

Enter the domain for the certificate. For multiple tenant support, remove the wildcard part of the domain (e.g for *.accessmanagement.company.com, enter accessmanagement.company.com)

Cert2

Enter the password for the certificate.

IMAGE HERE

10. Set a password for the database.​

Make sure to store this password securely as you will not be able to change the database without it.

Database Password

11. Check the configured settings.​

Confirm the details are correct before proceeding with the next steps.

Confirm

12. Choose the Docker options.​

Select whether to install Docker (required unless already installed) and run the Docker compose script.

Docker Script

SecurEnvoy Access Management will now download and install the latest Docker images.

Docker Install

Once the installation process has completed, check that the containers are running by running the following command: sudo docker ps.

Access Management is now ready to use.

13. Sign in to Access Management.​

Go to the Access Management URL configured in step 11, for example: https://securenvoy.example.com. Sign in with the 'administrator' username and the password created in step 9.
Access Management will show a prompt to change the administrator password. Ensure this password is stored securely.

MSP Default Tenant

If Access Management was configured for multiple tenants there will be a default tenant called 'admin'. In this example this would be reachable at: https://admin.securenvoy.example.com.

Upgrade​

Upgrade Downtime

This will temporarily stop your service until new Docker images have been pulled and restarted.

  1. Navigate to the Access Management installation directory. By default this is: cd /usr/local/bin/securenvoy/access-management.
  2. Stop the containers by using the command: sudo docker compose down.
  3. Use "wget" to download the latest Access Management On-Premise executable from SecurEnvoy. wget https://software.securenvoy.com/am/80589bfc-d587-4cc2-9284-4301b6cd6901/AccessManagement
  4. Change the permissions on the downloaded file to allow execution. sudo chmod +x AccessManagement
  5. Run the Access Management installer. sudo ./AccessManagement

The installer will now present the interactive installation steps.

  1. Choose a language for the installation process.

Language

  1. Accept the EULA.

EULA

  1. Select 'Upgrade' to update an existing installation.

Upgrade

  1. Specify the installation location. By default this is /usr/local/bin/securenvoy/access-management.

Path

  1. Confirm the details are correct before proceeding with the next steps.

Confirm

  1. As Docker will already be installed, only select 'Run Docker Compose Script'

Docker Script

SecurEnvoy Access Management will now download and install the latest docker images.

  1. Once the installation process has comleted, check that the containers are running by running sudo docker ps.