From 3be1225d49fbff7157d047acb5d423b12dc26881 Mon Sep 17 00:00:00 2001 From: thealhu Date: Fri, 28 Jun 2024 15:01:00 +0200 Subject: [PATCH 1/4] add auto docker compose container deploy script --- auto_docker_install_debian.sh | 43 +++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 auto_docker_install_debian.sh diff --git a/auto_docker_install_debian.sh b/auto_docker_install_debian.sh new file mode 100644 index 0000000..af0253d --- /dev/null +++ b/auto_docker_install_debian.sh @@ -0,0 +1,43 @@ +#!/bin/bash +if ! command -v docker &> /dev/null +then + echo -e "\e[32mINFO: Install Docker...\e[0m" + # Add Docker's official GPG key: + apt-get update -y + apt-get install ca-certificates curl -y + install -m 0755 -d /etc/apt/keyrings + curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc + chmod a+r /etc/apt/keyrings/docker.asc + # Add the repository to Apt sources: + echo \ + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \ + $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ + tee /etc/apt/sources.list.d/docker.list > /dev/null + apt-get update -y + apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y +fi +echo -e "\e[32mINFO: Docker is installed!\e[0m" +if [ -e "./TC2-BBS-mesh-docker/docker-compose.yaml" ]; then + echo -e "\e[32mINFO: TC2-BBS-mesh-docker folder is already present!\e[0m" +else + echo -e "\e[32mINFO: Installing TC2-BBS-mesh Docker Container in $(pwd)/TC2-BBS-mesh-docker ...\e[0m" + mkdir ./TC2-BBS-mesh-docker + cd TC2-BBS-mesh-docker + cat << EOF > docker-compose.yaml +services: + tc2-bbs-mesh: + image: thealhu/tc2-bbs-mesh:latest + restart: always + volumes: + - ./config:/config + container_name: tc2-bbs-mesh + # -- These parameters are optional and can be uncommented if needed. -- + # devices: + # - /dev/ttyUSB0:/dev/ttyUSB0 + # - /dev/ttyACM0:/dev/ttyACM0 +EOF + docker compose up + echo "" && echo "" + echo -e "\e[32mINFO: The TC2-BBS-mesh Docker container is now installed in $(pwd)/\e[0m" + echo -e "\e[32mINFO: Please make your changes to the configuration and then run ""$""docker compose up -d in $(pwd)/\e[0m" +fi From e8c3a323a1d133c34e8d9e496c4b64f6705a588b Mon Sep 17 00:00:00 2001 From: thealhu Date: Fri, 28 Jun 2024 15:04:16 +0200 Subject: [PATCH 2/4] move auto deploy file --- .../auto_docker_install_debian.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename auto_docker_install_debian.sh => docker/auto_docker_install_debian.sh (100%) diff --git a/auto_docker_install_debian.sh b/docker/auto_docker_install_debian.sh similarity index 100% rename from auto_docker_install_debian.sh rename to docker/auto_docker_install_debian.sh From eddaa9e6065832e5914e1698958928bff9fb2c87 Mon Sep 17 00:00:00 2001 From: thealhu Date: Fri, 28 Jun 2024 15:50:02 +0200 Subject: [PATCH 3/4] update readme.md with Docker Automatic Script Deployment dokumentation --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 45 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dd9c3ad..c7c5c1a 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,54 @@ [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B1OZ22Z) -This is the TC²-BBS system integrated with Meshtastic devices. The system allows for message handling, bulletin boards, mail systems, and a channel directory. +This is the TC²-BBS system integrated with Meshtastic devices. The system allows for message handling,bulletin boards, mail systems, and a channel directory. -### Docker +### Docker available If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub! [![Docker HUB](https://icon-icons.com/downloadimage.php?id=151885&root=2530/PNG/128/&file=docker_button_icon_151885.png)](https://hub.docker.com/r/thealhu/tc2-bbs-mesh) -## Setup + + +### Docker Automatic Script Deployment + +With this single command, TC²-BBS Meshtastic can be easily installed on Debian and all Debian-based Linux distributions, including Raspbian OS. + + curl -fsSL https://raw.githubusercontent.com/TheCommsChannel/TC2-BBS-mesh/main/docker/auto_docker_install_debian.sh | bash + +### Docker configuration: + +After executing the Automatic Script Deployment command, TC²-BBS Meshtastic still needs to be configured. First, navigate to the installation directory where the Docker Compose definition is stored: + + cd ./TC2-BBS-mesh-docker + +**This step is optional:** if the mestastic node is connected to the system via USB, we need to pass it through to the newly created Docker container so that it can control the USB device: + +nano docker-compose.yaml + + # devices: <- uncomment if one of the two is needed + # - /dev/ttyUSB0:/dev/ttyUSB0 <- uncomment if needed + # - /dev/ttyACM0:/dev/ttyACM0 <- uncomment if needed + +To customize the config file of the TC²-BBS server software itself: + + nano ./config/config.ini + +After that, the TC²-BBS Meshtastic can simply be started as a service in the background: + + docker compose up -d + + #for debugging use: + docker compose up + + #for stopping use: + docker compose down + + + + +## Setup manually ### Requirements @@ -54,7 +93,8 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub! pip install -r requirements.txt ``` -5. Set up the configuration in `config.ini`: +## Configure config.ini +Set up the configuration in `config.ini`: **[interface]** If using `type = serial` and you have multiple devices connected, you will need to uncomment the `port =` line and enter the port of your device. @@ -85,7 +125,7 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub! bbs_nodes = !f53f4abc,!f3abc123 ``` -### Running the Server +## Running the Server manually Run the server with: From 13bd3f2b6079cc26780e61e5cf0bd8284a3ce9bf Mon Sep 17 00:00:00 2001 From: thealhu Date: Fri, 28 Jun 2024 15:53:06 +0200 Subject: [PATCH 4/4] fix docker compose indentation in readme.md file --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c7c5c1a..4a18905 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,11 @@ After that, the TC²-BBS Meshtastic can simply be started as a service in the ba docker compose up -d - #for debugging use: - docker compose up - - #for stopping use: - docker compose down + #for debugging use: + docker compose up + + #for stopping use: + docker compose down