Skip to content

INSTALLATION.md

Latest commit

 

History

History
194 lines (127 loc) · 3.68 KB

INSTALLATION.md

File metadata and controls

194 lines (127 loc) · 3.68 KB

Installation

Complete installation guide for ManyBot on different platforms.

Index

Linux (with systemd)

This is the easiest and recommended way to run ManyBot. The systemd service manages the bot automatically.

Prerequisites

  • Linux with systemd (Ubuntu, Debian, Fedora, Arch, etc.)
  • Node.js 18+ and npm 9+
  • Root access (sudo)

Installation

# 1. Clone the repository
git clone https://git.maneos.net/synt-xerror/manybot
cd manybot

# 2. Create the configuration file
cp manybot.conf.example manybot.conf
nano manybot.conf

# 3. Run the dependency installation
bash ./setup

# 4. Install and enable systemd service (requires root)
sudo bash ./setup

Authentication:

ManyBot supports two authentication methods:

  1. QR Code (default): Scan the QR code in logs
  2. Pairing code: Set PHONE_NUMBER in manybot.conf with your number (e.g., 5511999999999)
journalctl -u manybot -f

Useful Commands

# Check service status
systemctl status manybot

# View logs in real-time
journalctl -u manybot -f

# Stop the bot
systemctl stop manybot

# Start the bot
systemctl start manybot

# Restart the bot
systemctl restart manybot

# Disable auto-start
systemctl disable manybot

# Update the bot
git pull
bash ./setup
sudo systemctl restart manybot

Does the systemd service run as root?

Yes! The service is configured to run as root to ensure full system access. This is necessary for:

  • Accessing session files and logs
  • Running Chromium/Puppeteer correctly
  • Having complete network permissions

Linux (manual)

Installation

# 1. Clone the repository
git clone https://git.maneos.net/synt-xerror/manybot
cd manybot

# 2. Create the configuration file
cp manybot.conf.example manybot.conf
nano manybot.conf

# 3. Run the dependency installation
bash ./setup

# 4. Initial ManyBot configuration
bash ./setup

First run

node ./src/main.js

Scan the QR Code in WhatsApp (or enter the code if a number was configured):

Menu → Linked Devices → Link a Device

💡 Tip: To run in the background without systemd, use nohup:

nohup node ./src/main.js > manybot.log 2>&1 &

Windows

ManyBot was designed for Linux, but works on Windows via Git Bash.

Prerequisites

  1. Git Bash: https://git-scm.com/download/win
  2. Node.js: https://nodejs.org (choose "Windows Installer (.msi)")

Installation

After installing both, open Git Bash and follow the same steps as the Linux installation.

Termux (Android)

⚠️ Warning: Experimental support. No guarantee of functionality.

# Install Termux from F-Droid (don't use Play Store)
# https://f-droid.org/packages/com.termux/

# Update packages
pkg update && pkg upgrade

# Install dependencies
pkg install nodejs git

# Clone and install
git clone https://git.maneos.net/synt-xerror/manybot
cd manybot

Follow the Linux configuration steps from step 2.

Troubleshooting

QR Code scanning error

  • Clear Chrome/Chromium data from Termux
  • Delete the .wwebjs_* folders and try again

Bot not responding to commands

  • Check CMD_PREFIX in manybot.conf
  • Check if the plugin is enabled with manyplug list and verify it's in PLUGINS in manybot.conf

Installation errors

# Clean npm cache
npm cache clean --force

# Reinstall dependencies
rm -rf node_modules package-lock.json
npm install

Next Steps