Installation
Note
Please check the software requirements, before installing OC.
Debian/Ubuntu (example for 22.04 LTS)
Prepare environment / Install required packages:
1apt update
2apt dist-upgrade
3apt install unzip gpg git
4
5wget -O - https://debian.neo4j.com/neotechnology.gpg.key | gpg --dearmor --yes -o /etc/apt/trusted.gpg.d/neo4j.gpg
6echo 'deb https://debian.neo4j.com stable latest' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
7
8apt update
9apt install mariadb-server mariadb-client openjdk-17-jdk neo4j=1:5.7.0 nginx
Install Application:
1cd /opt
2wget --content-disposition "https://packagecloud.io/becon/opencelium/packages/anyfile/oc_3.2.1.zip/download?distro_version_id=230"
3unzip -o -d /opt/ /opt/oc_3.2.1.zip
4rm /opt/oc_3.2.1.zip
5ln -s /opt/scripts/oc_service.sh /usr/bin/oc
Note
Configuration:
MariaDB:
1systemctl enable mariadb
2mysql_secure_installation
Note
Sometimes setting password doesn’t work prperly by mysql_secure_installation. Please check with this command:
1mysql -u root
If this works (without your password), please set your password again with this command:
1mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"
Change password (root) if you want.
Neo4j:
1/usr/bin/neo4j-admin dbms set-initial-password secret1234
2systemctl restart neo4j.service
3systemctl enable neo4j.service
Note
Change password (secret1234) if you want.
Nginx:
1rm /etc/nginx/sites-enabled/default
2ln -s /opt/conf/nginx.conf /etc/nginx/sites-enabled/
Note
For SSL use the following commands instead:
1rm /etc/nginx/sites-enabled/default
2ln -s /opt/conf/nginx-ssl.conf /etc/nginx/sites-enabled/oc
and include your own certificates in the config file:
1ssl_certificate /etc/ssl/certs/opencelium.pem;
2ssl_certificate_key /etc/ssl/private/opencelium.key;
1systemctl restart nginx
2systemctl enable nginx
OpenCelium:
1cp /opt/src/backend/src/main/resources/application_default.yml /opt/src/backend/src/main/resources/application.yml
Note
1openssl pkcs12 -export -out ssl-cert-snakeoil.p12 -in /etc/ssl/certs/ssl-cert-snakeoil.pem -inkey /etc/ssl/private/ssl-cert-snakeoil.key
1oc start_backend
Note
SUSE Linux Enterprise Server (example for SLES 15 SP5)
Prepare environment:
Install nodejs:
1zypper install nodejs20
Install yarn:
1sudo npm install yarn -g
Install git:
1zypper install git
Install java:
1zypper install java-17-openjdk
Install gradle:
1cd /tmp
2wget https://services.gradle.org/distributions/gradle-7.4.2-all.zip
3mkdir /opt/gradle
4unzip -d /opt/gradle gradle-7.4.2-all.zip
5export PATH=$PATH:/opt/gradle/gradle-7.4.2/bin
Install neo4j:
1zypper addrepo --refresh https://yum.neo4j.org/stable/5 neo4j-repository
2zypper refresh
3zypper install neo4j-5.7.0
4/usr/bin/neo4j-admin dbms set-initial-password secret1234
5neo4j start
6zypper install insserv
7systemctl enable neo4j
Note
Change password (secret1234) if you want.
Install MariaDB:
1zypper install mariadb mariadb-client
2rcmysql start
3mysql_secure_installation
4systemctl enable mariadb
Note
Sometimes setting password doesn’t work prperly by mysql_secure_installation. Please check with this command:
1mysql -u root
If this works (without your password), please set your password again with this command:
1mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"
Change password (root) if you want.
Install Application:
Get frontend repository
1cd /opt
2git clone -b <StableVersion> https://bitbucket.org/becon_gmbh/opencelium.git .
Note
Get stable versions here https://bitbucket.org/becon_gmbh/opencelium/downloads/?tab=tags
Run frontend with yarn
1cd src/frontend
2yarn
Note
If yarn doesn’t run properly, use this command to increase the amount of inotify watchers:
1echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
Enable OC service
1ln -s /opt/scripts/oc_service.sh /usr/bin/oc
Start frontend
1oc start_frontend
Create application.yml file for backend
1cd /opt/src/backend
2cp src/main/resources/application_default.yml src/main/resources/application.yml
Note
Make changes inside the file application.yml! Change neo4j and mysql database password.
Install database
1cd /opt/src/backend/database
2mysql -u root -p -e "source oc_data.sql"
Build backend project
1cd /opt/src/backend/
2gradle build
Start backend
1oc start_backend
Welcome to OC
1Visit opencelium http://SERVERIP:8888
Red Hat Enterprise Linux (example for Red Hat 9.2)
Prepare environment:
Update Red Hat system:
1yum update
Install nodejs:
1yum install -y gcc-c++ make
2curl -sL https://rpm.nodesource.com/setup_20.x | sudo -E bash -
3yum install nodejs
Install yarn:
1curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo
2yum install yarn
Install git:
1yum install git
Install java:
1yum install java-17-openjdk
Install gradle:
1cd /tmp
2wget https://services.gradle.org/distributions/gradle-7.4.2-all.zip
3mkdir /opt/gradle
4unzip -d /opt/gradle gradle-7.4.2-all.zip
5export PATH=$PATH:/opt/gradle/gradle-7.4.2/bin
Install neo4j:
1rpm --import https://debian.neo4j.com/neotechnology.gpg.key
2cat <<EOF> /etc/yum.repos.d/neo4j.repo
3[neo4j]
4name=Neo4j RPM Repository
5baseurl=https://yum.neo4j.com/stable/5
6enabled=1
7gpgcheck=1
8EOF
9yum install neo4j-5.7.0-1
10/usr/bin/neo4j-admin dbms set-initial-password secret1234
11systemctl start neo4j
12systemctl enable neo4j
Note
Change password (secret1234) if you want.
Install MariaDB:
1yum install mariadb-server
2systemctl start mariadb
3systemctl enable mariadb
4mysql_secure_installation
Note
Sometimes setting password doesn’t work prperly by mysql_secure_installation. Please check with this command:
1mysql -u root
If this works (without your password), please set your password again with this command:
1mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"
Change password (root) if you want.
Install Application:
Get frontend repository
1cd /opt
2git clone -b <StableVersion> https://bitbucket.org/becon_gmbh/opencelium.git .
Note
Get stable versions here https://bitbucket.org/becon_gmbh/opencelium/downloads/?tab=tags
Run frontend with yarn
1cd src/frontend
2yarn
Note
If yarn doesn’t run properly, use this command to increase the amount of inotify watchers:
1echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
Enable OC service
1ln -s /opt/scripts/oc_service.sh /usr/bin/oc
2oc start_frontend
Create application.yml file for backend
1cd /opt/src/backend
2cp src/main/resources/application_default.yml src/main/resources/application.yml
Note
Make changes inside the file application.yml! Change neo4j and mysql database password.
Install database
1cd /opt/src/backend/database
2mysql -u root -p -e "source oc_data.sql"
Build backend project
1cd /opt/src/backend/
2gradle build
Start backend
1oc start_backend
Welcome to OC
1Visit opencelium http://SERVERIP:8888
Note
Please make sure that firewall is disabled (service firewalld stop)!
Ansible
Note
Only available for Ubuntu systems (tested on 22.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:
1cd /etc/ansible
2git clone https://bitbucket.org/becon_gmbh/opencelium.setup.ansible.git .
Add localhost in ansible
1printf "[local]\nlocalhost ansible_connection=local" >> hosts
Run playbook
1ansible-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:
1git clone https://github.com/opencelium/opencelium-docker.git
2cd opencelium-docker
Note
We recommend to use always the latest tag version.
Start OpenCelium using DockerHub images
1docker-compose up -d
DEB package for Ubuntu 22.04 LTS
Prepare environment:
Update Ubuntu system:
1apt update
2apt install curl gnupg
Install java:
1apt install openjdk-17-jdk
Install neo4j:
1wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo apt-key add -
2echo 'deb https://debian.neo4j.com stable latest' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
3apt update
4apt install neo4j=1:5.7.0
5/usr/bin/neo4j-admin dbms set-initial-password secret1234
Note
Change password (secret1234) if you want.
Install Application:
Install deb package for OpenCelium:
1curl -s https://packagecloud.io/install/repositories/becon/opencelium/script.deb.sh | sudo bash
2sed -i 's!deb .*!deb [signed-by=/etc/apt/keyrings/becon_opencelium-archive-keyring.gpg] https://packagecloud.io/becon/opencelium/ubuntu jammy main!' /etc/apt/sources.list.d/becon_opencelium.list
3apt update
4apt install opencelium
Configure environment:
Secure MySql and set root password (required for new MySql installations):
1mysql_secure_installation
Note
Sometimes setting password doesn’t work prperly by mysql_secure_installation. Please check with this command:
1mysql -u root
If this works (without your password), please set your password again with this command:
1mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"
Change password (root) if you want.
Modify application.yml file for backend:
1cd /opt/opencelium/src/backend/src/main/resources
Note
Make changes inside the file application.yml! Change neo4j and mysql database password.
Restart backend:
1oc restart_backend
Welcome to OC:
1Visit opencelium http://SERVERIP
RPM package for SUSE Linux Enterprise Server 15 SP5
Prepare environment:
Install java:
1zypper install java-17-openjdk
Install neo4j:
1zypper addrepo --refresh https://yum.neo4j.org/stable/5 neo4j-repository
2zypper refresh
3zypper install neo4j-5.7.0
4/usr/bin/neo4j-admin dbms set-initial-password secret1234
5zypper install insserv
Note
Change password (secret1234) if you want.
Install Application:
Install rpm package for OpenCelium:
1curl -s https://packagecloud.io/install/repositories/becon/opencelium/script.rpm.sh | sudo bash
2sed -i 's!baseurl=.*!baseurl=https://packagecloud.io/becon/opencelium/sles/15.5/x86_64!' /etc/yum.repos.d/becon_opencelium.repo
3zypper install OpenCelium
Configure environment:
Secure MySql and set root password (required for new MySql installations):
1mysql_secure_installation
Note
Sometimes setting password doesn’t work prperly by mysql_secure_installation. Please check with this command:
1mysql -u root
If this works (without your password), please set your password again with this command:
1mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"
Change password (root) if you want.
Modify application.yml file for backend:
1cd /opt/opencelium/src/backend/src/main/resources
Note
Make changes inside the file application.yml! Change neo4j and mysql database password.
Restart backend:
1oc restart_backend
Welcome to OC:
1Visit opencelium http://SERVERIP
RPM package for RedHat 9.2
Prepare environment:
Update RedHat system:
1yum update
2yum install pygpgme yum-utils
Note
You may need to install the EPEL repository for your system to install these packages. If you do not install pygpgme, GPG verification will not work. In this case, you can install OpenCelium without GPG verification (see note at installation section).
Install java:
1yum install java-17-openjdk
Install neo4j:
1rpm --import https://debian.neo4j.com/neotechnology.gpg.key
2cat <<EOF> /etc/yum.repos.d/neo4j.repo
3[neo4j]
4name=Neo4j RPM Repository
5baseurl=https://yum.neo4j.com/stable/5
6enabled=1
7gpgcheck=1
8EOF
9yum install neo4j-5.7.0-1
10/usr/bin/neo4j-admin dbms set-initial-password secret1234
Note
Change password (secret1234) if you want.
Install Application (pygpgme required):
Install rpm package for OpenCelium:
1curl -s https://packagecloud.io/install/repositories/becon/opencelium/script.rpm.sh | sudo bash
2sed -i 's!baseurl=.*!baseurl=https://packagecloud.io/becon/opencelium/fedora/40/x86_64!' /etc/yum.repos.d/becon_opencelium.repo
3yum install OpenCelium
Note
Install Application without pygpgme:
Install rpm package for OpenCelium:
1cat << EOF > /etc/yum.repos.d/becon_opencelium.repo
2[becon_opencelium]
3name=becon_opencelium
4baseurl=https://packagecloud.io/becon/opencelium/fedora/40/x86_64
5repo_gpgcheck=0
6gpgcheck=0
7enabled=1
8sslverify=1
9sslcacert=/etc/pki/tls/certs/ca-bundle.crt
10metadata_expire=300
11EOF
12yum install OpenCelium
Configure environment:
Secure MySql and set root password (required for new MySql installations):
1mysql_secure_installation
Note
Sometimes setting password doesn’t work prperly by mysql_secure_installation. Please check with this command:
1mysql -u root
If this works (without your password), please set your password again with this command:
1mysql -u root -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"
Change password (root) if you want.
Modify application.yml file for backend:
1cd /opt/opencelium/src/backend/src/main/resources
Note
Make changes inside the file application.yml! Change neo4j and mysql database password.
Restart backend:
1oc restart_backend
Welcome to OC:
1Visit opencelium http://SERVERIP