How to: Install InterWorx Control Panel

Prerequisites

1. A server or supported VPS system of at least the minimum supported hardware configuration.
2. A clean install of one of the supported operating systems. Please note: for new installs, the most up-to-date version of each OS is required
   Minimum server requirements, supported VPS systems, and supported operating system information can be found here
3. A valid active InterWorx Control Panel license key
4. UIDs 102 → 107 and GIDs 102 and 103 must be free for use. The build of the qmail MTA InterWorx Control Panel uses requires these UID/GIDs to be available.

---

InterWorx Install Script Overview

InterWorx is installed via a bash script which makes the following changes to the server:

1. Deactivate SELINUX
2. Move /home/ to /chroot/home/, if /home is not on its own partition. It will then symlink /chroot/home/ to /home.
3. Uninstall any conflicting RPM packages that are initially installed on the server, using yum
4. Install InterWorx and its supporting software, using yum
5. For EL6 servers, disk usage quotas will be enabled on the primary user partition, generally /, /home, or /chroot
   Due to the change to the XFS filesystem in EL7, quotas must be enabled manually on those servers, and it is not part of the InterWorx installation script. Instructions on how to enable quotas in EL7 can be found here
6. As of InterWorx version 6.3.21, the installation script also updates the server PHP and MySQL or MariaDB versions to the latest versions available. This can be changed using the -m or -p flag when running the install script. More detailed information is found below

The install script has a few optional parameters that can be useful for installation in advanced environments, including specifying MySQL and PHP versions, and installation repo. Those options can be found using the -h flag with the installation script:

[[email protected] ~]# sh <((curl -sL https://updates.interworx.com/interworx/7/install.sh)) -h

Usage: iworx-cp-install.sh [-s rpm/ks server hostname] [-s server] [-d] [-f] [-u] [-k] [-l] [-i] [-h]
    -s RPM server
       Specify a different rpm host to grab src.rpm/rpms from
       (default: updates.interworx.com).
    -d Turn debugging on (you'll have to hit enter sometimes.
       to keep things moving, output is halted so you can see it).
    -f FORCE installation even if the distro isn't supported.
    -u Perform a "yum update" prior to installation of
       InterWorx-CP.
    -k Force the removal of any conflicting packages that will
       interrupt the InterWorx-CP install.
    -l Run in headless mode.  No prompting will occur.
    -r Choose an interworx repository to enable. default: release.
       (release,alpha,beta,release-candidate,stable)
    -i Install all packages *except* InterWorx-CP itself.
    -m Maria DB version to use. Specify "system" to use the version available via yum
    -p PHP version to use. Specify "system" to use the version available via yum
    -v Verbose output.
    -h Show this help message."

[[email protected] ~]#

---

Running the InterWorx installation command within a Linux screen session is recommended. Screen creates a shell session that continues to stay active, even if there is network disruption. Detailed information on using screen can be found here.

1. To determine whether screen is installed on the system, run which screen. The system will return /usr/bin/screen if screen is installed
   • If screen is not already installed, it can be installed by running yum install screen
   • To install InterWorx from within a screen session, type the word screen  at the command line. Then, run the InterWorx installation command
2. If the session disconnects, log back in at the command line and typescreen -r. This will reconnect the screen session

---

How to install InterWorx 7

InterWorx 7 includes a new, updated and streamlined UI. It is currently reserved for new installs only. A Interworx 6 to 7 upgrade tool will be released soon.

Links to an interactive demo of Interworx 7, both Nodeworx and SiteWorx can be found here

If setting up a node for an existing Interworx cluster, it is highly recommended to use same version as the rest of the servers in the cluster.

To install InterWorx 7:

1. Log in to the server at the command line as root, either via SSH or from the terminal
2. Download and run the installer:
   sh <((curl -sL https://updates.interworx.com/interworx/7/install.sh))
3. Alternatively, download and run the installer with no prompting:
   sh <((curl -sL https://updates.interworx.com/interworx/7/install.sh)) -l

---

How to Install InterWorx 6

To install InterWorx 6:

1. Log in to the server at the command line as root, either via SSH or from the terminal
2. Download and run the installer
   sh <((curl -sL https://interworx.com/inst.sh))
3. Alternatively, download and run the installer with no prompting:
   sh <((curl -sL https://interworx.com/inst.sh)) -l

Interworx 6 stable, release, rc and beta versions are all fully supported. While some future features developed on 7 may get backported to v6 the new design and apache configuration template system will not.

---

Activating the InterWorx License

The next step after installing InterWorx is to activate the InterWorx Control Panel License. This can be done one of two ways:

• From the web browser:
  Go to https://[your-ip]:2443/nodeworx . Follow the prompts for the license key and an initial e-mail and password for the control panel.
• From the command line:
  CLI license activation instructions can be found here

Activating an InterWorx license, either via the web browser or the command line, can only be attempted once on a server. It is highly recommended to take a snapshot of the server before attempting to activate the license. If for some reason there is an error when activating the license, the server can then be reverted to the snapshot, which prevents the need to start the installation completely over on a fresh OS install.

If activating the license at the command line, it is recommended to do so from a screen session.

---

Troubleshooting

The most common problem during the install is package conflicts between the packages being installed and those that are already on the system. The installer is very nice, in that it can be run and re-run as needed and will continue where it previously left off if you run into problems. Just keep an eye on the output for conflict errors, and remove any conflicting packages that are reported. After the conflicts are removed simply re-run the installer and it will continue.

The installer will try to remove packages preemptively, as well, (and prompt where necessary before it removes anything).