Auto Deployment

Deploy to Heroku Deploy to Koyeb Deploy on Railway Deploy to Render

Deployment Guide

Follow these steps carefully
1

Fork the Repository

Before deploying, you must fork the source code to your own account. This allows you to manage your own bot instance.

Fork on GitHub
2

Get Your Session ID

Go to the 'Connect Bot' page to link your WhatsApp. Once connected, you will receive a unique SESSION_ID. Copy and save it safely.

Get Session ID
3

Deploy to a Platform

Click one of the official deploy buttons above (Heroku/Koyeb/Railway). You will need to log in with your GitHub account.

4

Fill Environment Variables

During deployment, the platform will ask for variables. Copy the values from the 'Environment Variables' section below and paste them correctly.

5

Start the Bot

Wait for the build process to finish. Once it's done, your bot will automatically connect to WhatsApp and start working!

Environment Variables

Required Configuration (.env)

Configure these variables in your deployment platform (Koyeb/Heroku/Railway) before starting the bot.

.env Variables

==========================================
⚠️ [ CIPHER-MD SETUP & CONFIGURATION ] ⚠️
==========================================

 1️⃣ [ BASIC SETTINGS | මූලික සැකසුම් ]

 Your WhatsApp Session ID | ඔබගේ WhatsApp Session ID එක
SESSION_ID=your_session_id_here

 Number to get pairing code | ශෙශන් එක ලබාගැනීමට භාවිතා කරන අංකය
PAIRING_NUMBER=947xxxxxxxx

 Owner's phone number | බොට්ගේ අයිතිකරුගේ දුරකථන අංකය
OWNER_NUMBER=947xxxxxxxx

 MongoDB Database connection URL | MongoDB ඩේටාබේස් එකට අදාළ ලින්ක් එක
MONGO_URL=your_mongodb_url_here


 2️⃣ [ AI KEYS - GROQ CLOUD | AI පහසුකම් ]
 Get keys from: https://console.groq.com/keys

 Router Key for module identification | Module හඳුනාගැනීමට භාවිතා කරන යතුර
GROQ_API_KEY_1=your_groq_key_1

 Main Chat API Key | සාමාන්‍ය චැට් පහසුකම් සඳහා වන යතුර
GROQ_API_KEY_2=your_groq_key_2

 Backup API Key | අමතර යතුරක් ලෙස භාවිතා කරයි
GROQ_API_KEY_3=your_groq_key_3


 3️⃣ [ EXTERNAL API KEYS | බාහිර සේවා ]

 VirusTotal API Key for scanning files | ෆයිල් ස්කෑන් කිරීමට භාවිතා කරන යතුර
VT_API_KEY=your_virustotal_key

 RapidAPI Key for various tools | RapidAPI සේවාවන් සඳහා වන යතුර
RAPIDAPI_KEY=your_rapidapi_key

 NASA API Keys (Separate by comma if many) | නාසා දත්ත සඳහා (එකට වඩා ඇත්නම් කොමාවකින් වෙන් කරන්න)
 Example: NASA_API_KEYS=key1,key2,key3
NASA_API_KEYS=your_nasa_keys


 4️⃣ [ BOT CUSTOMIZATION | බොට්ගේ පෙනුම ]

 Name of your WhatsApp Bot | බොට් සඳහා ඔබ කැමති නමක්
BOT_NAME=CIPHER-MD

 Footer text for messages | මැසේජ් යටින් වැටෙන පාඨය
FOOTER=Powered by Syntiox

 Direct Link for Menu Image | මෙනු එකේ පෙන්වන රූපයේ ලින්ක් එක
MENU_IMAGE=https://your-image-link.com/image.jpg

Manual Deployment

For Advanced Users & VPS Hosting

Node.js Method

Recommended for local testing and standard Linux VPS hosting.

Terminal / Shell
# Clone repo
git clone https://github.com/sh4lu-z/Cipher-MD.git
cd Cipher-MD

# Install dependencies
npm install

# Start the bot
npm start

Docker Method

Recommended for high stability and isolated container environments.

Docker Compose
# Clone repo
git clone https://github.com/sh4lu-z/Cipher-MD.git
cd Cipher-MD

# Start container in background
docker-compose up -d