...

SOX 4.0 offers an unbelievable wealth of new functional features, as well as integration with a number of major third-party products. For further particulars, refer if you will to

https://enco-software.atlassian.net/wiki/spaces/SUD/pages/2902065153#Interfaces

and Integrations.

Local Process

If you expect to are planning work with locally stored repositories only, simply download the client application installer from https://www.enco-software.com/de/support/downloads/. info

Our downloads are available to registered customers only. Unless you have already done, please be sure to register to gain access to our service desk facility at https://www.enco-software.com/de/registration/.

Further, use of the software requires a valid license. To learn more about SOX licensing, please refer to Activating Your SOX License and/or SOX License Management.

The recommended installation process then involves the following steps:

1. The SOX download package is likely to be in the form of a .zip archive. In this scenario, unzip (extract) Extract all files first.

   

2. Understand that extraction may take several minutes. - Outcome: Windows will display the extracted directory within your SOX the respective folder.

   

3. Run the sox.exe file, ensuring that you have sufficient user privileges to install the software. Depending on your system configuration, Windows may issue a warning at this point. If this happens, confirm that you wish to proceed with the installation.

4. Outcome: you You will be asked to select your workspace, i.e., a folder in which to store your projects. SOX automatically creates a folder simply entitled named “workspace” and will offer to use this folder in the first instance. It is possible alternatively to click on Browse… and nominate select any other folder of your choice. Furthermore, SOX further offers to make your selection the default and not ask again at startup which folder you wish to use. To elect this option, check the box provided. You may alter your choice at any point from within the SOX workbench environment. When done, click the Launch button.

   

5. Next, SOX will prompt you for the kind of repository to use with your workspace. For our In the example scenario, the assumption is that you wish to below, we create a new local repository. (Also For more information on your workspace and respository, see: Workspace and Repositories.) Use the associated radio button and click on Next.

   

6. Outcome: SOX will ask you to define the path to your repository directory. Accept the default or click on Browse… to store your repository somewhere elseselect a different folder. Enter a name for your new repository. This needs to name must be unique within your repository directory. Click Finish to apply your choices.

   

7. Supply your user credentials to sign into SOX. As the dialog indicates, the factory defaults are When starting SOX, the default user credentials “Administrator/0000” (user/password) are preselected. The defaults may be subject to change differ based on settings implemented by your system administrator. Check the box provided to have SOX remember your password, then click OKClick OK to finish the installation process and to start the SOX Client for the first time.

   

8. Outcome: this activity completes the The setup process is now finished. SOX will display the Welcome screen.

   

...

Docker Server Installation

Requirements

The following minimum requirements exist for the installation of the SOX server (more may be required depending on use)

Other setups and operating systems may also work, please contact our support team for more information.

Login Credentials

to To start the installation process, you first need your personal login-credentials to download and install the docker file. Our support team will gladly provide you with those credentials.

Download Docker-Composed.yaml

To download the docker-composed.yaml file, enter the following ine in the Linux-shell. Replace the <USERNAME> and <PASSWORD> with the credentials you have previously received from our support team.

curl -u <USERNAME>:<PASSWORD> https://gitlab.com/api/v4/projects/57826888/packages/generic/docker-compose/4.2.1.0/docker-compose.yaml > docker-compose.yaml

your Your file will now automatically be downloaded and saved as docker-compose.yaml.

Editing the Docker-Composed.yaml

Within the docker-composed-yaml, you will find two lines refering to LocalHost. This can remain as is for a local test installation. To install the docker image on your server enviromant, change the LocalHost entries to your server’s DNS Name/IP-Address.

Login to registry

To be able to pull the docker images, you fist need to log into the docker registry. You can do so via the command

docker login registry.githubgitlab.com

You will be asked to enter your user name and password. Use the same credentials as before.

Initiate the Installation

You can now start the installation via the command

...

The Docker services will now be automatically loaded from the Docker hub. After downloading, the services will be started automatically.

Be aware that especially the first startup of the sox SOX service may take some time (some several minutes ) to set up the database and the . The backend will therefore be unreachable during this step of the setup. Later startups skip this initialization and will be faster.

Manual Installation

Instead of running the complete installation via the docker-compose up -d command, you can also install the relevant components on their own. This is especially useful in case you were experiencing challanges during your first installation attempt as this method allows you to check the docker logs after each step using the command

docker ps

Perform the following commands in order:

MySQL Service:

docker-compose up -d mysql

Respository Service:

docker-compose up -d SOX

You can now check the logs for messages indicating successful startup:

docker logs -f sox

The CDO server started and Starting SWT event loop messages indicate a successful installation.

C-SOX Frontend:

docker-compose up -d c-sox

Reverse Proxy to open C-SOX files from the desktop client:

docker-compose up -d traefik

Remote Process Client-Server Installation (old Server Installation process)

In order to access remote repositories, a database server needs to be installed in addition to the client software. The SOX Server is, technically speaking, a CDO (Connected Data Objects) Server. In the following, we make the stipulation that the database and the SOX Server are installed on the same machine.

Prerequisites

• Existing MySQL installation (5.7 or better)

• Root privileges on the server machine

...

MySQL Installation

Please refer to the MySQL product page (https://www.mysql.com/) for downloads and detailed instructions.

MySQL Initialization (Linux Only)

Some editing of the configuration file, normally found at /etc/my.cnf or /etc/mysql/my.cnf, is required. Locate the mysqld section and add the following two lines:

lower_case_table_names=1
sql-mode="STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_AUTO_VALUE_ON_ZERO,NO_ENGINE_SUBSTITUTION,ONLY_FULL_GROUP_BY" ...

...

SOX Server Installation

The SOX Server application package will normally come as a .zip archive available from https://www.enco-software.com/de/support/downloads/. The file should be saved to your server machine, and can be extracted to any directory. Recommended locations are: c:\sox2server (Windows) or /opt/sox2server (Linux). In either scenario, this directory shall be referred to as INSTALL_FOLDER hereinafter. Under Linux, the following executable flags need to be added:

$ chmod +x $TARGET_DIR/sox2server
$ chmod +x $TARGET_DIR/features/enco.sox2.releng.jre.linux.gtk.x86_64*/jre/bin/*.

...

Database Setup

It is necessary to create a new user with appropriate access privileges. Your previously downloaded and unzipped server file contains the required scripts in the <INSTALL_FOLDER>/scripts folder. The file that needs to be executed is mysql-init.sql.

...

Note that the database user SOX_REPO_USER can only access the database from the same server. If you want to have the SOX Server on a different machine than the database, please also execute the file mysqlinitremote.sql. This script will create another user, who is allowed to connect to the database from another server than localhost.

...

Setting up the Database Connection for SOX Server

In the installation folder of the SOX Server, certain files must be modified to allow the SOX Server to talk to the MySQL database.

...

<repository name="SOX_REPO" type="sox">.
This completes the configuration setup. We still need to install SOX Server as a system service.

...

Installing SOX Server as a Service, Under Linux

To create a service on Linux to start/stop the SOX Server like other services on your Linux server do the following steps -

1. Create a file named sox.service in folder <INSTALL_FOLDER>.

2. Add this content to the newly created file:
   [Unit]
Description=SOX Server
[Service]
WorkingDirectory=/opt/sox2server
Type=simple
ExecStart=/opt/sox2server/sox2server
[Install]
WantedBy=multi-user.target

3. Install the service on your system as a system service:
   systemctl enable <INSTALL_DIR>/sox.service.
   To start your new service, type
   systemctl start sox.service.
   To stop the service, type
   systemctl stop sox.service.
   To display the current status of your new service, type
   systemctl status sox.service.

...

Installing SOX Server as a Service, Under Windows

To install the SOX Server as a Windows service, open a command line with admin privileges and navigate to <INSTALL_FOLDER>/scripts. Here you will find a file named service_install.exe. Execute this file. The
file will then execute for a short period of time. Installation was successful if you see output like this:

...

If now you open the service control center on Windows you will find a new service called sox2server.

...

First Run of SOX Server

This completes setting up SOX Server. You are now ready for its first run. As explained above, start the service by entering systemctl start sox.service.

...

On Windows you will find the log in the file log.txt in the install folder; on Linux you will find the log output in /var/log/syslog.

Memory Configuration

There is a default maximum memory setting for the Java VM that runs the server. This setting
depends on the operating system and the total amount of memory available on the hardware. For example, a system having 16 GB of memory will provide approx. 8 GB per default. You can change the value manually in the sox2server.ini inside the installation directory of the server.

...

To illustrate, the memory value is set to 8GB with the following example setting. Please note that it is mandatory to specify the setting below the -vmargs attribute:
-Xmx8192m
or alternatively
-Xmx8g.

...

Connect the Client to the Server

...

https://enco-software.atlassian.net/wiki/pages/resumedraft.action?draftId=2805170179

new SOX System Requirements

Activating Your SOX License

SOX License Management

Cross-Module Features (v4.0 and Better)

...