×

Please give details of the problem

Docs

Find

EnterpriseConnect Installation Guide for Linux

The following sections describe how to set up and configure the EnterpriseConnect Agent and adapters on Linux systems. Make sure that your environment meets the prerequisites and that you have performed the preparatory steps as described here.

Installing the EnterpriseConnect Agent on Linux

Note: This section describes the standard installation procedure. Alternative installation methods can be found here.

The EnterpriseConnect Agent is available in RPM and DEB packages, which you can download here:

[version] is the current version number.

Use the package that is appropriate for your Linux system. For example, RPM is suitable for RedHat, CentOS, openSUSE, Fedora, or Madriva, DEB for Ubuntu, Debian, BackTrack, Kali, or Parsix.

To install the EnterpriseConnect Agent:

  1. Log in as a superuser.

  2. Use the standard GUI of your Linux system to install the package, or run the following command from the command line:

    • RPM package:

      1
      $ rpm -i dsec-agent-[version].rpm
      
    • DEB package:

      1
      $ sudo dpkg -i dsec-agent-[version].deb
      

With both, the RPM and the DEB package, the EnterpriseConnect Agent is installed as a service (daemon) named dsec-agent. The agent executables and configuration files are stored in /usr/local/dsec-agent. In the following, this is referred to as [dsec-installation-directory].

Proceed with configuring the EnterpriseConnect Agent. Then, start the Agent and test it. Adapters can be added at any time.

Configuring the EnterpriseConnect Agent

With a plain text editor, adapt the EnterpriseConnect Agent configuration file: [dsec-installation-directory]/config/application.properties

The configuration settings are described briefly in the file itself. More details are available here.

Specify values for at least the following settings:

  • server.port
  • sdc.host
  • agent.user
  • agent.domain
  • agent.password

Optionally, adapt other settings as required by your environment.

Starting the EnterpriseConnect Agent

The EnterpriseConnect Agent needs to be started to establish its secure websocket connection to the SDC of RunMyProcess DigitalSuite.

Starting the EnterpriseConnect Agent means starting the corresponding Linux service.

You have the following options:

  • As a superuser, execute the following script:

    1
    $ sh [dsec-installation-directory]/bin/unix/startagent.sh
    
  • Depending on whether your Linux system uses the initd or systemd startup and shutdown utility, execute one of the following commands:

    • With initd:

      1
      $ service dsec-agent start
      
    • With systemd:

      1
      $ sudo systemctl dsec-agent.service start
      

Adding Adapters

HTTP requests from RunMyProcess DigitalSuite to the APIs (e.g. SOAP, REST) of local web services can be routed directly by the EnterpriseConnect Agent and do not require additional components. To access other local services and resources, however, specific adapters need to be set up in the local environment. The adapters may be located on the same system as the EnterpriseConnect Agent or on one or more different systems in your environment.

To set up and run an adapter, proceed as described in detail here for each individual adapter.

Testing and Using the Installation

After you have set up and configured your local EnterpriseConnect installation and started the Agent and adapters, you can test whether everything is working correctly from RunMyProcess DigitalSuite. If the tests are successful, you can start to access local resources from your projects in the Cloud. For both purposes, you need to define a provider and appropriate connectors for your projects in RunMyProcess DigitalSuite.

The procedures to define a provider and connectors and to test and use your EnterpriseConnect installation are described in detail in
Testing and Using the EnterpriseConnect Installation.

Stopping the EnterpriseConnect Agent

When you stop the EnterpriseConnect Agent, its connection to the SDC of RunMyProcess DigitalSuite is closed.

Stopping the EnterpriseConnect Agent means stopping the corresponding Linux service. The service is stopped automatically when the Linux system itself is shut down.

To stop the service manually, you have the following options:

  • As a superuser, execute the following script:

    1
    $ sh [dsec-installation-directory]/bin/unix/stopagent.sh
    
  • Depending on whether you Linux system uses the initd or systemd startup and shutdown utility, execute one of the following commands:

    • For initd:

      1
      $ sudo service dsec-agent stop
      
    • For systemd:

      1
      $ sudo systemctl dsec-agent.service stop
      

Uninstalling the EnterpriseConnect Agent

You can uninstall the EnterpriseConnect Agent at any time if you no longer need it.

You have the following options:

  • Use the standard GUI of your Linux system to uninstall the package.

    Note for Ubuntu: The Ubuntu Software Center may not work correctly. We recommend you use the Synaptic Package Manager instead.

  • Depending on whether you installed the RPM or DEB package, run the following command from the command line:

    • RPM package:

      1
      $ rpm -e dsec-agent
      
    • DEB package:

      1
      $ sudo dpkg -r dsec-agent
      

The uninstall process stops the dsec-agent service and removes it. All files except log files are removed from the Linux system.

Alternative Procedures to Install the EnterpriseConnect Agent

The standard installation procedure described above will be appropriate for the vast majority of situations. If this is not the case, you can use one of the following methods to install and uninstall the EnterpriseConnect Agent on a Linux system:

For both procedures, you need to download and extract the following ZIP file:

dsec-agent-[version].zip

The directory to which you extract the ZIP file will be the EnterpriseConnect Agent installation directory, referred to as [dsec-installation-directory]. It has the following structure and contents:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
[dsec-installation-directory]
├── bin
   ├── unix
      ├── installagent.sh
      ├── lib.sh
      ├── startagent.sh
      ├── stopagent.sh
      └── uninstallagent.sh
   └── win
       ├── installagent.bat
       ├── startagent.bat
       ├── stopagent.bat
       └── uninstallagent.bat
├── config
   ├── application.properties
   ├── unix
      ├── dsec-agent_initd_template
      └── dsec-agent_systemd_template.service
   └── win
       ├── dsec-agent.exe
       └── dsec-agent.xml
└── lib
    └── dsec-agent.jar

Script-based Installation and Uninstallation

To install the EnterpriseConnect Agent:

As a superuser, execute the following script:

1
$ sh [dsec-installation-directory]/bin/unix/installagent.sh

The script installs the EnterpriseConnect Agent as a service (daemon) named dsec-agent. It automatically detects whether the Linux system uses initd or systemd and creates the corresponding startup and shutdown file for the EnterpriseConnect Agent.

Proceed with configuring the EnterpriseConnect Agent. Then, start the Agent and test it. Adapters can be added at any time.

To uninstall the EnterpriseConnect Agent:

As a superuser, execute:

1
$ sh [dsec-installation-directory]/bin/unix/uninstallagent.sh

The script stops the EnterpriseConnect Agent, if it has been running. It automatically detects whether the Linux system uses initd or systemd and deletes the corresponding startup and shutdown file for the EnterpriseConnect Agent. The [dsec-installation-directory] is left unchanged. You can remove it manually if you no longer need it.

Manual Installation and Uninstallation

A manual installation on Linux should be the last resort and be used only if the standard and script-based installations fail. It consists of manually creating the startup and shutdown files for the EnterpriseConnect Agent for the initd or systemd utility.

First, find out whether your Linux system uses initd or systemd by executing:

1
$ cat /proc/1/comm

Then, create the required startup and shutdown file for the EnterpriseConnect Agent.

  • For initd:

    1. Copy the [dsec-installation-directory]/config/unix/dsec-agent_initd_template file to a file called dsec-agent.

    2. In the new dsec-agent file, replace all occurrences of the AGENT_HOME variable with the full path and name of the [dsec-installation-directory].

      For example, change:

      1
      2
      3
      #!/bin/bash
      START_SCRIPT='java -Dloader.path=AGENT_HOME/config -jar AGENT_HOME/lib/dsec-agent.jar'
      (...)
      

      To:

      1
      2
      3
      #!/bin/bash
      START_SCRIPT='java -Dloader.path=/home/unknown/dsec-agent/config -jar /home/unknown/dsec-agent/lib/dsec-agent.jar'
      (...)
      
    3. Move the modified file to the /etc/init.d/ directory.

    4. Add execute rights to the file in /etc/init.d/, for example, by calling:

      1
      $ chmod a+x /etc/init.d/dsec-agent
      
  • For systemd:

    1. Copy the [dsec-installation-directory]/config/unix/dsec-agent_systemd_template.service file to a file called dsec-agent.service.

    2. In the new dsec-agent.service file, replace all occurrences of the AGENT_HOME variable with the full path and name of the [dsec-installation-directory].

      For example, change:

      1
      2
      3
      (...)
      ExecStart=/usr/bin/java -Dloader.path=AGENT_HOME/config -jar AGENT_HOME/lib/dsec-agent.jar
      (...)
      

      To:

      1
      2
      3
      (...)
      ExecStart=/usr/bin/java -Dloader.path=/home/unknown/dsec-agent/config -jar /home/unknown/dsec-agent/lib/dsec-agent.jar
      (...)
      
    3. Move the modified file to the /etc/systemd/system directory.

    4. Reload systemctl by calling:

      1
      sudo systemctl daemon-reload
      

Proceed with configuring the EnterpriseConnect Agent. Then, start the Agent and test it. Adapters can be added at any time.

To uninstall the EnterpriseConnect Agent:

As a superuser:

  1. Stop the Agent.

  2. Remove the startup and shutdown file for the Agent:

    • For initd: remove /etc/init.d/dsec-agent
    • For systemd: remove /etc/systemd/system/dsec-agent.service
  3. Remove the [dsec-installation-directory] if you no longer need it.