Server directory structure

The full structure of the HelpChat Server 13 installation directory and what each directory is for.

Warning

The imdata/ directory holds the database and all chat data. It is the most important directory; back it up regularly.

Directory structure

HelpChat Server 13/ Installation root

├── helpchatsvr.exe Main program

├── bin/ Helper tools

│ ├── ffmpeg.exe Video transcoding

│ ├── ffprobe.exe Media information probe

│ └── hcupdater.exe Server auto-update tool

├── config/ Configuration files

│ └── helpchatsvr.ini Main configuration file (ports, database, run mode, etc.)

├── ssl/ SSL certificate directory (if configured)

│ ├── cert.crt SSL certificate file

│ └── key.pem SSL private key file

├── backup/ Backup directory

├── frame/ Resources sent to clients

│ ├── photo/ Default avatar library (c001–c136.png)

│ └── signature/ Default signatures

├── imdata/ ⭐ Core data directory (must be backed up)

│ ├── helpchat_office.db SQLite database for enterprise mode

│ ├── helpchat_market.db SQLite database for customer service mode

│ ├── auth.json License information

│ ├── sessions.json Online session data

│ ├── cloud/ Cloud drive file storage

│ ├── data/ Files, images, voice messages, etc. sent and received in chats

│ ├── logs/ Run logs

│ ├── crash/ Crash dump logs

│ └── temp/ Temporary files

├── public/ Web resources and user data

│ ├── assets/ Static resources (file type icons, default avatars, etc.)

│ ├── branding/ Custom branding resources

│ ├── channel/ Channel icons (.png format)

│ ├── download/ Client download page and installer distribution

│ ├── forum/ Files uploaded to the forum / knowledge base

│ ├── groups/ Group avatars

│ ├── updater/ Client auto-update installers

│ ├── users/ User avatars

│ ├── favicon.ico Site icon

│ └── index.html Web admin console entry page

Key directories

config/helpchatsvr.ini: the only configuration file. It contains all server settings, including port numbers, the database connection and the run mode. It stays compatible when you upgrade, so it does not need to be changed.

imdata/: holds the database files and all user data. In SQLite mode, helpchat_office.db and helpchat_market.db are the complete database. Never overwrite or delete them.

imdata/data/: files, images, voice messages, videos, etc. sent and received in chats. This directory keeps growing, so make sure there is enough disk space.

public/updater/: holds client installers. Together with update.conf, it pushes automatic updates to clients.

public/download/: the built-in client download page. Users can open it at http://server-IP:6980/download.

Tip

To upgrade, replace only helpchatsvr.exe and bin/hcupdater.exe. No other directories or files need to change. See Upgrading the server.