Wizard - Configuration
Armando Carratala
Julio D'Angelo
Nestor Markowicz
Alison Wizard docker image includes an ACME tenant inside.
You must overwrite that definition to include your own company or project tenants.
Wizard can manage several tenants, each one of them defining logo, styles, certificate filter, and validation. A detailed description of validation can be found in the Debbie module.
Wizard Configuration
Environment Variables
Configure the following variables to customize your wizard instance.
Key | Description | Value example |
---|---|---|
ENABLED_TENANTS | List of enabled tenants separated by a comma. | acme, looney |
WIZARD_SECRET_KEY_BASE | Internal encryption key. It's a random 128 hexadecimal characters long key. Create your own key and replace it. | 95820b3cea66376d0...95820 |
BASE_INSTALLERS_PATH | URL where Alison Desktop installers for Windows, Mac, and Linux are published. Depending on your configuration, this URL can be internal or external. | https://download.yousite.com/installers. Inside of this directory you have to create a subfolder for each product version as it is described below. |
DEBBIE_BASE_URL | URL where Debbie - Validation Service service will be listening. Debbie is used to test and validate certificates. | https://debbie-site:4443 You don't need to expose this site to the internet, just need to be accessed by Alison Wizard. |
COMPANY_SITE_URL | URL to the company site. | https://www.certisur.com/ |
ENABLED_BROWSERS | List of enabled browsers supported by the wizard. | ie[>=8],chrome,firefox,opera, edge,safari |
ENABLED_PLATFORMS | List of enabled platforms supported by the wizard. | windows, mac, Linux |
DISABLE_PLUGINS | Disable the installation of plugins for Firefox, Chrome, and Internet Explorer. | false | true |
ENABLE_32BITS | Enable the distribution of 32 bits packages for Windows platform. The package must have the following format: <ProductName>-Installer_x86-<version>.exe Default: false Available from version: 1.9.6.1 Disabled from version: 2.0.3.0 | false | true |
WIZARD_LANGUAGE | Default language to be used by the wizard. | en |
Volumes
The following volumes can be mounted on the Docker image to overwrite the variables of each defined tenant.
Source (host) | Path (container) | Description |
---|---|---|
./wizard/images | /opt/jboss/config/images | Browser and platform Images |
./wizard/tenants | /opt/jboss/config/tenants | Published tenants |
./wizard/locales | /opt/jboss/config/locales | Text included on any page. |
You can download this Images and Languages file, which includes language, instructions, and images. This structure can change between different wizard versions, so you can also extract the same contains from your downloaded docker image. It's recommended to check this before if you decide to customize the content.
├── debbie ├── docker-compose.yml └── wizard ├── alison-sdk ├── images ├── locales ├── logs └── tenants
Multi-Product
Available from version 1.9.x, it is possible to define the following variables and folders. This allows to change the name of the product and images.
Key | Description | Value example |
---|---|---|
PRODUCT_NAME | Name of the product to be downloaded and installed | Alison Desktop |
PRODUCT_PACKAGE | Base name of the file to be downloaded. This name is completed with the version. | Alison-Desktop Finally, the file name to be downloaded will be Alison-Desktop-Installer-vX.Y.Z.exe or Alison-Desktop-Installer-vX.Y.Z.pkg, for example. |
PRODUCT_ACTIVEX | Name of the ActiveX used for IExplorer 8. This value is maintained by backward compatibility, but IExplorer 8 is not supported by Desktop Application. Disabled from version: 2.0.3.0 | Alison-ActiveX |
Package Installers distribution
To distribute your Desktop package, you must configure a public site. That site is defined by the variable BASE_INSTALLERS_PATH.
├── 3.1.0 │ ├── <PACKAGE_NAME>-Installer-3.1.0.exe │ ├── <PACKAGE_NAME>-Installer-3.1.0.pkg │ ├── ... └── 3.1.2 ├── <PACKAGE_NAME>-Installer-3.1.2.exe ├── <PACKAGE_NAME>-Installer-3.1.2.pkg ├── ... └── ...
.
Overwrite default content
It's possible to overwrite the default content distributed into the container. A structure like the following is suggested to publish all the information.
└── config ├── tenants │ ├── acme │ ├── looney │ └── ... ├── alison-sdk ├── images └── locales ├── en ├── es └── ...
Product File
The product file describes the list of products available for each platform.
This file was introduced from version 2.0.3.0.
windows: - id: win64_install name: Alison Desktop (x64) Installer package: Alison-Desktop-Installer-{VERSION}.exe - id: win64_portable name: Alison Desktop (x64) Portable package: Alison-Desktop-Portable-WIN-{VERSION}.zip macos: - id: mac_pkg name: Alison Desktop (MacOS) Installer package: Alison-Desktop-Installer-{VERSION}.pkg - id: mac_portable name: Alison Desktop (MacOS) Portable package: Alison-Desktop-Portable-OSX-{VERSION}.tgz linux: - id: lin_deb name: Alison Desktop (Debian) Installer package: Alison-Desktop-Installer-{VERSION}.deb - id: lin_rpm name: Alison Desktop (RedHat) Installer package: Alison-Desktop-Installer-{VERSION}.rpm - id: lin_portable name: Alison Desktop (Linux) Portable package: Alison-Desktop-Portable-LNX-{VERSION}.tgz
Version File
This file defines the version to be applied for each Tenant or product. This file was introduced from version 2.0.3.0.
The selection of the version number follows this order:
- tenant+product_id
- tenant+platform
- tenant
- 'general'+product_id
- 'general'+platform
- 'general'
The first matched definition is applited.
default: windows: "3.4.0" linux: "3.4.0" macos: "3.2.1" win64_portable: "3.4.0" mac_portable: "3.4.0" acme: 3.2.1 looney: windows: "4.0.0" linux: "3.4.0" macos: "4.4.0"
Tenant Configuration
Each tenant has its own configuration, and every Alison Wizard docker instance can manage one or several tenants.
The configuration file allows defining all the behavior of the Wizard for each tenant. It is easy to make changes in the operation of the application. It requires to reload the Alison Wizard container image to apply any change made on these files.
The following files define tenant configuration and must be customized or replaces.
File | Description | Default Value |
---|---|---|
alison-config.json | This is the main configuration file. It defines keystores, providers, filters, and plugins. It also defines minimal and suggested Alison-Desktop version. | |
background_world_map.png | Background images. It can be replaced. | |
custom.css | CSS style of main buttons, banner, and color. You can modify this .css file in order to reflect the font type or colors defined by your organization | ACME colors |
clientLogo.jpg | Logo image. | ACME logo |
alison-license-desktop.json | This file includes a license for the enabled domains. | 1-year validity license |
alison-authtoken-desktop.json | Defines the authentication token used by Alison-Desktop to manage the session. |
Create a new Tenant
The best way to create a new tenant is to download Lonnie example tenant configuration or copy ACME included tenant distributed on the last version of Docker Image, modify its name and apply changes on each related file.
Extend enabled tenants
After copying and configuring the new Tenant, the new name must be included in the ENABLED_TENANTS variable and restart the container.
Package version to download
Package Version
License
License
Alison Wizard has a preinstalled universal license valid for up to 1 year.
To obtain a full license, contact CertiSur team (support@certisur.com) and inform the domain list (from all environments: development, staging, production) where the container will be published.
CertiSur will return a definitive license covering all the domains informed with a 3 years validity.
The license file must be included in each tenant configuration folder.
Plugins
These optional components may be installed on some browsers (Firefox, Chrome, Internet Explorer) to allow a different communication between the browser and Alison Desktop.
Plugins must be enabled by domain, similar to license.
Internet Explorer 11
In the particular case of Internet Explorer, you will download an ActiveX component, that will require administrator privileges to be installed.
HealthCheck
Alison Wizard includes a healthcheck URL.
<wizard_url>/healthcheck
This URL should be filtered by your reverse proxy server if you consider that the provided information can be used in the wrong way.
Currently, JSON response only includes one instance into an Array, with the following information:
[ {"version":"1.9.3.2", "running_time":8358, "instance_id":"Wizard_98913_1605797341"} ]
- version: current wizard image version,
- running_time: time in seconds from its start,
- instance_id: unique ID for identifying different running instances.