Knowledge Base

Installing 14.5

Celoxis is a powerful application, yet easy to install and configure if you follow the steps given below. Not following the instructions can lead to a lot of wasted hours. If you do not follow something, contact us and we will help you out.

Preparing for Installation

1. Your database server must be up and running and you must have created a database and a database user for Celoxis. If not, first do that as described in the chapter on database setup. Keep your database information ready: database name, login, password. You will be asked to input these during the installation process.

   It is advisable that you test your database setup before you proceed with the actual installation.
2. Create an email account for Celoxis in your email server. Celoxis should be able to read email via IMAP and also send email using this account. Think of Celoxis as a regular user in your system. Note down the username and password. This will be used in installation. If your email server is unreliable or does not support plussed addressing, consider using Gmail.
3. Decide how your users would want to access Celoxis. For example, if your domain is acme.com, you can have celoxis.acme.com, projects.acme.com, pm.acme.com, etc. Before you begin installation, ensure that your DNS server has been updated with this hostname and is working fine by using the ping command.
4. Create a user called celoxis on the machine where you will install Celoxis. If you are running Linux, we do not recommend running Celoxis as the root user.
5. Download and install Java Development Kit v11 (JDK 11). We recommend Amazon Correto which is a no-cost, multiplatform, production-ready distribution of the Open Java Development Kit (OpenJDK). Download from Amazon's Java 11 download center. If your operating system is 64 bit, then you must install the 64 bit version, else you must install the 32 bit version.
   
   On Microsoft Windows, installing AWS Corretto will correctly setup the JAVA_HOME and PATH system properties, so do not change the Setup Environment section during its installation.

   Configure JAVA_HOME environment variable

   Celoxis uses Java and for it to work correctly, the JAVA_HOME environment variable must be correctly set.

   • Windows
   • Linux

   AWS Corretto will correctly setup the JAVA_HOME and PATH system properties during installation. All we have to do is verify its correctness.

   Verify JAVA_HOME is correctly set

   Open a command prompt and type java -version. You should see something like:

   C:\> %JAVA_HOME%\java -version
   openjdk version "11.0.7" 2020-04-14 LTS
   OpenJDK Runtime Environment Corretto-11.0.7.10.1 (build 11.0.7+10-LTS)
   OpenJDK 64-Bit Server VM Corretto-11.0.7.10.1 (build 11.0.7+10-LTS, mixed mode)
   C:\>

   1. Open a terminal and login as the user on whose behalf Celoxis application will be started.
   2. In the appropriate profile file depending on the shell you use (e.g. .bash_profile or .profile for bash), type: export JAVA_HOME=/usr/java/amazon-corretto-xx.yy.zz replacing the path with the correct directory in which AWS Corretto 11 was installed.
   3. Save the file.
   4. Log out.
   5. Log in.

   Verify JAVA_HOME is correctly set

   Open a shell and type $JAVA_HOME/bin/java -version. You should see something like:

   $ $JAVA_HOME/bin/java -version
   openjdk version "11.0.7" 2020-04-14 LTS
   OpenJDK Runtime Environment Corretto-11.0.7.10.1 (build 11.0.7+10-LTS)
   OpenJDK 64-Bit Server VM Corretto-11.0.7.10.1 (build 11.0.7+10-LTS, mixed mode)
   $

6. Create a directory for installation of the application and uploaded files. On Windows, we recommend: C:\celoxis, while on Linux, we recommend: /usr/local/celoxis. Avoid creating a directory with name having the space character. The directory should have at least 10GB + size of uploaded files you will upload into Celoxis.
7. Download the installation zip file (link will be sent to you via email) and copy it to the directory created above.
8. Unzip it. Your installation directory should contain something like:

   psa_14.5.0/
   ├── LICENSE
   ├── NOTICE
   ├── bin/
   ├── conf/
   ├── lib/
   └── webapps/

9. You should have received a license.properties file in an email from us that contains your license information. Keep this file ready. You will be asked to upload this file during the installation process.

Before you proceed

Before you proceed, keep the following handy:

• The license.properties file sent by our support team.
• The database user and password.
• A host name which your users will use to access Celoxis e.g. celoxis.acme.com
• A location for the data directory. This is the directory that will store files, search indices and other files. At least 10 GB should be free. Also, this directory should not exist. We recommend that you store it as a subdirectory of the installation directory and name it data. So if you have installed celoxis in D:\celoxis, then the data directory should be D:\celoxis\data.

Start Celoxis

• Windows
• Linux

Install Celoxis

1. Open http://your-server-name:8888/ in browser.
2. Click on the Install button.
3. Read the EULA and click Agree if you agree to the terms.
4. Choose a site admin password between 8 to 10 characters.
5. Upload the license.properties file sent by us.
6. You will be shown the license details. Verify its correctness.
7. Choose your database and enter the database username and password.
8. Enter the data directory path. Double check that it does not exist.
9. Press OK.
10. On the "Add Company" form, add your details. We recommend that your Company code be the second level domain i.e. if your domain name is acme.com, then enter acme here. Enter the Celoxis URL to be http://your-server-name:8888.
11. You should be taken to a sample Dashboard
12. You can now move on to the site settings chapter to configure some advanced settings.