loveyokado/synchronet repository overview

⁠Synchronet BBS on Docker

This image provides a pre-compiled version of Synchronet BBS built on Debian Bookworm. It is designed to be used in conjunction with the configuration files provided in the official GitHub repository.

⁠Quick Start

To ensure all required configuration files (sbbs.ini, etc.) are correctly mapped, it is highly recommended to clone the setup repository.

⁠1. Clone the Setup Repository

This repository contains the necessary directory structure and default configuration files.

git clone [email protected]:LoveYokado/synchronet-docker.git
cd synchronet-docker

⁠2. Launch with Docker Compose

The docker-compose.yml in the repository is pre-configured to use this Hub image:

services:
  sbbs:
    image: loveyokado/synchronet:latest
    container_name: sbbs
    volumes:
      - ./sbbs/ctrl:/sbbs/ctrl
      - ./sbbs/data:/sbbs/data
      - ./sbbs/text:/sbbs/text
      - ./sbbs/web:/sbbs/web
    ports:
      - "23:23"    # Telnet
      - "80:80"    # HTTP
      - "443:443"  # HTTPS
    restart: unless-stopped

Run the following command to start:

docker-compose up -d

⁠Why use the Repository?

Since this image expects existing configuration files in the /sbbs/ctrl directory, mounting an empty local directory will cause the service to fail. Cloning the repository provides these files immediately.