arrikhan/cgate repository overview

⁠Description

This is a docker image based on arm32v7 hardware for running on RaspberryPi. It has been tested on Raspberry Pi3+ in conjunction with a homebridge container for enabling cbus network control from Amazon Alexa and/or Apple Homekit.

I highly recommend 'onzu's homebridge w/UI'⁠ installed with the 'Homebridge CBUS plugin'⁠ for seamless cbus->voice controlled integration. This is what I currently run with miriads of other plugins to connect in many other 'smart' devices.

⁠Overview

More detailed instructions to help beginners from scratch to come. Docker compose used with below yaml file example. It is assumed you have docker, and docker-compose installed on the raspberry pi sudo apt install docker docker-compose A local file structure is setup for cgate configuration, cgate project and cgate logs files that the container can access/update. Example shown below can be tailored to what you want to call them. Just substitute names in docker-compose.yml file and change the ./config portion of ./config:/config for example to the location relevant to where you place the docker-compose.yml file.

file structure

---cgate-|
          --- config (access.txt and C-GateConfnig.txt)
          --- tag (project.XML)
          --- logs (log files generated by cgate , event.txt)

• create a local file structure
• place CBUS project file (XML) into tag directory
• place your own cgate config files (or use the generated defaults after first start) into config directory. I've used network_mode:host in setup to avoid defining specific ports used by cgate, so as long as your cgate network can get to the host, it can get to the container.
• create below docker-compose.yml file into your local cgate directory (example uses cgate directory under pi user home directory, ie: ~/cgate)

⁠Instructions

• create local directory structure under home of user for local files

cd ~
mkdir cgate
cd ~/cgate
mkdir tag
mkdir config
mkdir logs
nano docker-compose.yml

• create docker-compose.yml file to tell docker how to configure container

nano docker-compose.yml

⁠docker-compose

version: '2'
services:
  cgate:
    image: arrikhan/cgate:latest
    container_name: cgate
    network_mode: host
    restart: unless-stopped
    volumes:
      - ./config:/config
      - ./tag:/tag
      - ./logs:/logs

• run docker compose from within the directory with yml file. This will create default cgate files if you haven't supplied them for you to edit as needs.

docker-compose up -d

You can call a specific cgate server version based on the versions available in the "tags" tab above by updating image:arrikhan/cgate:latest to image:arrikhan/cgate:2.11.4_3251 where 2.11.4_3251 version has been selected here. Just ask for a specific version to be built if the one you want doesn't exist.