Installation
Note
Please check the software requirements, before installing OC.
Debian/Ubuntu (example for 22.04 LTS)
Prepare environment:
Update Debian/Ubuntu system:
1root@shell> apt update
2root@shell> apt install unzip
3root@shell> apt-get install libpng-dev libcurl4-gnutls-dev libexpat1-dev gettext libz-dev libssl-dev*
Install nodejs:
1root@shell> sudo apt install curl (if debian)
2root@shell> curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
3root@shell> apt-get install -y nodejs
4root@shell> node -v // to check
Install yarn:
1root@shell> curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
2root@shell> echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
3root@shell> apt-get update && apt-get install yarn
4root@shell> yarn -v // to check
Install git:
1root@shell> apt-get install git
2root@shell> git --version // to check
Install java:
1root@shell> apt install openjdk-17-jdk
2root@shell> apt install openjdk-17-jre (can be optional)
3root@shell> java -version // to check
Install gradle:
1root@shell> apt-get install software-properties-common (if debian)
2root@shell> add-apt-repository ppa:cwchien/gradle
3root@shell> apt-get update
4root@shell> apt upgrade gradle
5root@shell> gradle -v // to check
Install neo4j:
1root@shell> wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo apt-key add -
2root@shell> echo 'deb https://debian.neo4j.com stable latest' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
3root@shell> apt update
4root@shell> apt install neo4j
5root@shell> /usr/bin/neo4j-admin dbms set-initial-password secret1234 // change password if you want
6root@shell> service neo4j status // to check
7root@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
8root@shell> sed -i '/#dbms.security.auth_enabled=false/c\dbms.security.auth_enabled=false' /etc/neo4j/neo4j.conf
9root@shell> service neo4j restart
10root@shell> systemctl enable neo4j
Install MariaDB:
1root@shell> apt install mariadb-server mariadb-client
2root@shell> mysql_secure_installation // set password
3root@shell> mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';" // change password if you want
4root@shell> mysql --version // to check
Install Application:
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
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
Enable OC service
root@shell> ln -s /opt/scripts/oc_service.sh /usr/bin/oc
Start frontend
root@shell> oc start_frontend
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
Install database
root@shell> cd /opt/src/backend/database
root@shell> mysql -u root -p -e "source oc_data.sql"
Build backend project
root@shell> cd /opt/src/backend/
root@shell> gradle build
Start backend
root@shell> oc start_backend
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:
Install nodejs:
1root@shell> zypper addrepo http://download.opensuse.org/repositories/devel:/languages:/nodejs/SLE_15_SP2 node14
2root@shell> zypper refresh
3root@shell> zypper install nodejs14
4root@shell> node -v
Install yarn:
1root@shell> sudo npm install yarn -g
2root@shell> yarn -v // to check
Install git:
1root@shell> zypper install git
2root@shell> git --version // to check
Install java:
1root@shell> zypper install java-1_8_0-openjdk
2root@shell> zypper install java-1_8_0-openjdk-devel
3root@shell> java -version // to check
Install gradle:
1root@shell> cd /tmp
2root@shell> wget https://services.gradle.org/distributions/gradle-5.6.2-all.zip
3root@shell> mkdir /opt/gradle
4root@shell> unzip -d /opt/gradle gradle-5.6.2-all.zip
5root@shell> export PATH=$PATH:/opt/gradle/gradle-5.6.2/bin
6root@shell> gradle -v // to check
Install neo4j:
1root@shell> zypper addrepo --refresh https://yum.neo4j.org/stable neo4j-repository
2root@shell> zypper refresh
3root@shell> zypper install neo4j-3.5.11
4root@shell> /usr/bin/neo4j-admin set-initial-password secret // change password if you want
5root@shell> neo4j start
6root@shell> neo4j status // to check
7root@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
8root@shell> sed -i '/#dbms.security.auth_enabled=false/c\dbms.security.auth_enabled=false' /etc/neo4j/neo4j.conf
9root@shell> neo4j restart
10root@shell> zypper install insserv
11root@shell> systemctl enable neo4j
Install MariaDB:
1root@shell> zypper install mariadb mariadb-client
2root@shell> rcmysql start
3root@shell> mysql_secure_installation // set password
4root@shell> mysql --version // to check
Install Application:
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
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
Enable OC service
root@shell> ln -s /opt/scripts/oc_service.sh /usr/bin/oc
Start frontend
root@shell> oc start_frontend
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
Install database
root@shell> cd /opt/src/backend/database
root@shell> mysql -u root -p -e "source oc_data.sql"
Build backend project
root@shell> cd /opt/src/backend/
root@shell> gradle build
Start backend
root@shell> oc start_backend
Welcome to OC
Visit opencelium http://SERVERIP:8888
Red Hat Enterprise Linux
Prepare environment:
Update Red Hat system:
1root@shell> yum update
Install nodejs:
1root@shell> yum install -y gcc-c++ make
2root@shell> curl -sL https://rpm.nodesource.com/setup_14.x | sudo -E bash -
3root@shell> yum install nodejs
4root@shell> node -v // to check
Install yarn:
1root@shell> curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo
2root@shell> yum install yarn
3root@shell> yarn -v // to check
Install git:
1root@shell> yum install git
2root@shell> git --version // to check
Install java:
1root@shell> yum install java-1.8.0-openjdk
2root@shell> yum install java-1.8.0-openjdk-devel
3root@shell> java -version // to check
Install gradle:
1root@shell> cd /tmp
2root@shell> wget https://services.gradle.org/distributions/gradle-5.6.2-all.zip
3root@shell> mkdir /opt/gradle
4root@shell> unzip -d /opt/gradle gradle-5.6.2-all.zip
5root@shell> export PATH=$PATH:/opt/gradle/gradle-5.6.2/bin
6root@shell> gradle -v // to check
Install neo4j:
1root@shell> rpm --import https://debian.neo4j.org/neotechnology.gpg.key
2root@shell> cat <<EOF> /etc/yum.repos.d/neo4j.repo
3 [neo4j]
4 name=Neo4j RPM Repository
5 baseurl=https://yum.neo4j.org/stable
6 enabled=1
7 gpgcheck=1
8 EOF
9root@shell> yum install neo4j-3.5.11
10root@shell> /usr/bin/neo4j-admin set-initial-password secret // change password if you want
11root@shell> service neo4j status // to check
12root@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
13root@shell> sed -i '/#dbms.security.auth_enabled=false/c\dbms.security.auth_enabled=false' /etc/neo4j/neo4j.conf
14root@shell> service neo4j restart
15root@shell> systemctl enable neo4j
Install MariaDB:
1root@shell> yum install mariadb-server
2root@shell> service mariadb start
3root@shell> mysql_secure_installation // set password
4root@shell> mysql --version // to check
Install Application:
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
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
Enable OC service
root@shell> cp -a /opt/scripts/oc_service.sh /usr/bin/oc
root@shell> oc start_frontend
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
Install database
root@shell> cd /opt/src/backend/database
root@shell> mysql -u root -p -e "source oc_data.sql"
Build backend project
root@shell> cd /opt/src/backend/
root@shell> gradle build
Start backend
root@shell> oc start_backend
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:
Install Ansible:
Note
Use default Ansible installation guide. You can find documentation here -> https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html
Get oc playbook:
1root@shell> cd /etc/ansible
2root@shell> git clone https://bitbucket.org/becon_gmbh/opencelium.setup.ansible.git .
Add localhost in ansible
root@shell> printf "[local]\nlocalhost ansible_connection=local" >> hosts
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:
Install Docker:
Use default Docker installation guide.
Getting started with opencelium-docker-compose:
1root@shell> git clone https://github.com/opencelium/opencelium-docker.git // we recommend to use always the latest tag version
2root@shell> cd opencelium-docker
Start OpenCelium using DockerHub images
root@shell> docker-compose up -d