Last Updated on
Topic : Ephesoft Linux Installation
Applicable Ephesoft versions:
Following configuration is required for installing Ephesoft 3.1.2.x on an Ubuntu or Red Hat Server using the command line installer:
- A supported Linux distribution (Ubuntu workstation 13.10, 14.04, RHEL 6.5 – 6.9, Ubuntu 14.10, or Red Hat without a Desktop Environment, special steps must be taken before starting the installation.
- See Multi-Server installation instructions if you intend to use more than one server. Link here
- Internet connection is required as some software needs to be updated or installed from the distribution’s repository during Ephesoft installation. See step 1
- Installation script must be run as root otherwise user will receive errors during installation process.
- Ephesoft license must be installed on the machine on which Ephesoft has been installed. (These steps will be at the below the installation instructions)
- Ephesoft 3.1.2.x for Linux currently supports MySQL database as MSSQL database can not be installed on Linux.
- Run update
- sudo yum update
- sudo apt-get update && sudo apt-get upgrade
- make a directory for the Ephesoft install files
- We will use /home/ephesoft/Downloads/Ephesoft
- Extract the files from the Ephesoft_linux.zip to this folder
- unzip Ephesoft_linux.zip -d ~/Downloads/Ephesoft
- If unzip is not installed use one of these commands
- RHEL/CentOS: sudo yum install unzip
- Ubuntu: sudo apt-get install unzip
- Navigate to the directory where you have unzipped Ephesoft installer
- cd ~/Downloads/Ephesoft
- Make all files in the directory executable using this command
- sudo chmod -R 777 *
- Change to root user for installation
- su root
- Enter password
- If you have not set a root password, do that now
- Always talk to your system administrator before doing this
- sudo passwd
- Enter password twice
- Execute the Installer
- Installer will ask if your distribution is RHEL or Ubuntu.
- Press enter if it is correct (This demo is with Ubuntu so it is correct)
- Enter the path where you would like to install Ephesoft
- /opt is the common directory in which to install third party applications
- /opt is our recommendation
- NEVER install ephesoft in the /home directory for a user or in the /root, /bin, /etc, /sbin, /usr, or /boot directories
- Ephesoft will move the installation files to the target directory. The installer will then ask if you want to use an existing SharedFolders directory. This is for multiserver installs and requires the SharedFolders already be installed from another install of the same version of Ephesoft.
- The installer will now ask where you would like the SharedFolders installed. If you would like to designate another folder, answer y here and you will be asked where you would like it installed. Otherwise leave n and click enter.
- Now you will be asked which port on which you would like Ephesoft accessible. The default is 8080.
- You will now be asked the name of your workstation. It is recommended that you leave this as the default. It will default to your server’s hostname.
- The installer will now install dependencies required for ephesoft to function. Wait for it to finish.
- Ephesoft for Linux is only available with MySQL instances. You will now be asked if you would like to install a new MySQL instance. Use default here unless a multiserver installation.
- You will be asked which database port to use. For a standard install, use the default.
- You will be asked to enter a password for the root user. This is for the root user of the MySQL instance. Write this down as it cannot be changed after created.
- You will be asked for the database names, both ephesoft and report. Press enter through both of these and do not change the names of the databases.
- The installer will check to see if you want to change any of the MySQL settings. Press enter to use default value of n. Make sure to only include alphanumeric characters while writing the name of Application DB when using the existing database instance. Use of special characters should be avoided except _ .
- Installer will install MySQL instance. It will then continue to install other applications used by Ephesoft such as LibreOffice, Ghostscript, ImageMagick
- The installer will ask if you would like to install Tesseract. Nuance is the preferred OCR engine and is installed by default, however you can also install Tesseract if you would like to use this plugin.
- The installer will continue to install applications used by Ephesoft such as Leptonica, Nuance, and Poco.
- Ephesoft has now been installed on your server. Please follow steps below in order to apply a license to your Ephesoft installation before starting Ephesoft for the first time.
- Navigate to /opt/Ephesoft/Dependencies/licensing and send the details. Properties file to firstname.lastname@example.org and be sure to note that your install is a Linux install and advise them of the number of CPU cores on the server.
- If you are not sure how many CPU cores your server has, type ‘nproc’ in the terminal and it will give you the number of cores as an output.
- Our licensing team will send you a file named ephesoft.lic. You will place this file in the /opt/Ephesoft/Dependencies/license-util/ephesoft-license-installer
- While you are still root user and the ephesoft.lic file has been copied to the correct folder, run the following command in the folder mentioned above. ‘./install-license.sh’
- Run the command ‘./install-license.sh’ a second time. To make sure that the license was installed correctly, we encourage you to run this command a second time.
- Now that the license has been installed, you can change users back to your user instead of the root user. We are using the ephesoft user so the command would be ‘su – ephesoft’
- This command will also put you back in the home directory for your user.
- You can start Ephesoft for the first time. Run the following command to start Ephesoft.
- sudo /opt/Ephesoft/JavaAppServer/bin/startup.sh
- This command must be run with sudo rights.
- Ephesoft is now started.
- Open a web browser on the workstation and browse to http://localhost:8080/dcma/home.html. This will bring you to the home menu for Ephesoft.
- Clicking on an Administrator or Operator icon will take you to the login screen. The username is ephesoft and the password is demo.
- If the Ephesoft installer stops with an error during any step of the installation process. Please send the following files to Ephesoft Support at email@example.com and please include the distribution and version of linux on which you are installing.
- /etc/Ephesoft/ephesoft.conf (only root has access to this folder, if file does not exist, send only first file.)
- If you are installing on CentOS 6.5/6.5 or Ubuntu 14.10, please follow the instructions linked to at the beginning of these instructions.
- If you do not have root or sudo permissions on the server, please contact your system administrator for permissions and/or instructions.
- If installing SharedFolders directory on a remote server/NAS/SAN, please advise your system administrator to mount the share locally to your server and use the path they provide during the install. You can contact support for assistance if you run into issues with this. Persistent mount of the share on the local server will be necessary for Ephesoft to function.
- Although we may support other Ubuntu and RHEL based distributions, we have not tested them all. Please contact support at firstname.lastname@example.org before attempting an install so that we can advise you of any changes that may need to be made during the install process.
- In Ubuntu, Ephesoft installation will turn the Firewall(ufw) on after install. At the end of the install, if you want ufw turned off, please remember to turn it off again with the command ‘sudo ufw disable’.
- When shutting down the Ephesoft service in Ubuntu, use the command ‘sudo /opt/Ephesoft/JavaAppServer/bin/shutdown.sh’
- After you install Ephesoft, before you run Ephesoft for the first time, run the following commands(dos2unix is installed by Ephesoft):
- Sudo dos2unix /opt/Ephesoft/JavaAppServer/conf/*
- Sudo dos2unix /opt/Ephesoft/JavaAppServer/bin/*