How To Update PhantomBot


#1

This is a walkthrough on how to update to the latest and greatest PhantomBot release, without losing any of your data.

Windows / macOS:

  • You’re going to need the latest version of PhantomBot from here.

  • Once you have the latest release downloaded you need to extract PhantomBot.

    • Windows: Right click the zip file, select extract all.
    • MacOS: Double click the zip file.
  • Find your current PhantomBot installation, the one you’re updating from.

    • For standard installations.
      • Copy the config folder into the newly extracted PhantomBot folder. (v2.3.9 or newer)
        * Copy your botlogin.txt and phantombot.db (not the one with journal) file over to the new folder. (v2.3.8 or older)
    • For installations with custom language files.
      • Copy only your modified/custom files over to the new PhantomBot folder.
  • Launch your new PhantomBot. You can keep your old PhantomBot folder as a backup for the future.

Linux:

1. Stop your PhantomBot:

First switch to your botuser:

sudo su - botuser

Then run this:

kill $(pgrep -f PhantomBot)

or if you have it, use:

sudo systemctl stop phantombot

Wait 20 seconds and check if your PhantomBot is not running:

ps -ef | grep PhantomBot

2. Update PhantomBot:

Switch to the home directory:

cd ~

Rename the old folder:

mv phantombot phantombot-old

Get the latest PhantomBot release:

wget https://github.com/PhantomBot/PhantomBot/releases/download/vX.X.X/PhantomBot-X.X.X.zip

Replace the X with the current release version like PhantomBot-2.3.5.zip!

After the download has finished, we have to unzip the files.

unzip PhantomBot-X.X.X.zip

To make future updates a bit easier, we have to rename the PhantomBot folder.

mv PhantomBot-X.X.X phantombot

Copy phantombot.db and botlogin.txt to your new folder:

cp -R ./phantombot-old/config/ ./phantombot/ (v2.3.9 or newer)

Do not copy your database or botlogin into the config folder, the bot will do this for you.
cp ./phantombot-old/phantombot.db ./phantombot/ (v2.3.8 or older)
cp ./phantombot-old/botlogin.txt ./phantombot/ (v2.3.8 or older)

For installations with custom language files, scripts or sound effects: Copy only your modified/custom files over to the new PhantomBot folder.

The last thing we need to do is to assign the right privileges to make the launch.sh and launch-service.sh files executable.

cd phantombot
chmod u+x launch-service.sh launch.sh

Now we are ready to launch PhantomBot again. You can run the bot with:

./launch.sh

or

sudo systemctl start phantombot


How can I tranfer points, commands etc. from an older to a new version?
Transfering Bot configs
Error after Updating the Bot
Updating from PB 2.3.6.1 to 2.3.7.1 on Raspberry Pi 3
Settings from last build
Upgraded to new version, how to bring over settings?
Can i save it?
Error with starting nightly build
Update not working
Subscriber count is not working
Transfer db from old to new updated version?
Bot bugged and skipping 20+ songs
How to prevent commands from breaking with each updates?
Having issues with the Playlist importer again
Discord online/game change alerts + bot stream status issues
Points commands don't work
Song request
`start phantombot` command won't work
How to install New version but keep your bot settings you currently have
#2