ChannelFinder-env

Configuration Environment for ChannelFinderService at https://github.com/ChannelFinder/ChannelFinderService

Pre-requirement packages

git make sudo tree maven jq

Elasticsearch

Three configurations are changed for the elasticsearch.

Elasticsearch JVM options : [default] -Xms1g -Xmx1g
Elasticsearch pack.security.enabled option : [default] false
Elasticsearch configuration location : [default] /etc/elasticsearch

These options can be changed through the variables CF_ES_JAVA_OPTS, CF_ES_CONF_PATH, and CF_ES_XPACK_SECURITY in configure/CONFIG_SITE.

Debian 11 / Rocky 8

make install.esdeb or install.esrpm
make conf.es
make conf.es.show
make start.es
make status.es

Note that conf.es will use the pack.security.enabled: false in elasticsearch.yml, where is in /etc/elasticsearch. The log file elasticsearch.log is located in /etc/elasticsearch.

macOS (M1)

brew install openjdk@18

make install.esmac
make conf.macos
make conf.esmac
make conf.esmac.show
make start.esmac
make stop.esmac

The log file elasticsearch.log is located in the installation location log folder of the elastisserch.

JAVA

The following four variables must be defined. Please setup them according to one's systems configuration.

        echo "JAVA_HOME:=/usr/"      > ./configure/CONFIG_COMMON.local
        echo "JAVA_PATH:=/usr/bin"  >> ./configure/CONFIG_COMMON.local
        echo "MAVEN_HOME:=/usr/"    >> ./configure/CONFIG_COMMON.local
        echo "MAVEN_PATH:=/usr/bin" >> ./configure/CONFIG_COMMON.local

Support OS

Debian 11 (EOL: 2024-06-01/2026-08-15), Rocky8 (EOL: 2029-05-31)

It will works with other systems. Please check github action workflows.

make init
make build
make install
make mapping
make sd_start
make sd_status

ChannelFinder log is shown in /var/log/syslog.

tail -f /var/log/syslog |grep java

make cflog.show

Please check Tomcat generic service, if CF doesn't start.

lsof -i:8080
systemctl status tomcat{9}
systemctl stop tomcat{9}
systemctl disable tomcat{9}

macOS (tested with aarch64 with brew)

make init
make conf.macbrew
make conf
make build
make run
make mapping
make mapping.clean

ChannelFinder Configuration

Please see docs/ChannelFinderConf.md.

Run Demo

Please see docs/ChannelFinderDemo.md.

make run
make run.status
make run.kill
make demo
make demo.clean

Docker Image

The Docker image is hosted at https://hub.docker.com/orgs/alscontrols And for further information, please see docs/Docker.md 🐳

tynanford/ChannelFinder-env