enigma-bbs/UPGRADE.TXT

50 lines
1.5 KiB
Plaintext

INTRODUCTION
-------------------------------------------------------------------------------
This document covers basic upgrade notes for major ENiGMA½.
BEFORE UPGRADING
-------------------------------------------------------------------------------
* Always back ALL files in the 'db' directory
* Back up your menu.hjson (or renamed equivalent)
GENERAL NOTES
-------------------------------------------------------------------------------
Upgrades often come with changes to the default menu.hjson. It is wise to
use a *different* file name for your BBS's version of this file and point to
it via config.hjson. For example:
general: {
menuFile: my_bbs.hjson
}
After updating code, use a program such as DiffMerge to merge in updates to
my_bbs.hjson from the shipping menu.hjson.
FROM GITHUB
-------------------------------------------------------------------------------
Upgrading from GitHub is easy:
cd /path/to/enigma-bbs
git pull
npm install
PROBLEMS
-------------------------------------------------------------------------------
Report your issue on Xibalba BBS, hop in #enigma-bbs on Freenet and chat, or
file a issue on GitHub.
0.0.1-alpha to 0.0.4-alpha
-------------------------------------------------------------------------------
* Manual Database Upgrade
sqlite3 db/message.sqlite
INSERT INTO message_fts(message_fts) VALUES('rebuild');
* Archiver Changes
If you have overridden or made additions to archivers in your config.hjson
you will need to update them. See docs/archive.md and core/config.js