WEB CONTENT DISPLAY

Installation Process: Linux

Use the installation phases as shown below for quick navigation in the process.

 
Installation code

 
Download ZIP

 
Installation Guide

 
Get Started

 

Installation Guide: Linux

ADOxx 1.5: Linux Installation Guide

This installation guide provides details on the installation procedure of the experimental port of the ADOxx to Linux and supports the installation directly without a dedicated virtualisation environment. Installation is performed script-based.The script installs ADOxx  on your Linux using native virtualisation techniques. This means that no virtualised Microsoft Windows environment is required.

This port to Linux is EXPERIMENTAL (including the installation script). Use at your own risk!

Tested Linux Distributions and Versions:

  • Ubuntu 18.04 LTS, 18.10
  • Fedora 28, 29

Requirements

The requirements are installed as part of the script automatically. User interaction is required to elevate the terminal interaction.

  • Docker
  • Wine (3.21 or newer recommended)
  • Microsoft SQL Server 2017 Express (running on Docker)

Installation procedure

The installation script is made for bash. The tool and all prerequesites require about 4.5GB of free space on a fresh Linux installation (Ubuntu, Fedora) (~1.5GB for prerequisites, ~2GB for Wine prefix and Docker container, rest for compressed and extracted installer and the tool itself). This can of course vary based on which prerequesites are already available, how much the temporary installation files require or which packages have new updates.
To run the installation script simply open a terminal window, navigate to the extracted download package and start the installation using ./install_linux.sh. It might be necessary to first add execution rights to the script using chmod +x ./install_linux.sh
The script also allows to influence its behaviour through the use of some command-line arguments:

  • --nocolor will omit using any special colors when printing information.
  • --ignorechecks will not perform any checks and instead ask the user every time some part is installed/set-up whether to do so.
  • --skipprereq will skip the installation of any prerequisites, which can be useful if the user wants to manually install the prerequisites beforehand.
  • --DN followed by the name of the distribution (--DN ubuntu, --DN fedora ...) will set that variable for the installation script (influences behaviour of some installation code).
  • --DV followed by the distribution version (--DV 28, --DV 29, --DV 18.10 ...) will set that variable for the installation script (influences behaviour of some installation code).
  • --PM followed by the command name of the package manager (--PM apt, --PM dnf, --PM yum ...) will set the script to use the specified package manager, with the exception of some cases (influences behaviour of some installation code).

Note: Sometimes servers are not available or a timeout occurs (during step 2, 3 or 4). In such a case please abort the script using CTRL+C (might have to press several times) and run it again.

Manual installation of prerequisites

Wine

Wine is required to run the ADOxx based tool. Obtaining a recent installation usually requires adding the right WineHQ repository to the package manager of choice (through a command like sudo apt-add-repository ... or sudo dnf config-manager --add-repo ...) and then using the package manager to install winehq-stable.
Sometimes it is also necessary to first enable 32 bit architecture (through sudo dpkg --add-architecture i386, typically on Ubuntu systems) and/or obtain the repository key for WineHQ (through wget -nc https://dl.winehq.org/wine-builds/winehq.key ; sudo apt-key add winehq.key, typically on Ubuntu systems).
Note: Wine version 3.21 or newer should be used, because some older versions seem to have problems with installing mdac28.
More help on installing Wine can be found in the WineHQ Wiki at https://wiki.winehq.org/Wine_Installation_and_Configuration

Winetricks

Winetricks is necessary to install some of the requirements for the database (mdac28). The installation can often be performed using the package manger of choice (like sudo apt install winetricks). Should this fail it is also possible to simply download winetricks (wget https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks), make it executable (chmod +x winetricks) and either make it available to the shell (for example through sudo cp winetricks /usr/local/bin) or copy it into the folder where it is used (which would be this folder).

More help on installing Winetricks can be found in the WineHQ Wiki at https://wiki.winehq.org/Winetricks

Docker

Docker is used to run the database to which the ADOxx based tool connects and thus is necessary for it to run properly. The installation is usually easy by simply using the package manager of choice (like sudo apt install docker.io or sudo dnf install docker). So far recent versions of Docker have not been making any problems, so no specific information about what version has to be used is available. Note that for Fedora the package is named docker and for Ubuntu the package is named docker.io.

Starting the tool

The installation script copies shortcut files for <TOOL_NAME> to the desktop and menu if possible, which can be used to start the tool. Alternatively the tool can also be started by executing the following through the command line: WINEARCH=win32 WINEPREFIX="${HOME}/.wine_adoxx" wine
"${HOME}/.wine_adoxx/drive_c/Program Files/BOC/
<INTALL_DIR>_ADOxx_SA/areena.exe" -uAdmin -ppassword -d<DB_NAME>
.

Uninstallation procedure

The uninstallation script is made for bash and works correctly only if the provided installation procedure has been used. The uninstallation does not remove requirements/dependencies that have been installed as part of the script (Wine, winetricks, Docker). These have to be removed manually.
To run the uninstallation script, simply open a terminal window, navigate to the extracted download package and start it using ./uninstall_linux.sh. It might be necessary to first add execution rights to the script using chmod +x ./uninstall_linux.sh The script also allows to influence it's behaviour through the use of some command-line arguments:

  • --nocolor will omit using any special colors when printing information.

Important for developers of AdoScript:

  • When using the tool on Linux the "current working directory" isn't the ADOxx installation directory but the home directory. So using relative file paths or the GET_CWD to access things in the ADOxx installation folder won't work. Use CC "Application" GET_PATH instead.