Skip to content

StrangeRanger/nadeko-manager-scripts

Repository files navigation

Nadeko Manager Scripts

Project Tracker Style Guide Codacy Badge

Nadeko Manager Scripts is a collection of Bash scripts that automates the complete lifecycle management of NadekoBot v6 on Linux systems. Designed for both beginners and experienced users, it eliminates the complexity of manual bot setup and maintenance through a simple, interactive interface.

Table of Contents

Demo

asciicast

Features

  • Easy Installation & Updates: Download and update NadekoBot with a single command
  • Service Management: Start, stop, and monitor NadekoBot as a systemd service with auto-restart capabilities
  • Automatic Prerequisites: Install all required dependencies (Python, ffmpeg, yt-dlp, etc.) for supported distributions
  • Backups: Back up important files (database, credentials, configuration)
  • Real-time Monitoring: View live colorized service logs with easy controls
  • Self-Updating: Automatically updates manager scripts while preserving your configurations
  • Distribution Support: Tested and supported across 9+ Linux distributions (Ubuntu, Debian, Fedora, Arch, etc.)
  • Safe Configuration: Preserves user settings during updates with automatic migration
  • Menu-Driven Interface: Simple, interactive menu with context-aware option enabling/disabling
  • Multiple Run Modes: Run NadekoBot normally or with automatic restart on failure

Getting Started

Prerequisites

Most prerequisites for running the Nadeko Manager Scripts are handled automatically by the n-prereqs.bash script, but you will need the following minimum requirements:

System Requirements:

  • Bash 4.0 or higher
  • curl (for downloading scripts)
  • systemd (required for service management)
  • 64-bit Linux system (32-bit systems are not supported)

Permissions:

  • Root or sudo access (required for installing packages and managing systemd services)

Download and Setup

The only script that needs to be downloaded to your system is m-bridge.bash. To do this, execute the following commands:

curl -O https://raw.githubusercontent.com/StrangeRanger/nadeko-manager-scripts/main/m-bridge.bash
chmod +x m-bridge.bash

Configurations

You can customize the behavior of the Nadeko Manager by editing a few variables at the top of the m-bridge.bash script.

Note

When the Manager updates itself, your changes to these variables (except for manager_repo and E_FILES_TO_BACK_UP) will be automatically merged into the new version. Changes to manager_repo and E_FILES_TO_BACK_UP must be reapplied manually if needed. The previous version of m-bridge.bash is backed up as m-bridge.bash.old in the same directory for reference or recovery.

Configurable Variables

  • manager_repo: The GitHub repository to fetch manager scripts from.

    • Default: "StrangeRanger/nadeko-manager-scripts"
  • manager_branch: The branch to use when downloading scripts.

    • Options:
      • main (stable, recommended)
      • dev (development, may be unstable)
      • NadekoV5 (for NadekoBot v5)
    • Default: "main"
  • E_SKIP_PREREQ_CHECK: Skip the prerequisites check if set to "true".

    • Options:
      • true: Skip checking for required packages (not recommended unless you know what you’re doing)
      • false: Check for prerequisites (recommended)
    • Default: "false"
  • E_FILES_TO_BACK_UP: List of files to back up when using the backup option.

    • Paths must start from Nadeko's parent directory (e.g., nadekobot/data/creds.yml)
    • Separate multiple files with spaces or newlines
    • Do not use commas or paths with spaces
    • Default files:
      nadekobot/data/NadekoBot.db
      nadekobot/data/NadekoBot.db-shm
      nadekobot/data/NadekoBot.db-wal
      nadekobot/data/bot.yml
      nadekobot/data/creds.yml
      

Usage

To start the Manager, execute the following command in the directory where you downloaded m-bridge.bash:

./m-bridge.bash

If successful, you'll see a menu with the following options:

1. Download NadekoBot
2. Run NadekoBot in the background
3. Run NadekoBot in the background with auto restart
4. Stop NadekoBot
5. Display 'nadeko.service' logs in follow mode
6. Install prerequisites
7. Back up important files
8. Exit

First-time setup:

  1. Start with option 6 to install prerequisites
  2. Use option 1 to download NadekoBot
  3. Configure your bot credentials (see NadekoBot documentation)
  4. Use option 2 or 3 to start your bot

Uninstallation

To completely remove the Nadeko Manager Scripts and related files from your system:

Important

Only remove the nadekobot directory and backup folders if you are certain you no longer need your bot data or backups.

Step 1: Stop and Remove the Service

sudo systemctl stop nadeko.service
sudo systemctl disable nadeko.service
sudo rm -f /etc/systemd/system/nadeko.service
sudo systemctl daemon-reload

Step 2: Remove Manager Scripts

rm -f m-bridge.bash
rm -f NadekoRun

Step 3: Remove NadekoBot Data (Optional)

# Remove backup directories
rm -rf important-files-backup

# Remove NadekoBot installation and old versions
rm -rf nadekobot nadekobot.old

Supported Distributions

The following is a list of all the Linux distributions that the Manager has been tested and are officially supported on:

Distro/OS Version Number End of Life EOL Information
Ubuntu 24.04
22.04
April 25, 2029
April 01, 2027
endoflife.date
ubuntu.com
Linux Mint 22
21
April 30, 2029
April 30, 2027
endoflife.date
linuxmint.com
Debian 12 June 10, 2026 endoflife.date
wiki.debian.org
Fedora 41
40
November 19, 2025
May 28, 2025
endoflife.date
docs.fedoraproject.org
fedorapeople.org
Alma Linux 9
8
May 31, 2032
March 01, 2029
endoflife.date
wiki.almalinux.org
Rocky Linux 9
8
May 31, 2032
May 31, 2029
endoflife.date
wiki.rockylinux.org
OpenSuse Leap 15.6 December 31, 2025 endoflife.date
en.opensuse.org
OpenSuse Tumbleweed Rolling N/A N/A
Arch Linux Rolling N/A N/A

Testing

The Manager has been tested across multiple Linux distributions using Docker containers. The testing infrastructure is located in the Distro Testing directory.

Two testing methods are available:

  • Pre-built Images from Docker Hub (Recommended): Pull and run pre-built images for each distribution. For detailed instructions on how to run and interact with these images, refer to the Docker Hub repository.

  • Building Images Locally: If you prefer to build the images on your machine, you can execute the provided script that builds all images locally:

    cd "Distro Testing"
    ./build-docker-images.bash

    Once built, you can run the images using the same instructions provided in the Docker Hub repository.

Support

For questions, suggestions, or bug reports, please open an issue on GitHub.

License

This project is licensed under the MIT License.

About

Bash script installer for NadekoBot v6.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 11