Installation

Note

Please check the software requirements, before installing OC.

Debian/Ubuntu (example for 22.04 LTS)

Prepare environment:

1. Update Debian/Ubuntu system:

root@shell> apt update
root@shell> apt install unzip
root@shell> apt-get install libpng-dev libcurl4-gnutls-dev libexpat1-dev gettext libz-dev libssl-dev*

2. Install nodejs:

root@shell> sudo apt install curl (if debian)
root@shell> curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
root@shell> apt-get install -y nodejs
root@shell> node -v // to check

3. Install yarn:

root@shell> curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
root@shell> echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
root@shell> apt-get update && apt-get install yarn
root@shell> yarn -v // to check

4. Install git:

root@shell> apt-get install git
root@shell> git --version // to check

5. Install java:

root@shell> apt install openjdk-17-jdk
root@shell> apt install openjdk-17-jre (can be optional)
root@shell> java -version // to check

6. Install gradle:

root@shell> apt-get install software-properties-common (if debian)
root@shell> add-apt-repository ppa:cwchien/gradle
root@shell> apt-get update
root@shell> apt upgrade gradle
root@shell> gradle -v // to check

7. Install neo4j:

root@shell> wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo apt-key add -
root@shell> echo 'deb https://debian.neo4j.com stable latest' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
root@shell> apt update
root@shell> apt install neo4j
root@shell> /usr/bin/neo4j-admin dbms set-initial-password secret1234 // change password if you want
root@shell> service neo4j status  // to check
root@shell> sed -i '/#dbms.connectors.default_listen_address=0.0.0.0/c\dbms.connectors.default_listen_address=0.0.0.0' /etc/neo4j/neo4j.conf
root@shell> sed -i '/#dbms.security.auth_enabled=false/c\dbms.security.auth_enabled=false' /etc/neo4j/neo4j.conf
root@shell> service neo4j restart
root@shell> systemctl enable neo4j

8. Install MariaDB:

root@shell> apt install mariadb-server mariadb-client
root@shell> mysql_secure_installation // set password
root@shell> mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"  // change password if you want
root@shell> mysql --version // to check

Install Application:

1. Get frontend repository

root@shell> cd /opt
root@shell> git clone -b v3.1 https://github.com/opencelium/opencelium.git . // Get stable versions here https://github.com/opencelium/opencelium/tags

2. Build frontend project

root@shell> cd src/frontend
root@shell> yarn
root@shell> echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p // increasing the amount of inotify watchers

3. Enable OC service

root@shell> ln -s /opt/scripts/oc_service.sh /usr/bin/oc

4. Start frontend

root@shell> oc start_frontend

5. Create application.yml file for backend

root@shell> cd /opt/src/backend
root@shell> cp src/main/resources/application_default.yml src/main/resources/application.yml
root@shell> // make changes inside of application.yml. change neo4j and mysql database password

6. Install database

root@shell> cd /opt/src/backend/database
root@shell> mysql -u root -p -e "source oc_data.sql"

7. Build backend project

root@shell> cd /opt/src/backend/
root@shell> gradle build

8. Start backend

root@shell> oc start_backend

9. Welcome to OC

Visit opencelium http://SERVERIP:8888

Note

If yarn is not run use this command: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

SUSE Linux Enterprise Server (example for SLES 15 SP1)

Prepare environment:

1. Install nodejs:

root@shell> zypper addrepo http://download.opensuse.org/repositories/devel:/languages:/nodejs/SLE_15_SP2 node14
root@shell> zypper refresh
root@shell> zypper install nodejs14
root@shell> node -v

2. Install yarn:

root@shell> sudo npm install yarn -g
root@shell> yarn -v // to check

3. Install git:

root@shell> zypper install git
root@shell> git --version // to check

4. Install java:

root@shell> zypper install java-1_8_0-openjdk
root@shell> zypper install java-1_8_0-openjdk-devel
root@shell> java -version // to check

6. Install gradle:

root@shell> cd /tmp
root@shell> wget https://services.gradle.org/distributions/gradle-5.6.2-all.zip
root@shell> mkdir /opt/gradle
root@shell> unzip -d /opt/gradle gradle-5.6.2-all.zip
root@shell> export PATH=$PATH:/opt/gradle/gradle-5.6.2/bin
root@shell> gradle -v // to check

7. Install neo4j:

root@shell> zypper addrepo --refresh https://yum.neo4j.org/stable neo4j-repository
root@shell> zypper refresh
root@shell> zypper install neo4j-3.5.11
root@shell> /usr/bin/neo4j-admin set-initial-password secret // change password if you want
root@shell> neo4j start
root@shell> neo4j status  // to check
root@shell> sed -i '/#dbms.connectors.default_listen_address=0.0.0.0/c\dbms.connectors.default_listen_address=0.0.0.0' /etc/neo4j/neo4j.conf
root@shell> sed -i '/#dbms.security.auth_enabled=false/c\dbms.security.auth_enabled=false' /etc/neo4j/neo4j.conf
root@shell> neo4j restart
root@shell> zypper install insserv
root@shell> systemctl enable neo4j

8. Install MariaDB:

root@shell> zypper install mariadb mariadb-client
root@shell> rcmysql start
root@shell> mysql_secure_installation // set password
root@shell> mysql --version // to check

Install Application:

1. Get frontend repository

root@shell> cd /opt
root@shell> git clone -b <StableVersion> https://bitbucket.org/becon_gmbh/opencelium.git . // Get stable versions here https://bitbucket.org/becon_gmbh/opencelium/downloads/?tab=tags

2. Run frontend with yarn

root@shell> cd src/frontend
root@shell> yarn
root@shell> echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p // increasing the amount of inotify watchers

3. Enable OC service

root@shell> ln -s /opt/scripts/oc_service.sh /usr/bin/oc

4. Start frontend

root@shell> oc start_frontend

5. Create application.yml file for backend

root@shell> cd /opt/src/backend
root@shell> cp src/main/resources/application_default.yml src/main/resources/application.yml
root@shell> // make changes inside of application.yml. change neo4j and mysql database password

6. Install database

root@shell> cd /opt/src/backend/database
root@shell> mysql -u root -p -e "source oc_data.sql"

7. Build backend project

root@shell> cd /opt/src/backend/
root@shell> gradle build

8. Start backend

root@shell> oc start_backend

9. Welcome to OC

Visit opencelium http://SERVERIP:8888

Red Hat Enterprise Linux

Prepare environment:

1. Update Red Hat system:

root@shell> yum update

2. Install nodejs:

root@shell> yum install -y gcc-c++ make
root@shell> curl -sL https://rpm.nodesource.com/setup_14.x | sudo -E bash -
root@shell> yum install nodejs
root@shell> node -v // to check

3. Install yarn:

root@shell> curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo
root@shell> yum install yarn
root@shell> yarn -v // to check

4. Install git:

root@shell> yum install git
root@shell> git --version // to check

5. Install java:

root@shell> yum install java-1.8.0-openjdk
root@shell> yum install java-1.8.0-openjdk-devel
root@shell> java -version // to check

6. Install gradle:

root@shell> cd /tmp
root@shell> wget https://services.gradle.org/distributions/gradle-5.6.2-all.zip
root@shell> mkdir /opt/gradle
root@shell> unzip -d /opt/gradle gradle-5.6.2-all.zip
root@shell> export PATH=$PATH:/opt/gradle/gradle-5.6.2/bin
root@shell> gradle -v // to check

7. Install neo4j:

root@shell> rpm --import https://debian.neo4j.org/neotechnology.gpg.key
root@shell> cat <<EOF>  /etc/yum.repos.d/neo4j.repo
                        [neo4j]
                        name=Neo4j RPM Repository
                        baseurl=https://yum.neo4j.org/stable
                        enabled=1
                        gpgcheck=1
                        EOF
root@shell> yum install neo4j-3.5.11
root@shell> /usr/bin/neo4j-admin set-initial-password secret // change password if you want
root@shell> service neo4j status  // to check
root@shell> sed -i '/#dbms.connectors.default_listen_address=0.0.0.0/c\dbms.connectors.default_listen_address=0.0.0.0' /etc/neo4j/neo4j.conf
root@shell> sed -i '/#dbms.security.auth_enabled=false/c\dbms.security.auth_enabled=false' /etc/neo4j/neo4j.conf
root@shell> service neo4j restart
root@shell> systemctl enable neo4j

8. Install MariaDB:

root@shell> yum install mariadb-server
root@shell>     service mariadb start
root@shell> mysql_secure_installation // set password
root@shell> mysql --version // to check

Install Application:

1. Get frontend repository

root@shell> cd /opt
root@shell> git clone -b <StableVersion> https://bitbucket.org/becon_gmbh/opencelium.git . // Get stable versions here https://bitbucket.org/becon_gmbh/opencelium/downloads/?tab=tags

2. Run frontend with yarn

root@shell> cd src/frontend
root@shell> yarn
root@shell> echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p // increasing the amount of inotify watchers

3. Enable OC service

root@shell> cp -a /opt/scripts/oc_service.sh /usr/bin/oc
root@shell> oc start_frontend

4. Create application.yml file for backend

root@shell> cd /opt/src/backend
root@shell> cp src/main/resources/application_default.yml src/main/resources/application.yml
root@shell> // make changes inside of application.yml. change neo4j and mysql database password

5. Install database

root@shell> cd /opt/src/backend/database
root@shell> mysql -u root -p -e "source oc_data.sql"

6. Build backend project

root@shell> cd /opt/src/backend/
root@shell> gradle build

7. Start backend

root@shell> oc start_backend

8. Welcome to OC

Visit opencelium http://SERVERIP:8888

Note

Please make sure that firewall is disabled (service firewalld stop)!

Ansible

Note

Only available for Ubuntu system (>=16.04 LTS)!

Prepare environment:

1. Install Ansible:

Note

Use default Ansible installation guide. You can find documentation here -> https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html

2. Get oc playbook:

root@shell> cd /etc/ansible
root@shell> git clone https://bitbucket.org/becon_gmbh/opencelium.setup.ansible.git .

3. Add localhost in ansible

root@shell> printf "[local]\nlocalhost ansible_connection=local" >> hosts

4. Run playbook

root@shell> ansible-playbook --connection=local -e 'host_key_checking=False' playbooks/install_oc.yml

Docker Compose

Warning

We currently do not support Docker environments in productive use. We recommend using it for use in a test phase!

Note

You need at least 4 GB of RAM to run the containers. We recommend 8GB for a better performance.

Docker is a container-based software framework for automating deployment of applications. Compose is a tool for defining and running multi-container Docker applications.

This repo is meant to be the starting point for somebody who likes to use dockerized multi-container OpenCelium in production. The OpenCelium Docker image uses the stable branch of OpenCelium’s Git repo.

The Docker images are hosted on Dockerhub.

Install Docker Environment:

1. Install Docker:

Use default Docker installation guide.

• Docker Engine

• Docker Compose

2. Getting started with opencelium-docker-compose:

root@shell> git clone https://github.com/opencelium/opencelium-docker.git  // we recommend to use always the latest tag version
root@shell> cd opencelium-docker

3. Start OpenCelium using DockerHub images

root@shell> docker-compose up -d