GRiMbot documentation

Back Up

This is the hosted copy of the GRiMbot technical manual. Use the table of contents to open any page in the manual.

Back Up

A Back Up is a copy of the files required to Restore GRiMbot on the same kind of packaged install. Copy those files while GRiMbot is stopped when you can. If you must copy while it is running, copy data/grimbot.db twice and keep both timestamps.

What to copy

Copy the whole set. A partial copy is not a verified Back Up.

Item Required
.env Yes
data/grimbot.db Yes for SQLite packaged installs
data/media-clips/ Yes if you use Media Library
data/ plugin and game JSON Yes if you use plugins or Chat Games
Plugin zip originals Recommended. Runtime copies live under data/plugins/installed/

Do not copy runtime/ from a packaged Core unless you are cloning the entire install. The database and .env are the recovery core.

Procedure

  1. Note the GRiMbot version from About or the package name.
  2. Stop GRiMbot if the operator can take a short outage.
  3. Copy .env and the entire data/ directory to offline storage you control.
  4. Confirm the copy sizes match the source.
  5. Store the copy away from the install disk.
  6. Record the date and GRiMbot version with the copy.

SECURITY

Encrypt the Back Up if it leaves the host. Anyone with .env and the database can impersonate the bot.

Verification

A Back Up is verified only after a Restore test on a spare folder or spare machine. File copy success is not Restore success.

Related pages