moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial 0.0.7-alpha to 0.0.8-alpha upgrade instructions

This commit is contained in:
Bryan Ashby 2017-11-29 12:24:21 -07:00
parent 99898c8352
commit 7809f92155
1 changed files with 86 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

151
UPGRADE.md
View File

@ -1,65 +1,86 @@
# Introduction # Introduction
This document covers basic upgrade notes for major ENiGMA½ version updates. This document covers basic upgrade notes for major ENiGMA½ version updates.
# Before Upgrading # Before Upgrading
* Always back up your system! * Always back up your system!
* At least back up the `db` directory and your `menu.hjson` (or renamed equivalent) * At least back up the `db` directory and your `menu.hjson` (or renamed equivalent)
# General Notes # General Notes
Upgrades often come with changes to the default `menu.hjson`. It is wise to 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 use a *different* file name for your BBS's version of this file and point to
it via `config.hjson`. For example: it via `config.hjson`. For example:
```hjson ```hjson
general: { general: {
menuFile: my_bbs.hjson menuFile: my_bbs.hjson
} }
``` ```
After updating code, use a program such as DiffMerge to merge in updates to After updating code, use a program such as DiffMerge to merge in updates to
`my_bbs.hjson` from the shipping `menu.hjson`. `my_bbs.hjson` from the shipping `menu.hjson`.
# Upgrading the Code # Upgrading the Code
Upgrading from GitHub is easy: Upgrading from GitHub is easy:
```bash ```bash
cd /path/to/enigma-bbs cd /path/to/enigma-bbs
git pull git pull
rm -rf npm_modules # do this any time you update Node.js itself rm -rf npm_modules # do this any time you update Node.js itself
npm install npm install
``` ```
# Problems # Problems
Report your issue on Xibalba BBS, hop in #enigma-bbs on Freenet and chat, or Report your issue on Xibalba BBS, hop in #enigma-bbs on Freenet and chat, or
[file a issue on GitHub](https://github.com/NuSkooler/enigma-bbs/issues). [file a issue on GitHub](https://github.com/NuSkooler/enigma-bbs/issues).
# 0.0.7-alpha to 0.0.8-alpha
# 0.0.1-alpha to 0.0.4-alpha ENiGMA 0.0.8-alpha comes with some structure changes:
## Node.js 6.x+ LTS is now **required** * Configuration files are defaulted to `./config`. Related, the `--config` option now points to a configuration **directory**
You will need to upgrade Node.js to [6.x+](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V6.md). If using [nvm](https://github.com/creationix/nvm) (you should be!) the process will go something like this: * `./mods/art` has been moved to `./art/general`
```bash * `./mods` is now reserved for actual user addon modules
nvm install 6 * Themes have been moved from `./mods/themes` to `./art/themes`
nvm alias default 6
``` With the above changes, you'll need to to at least:
* Move your `~/.config/enigma-bbs/config.hjson` to `./config/config.hjson` or utlize the `--config` option.
### ES6 * Move your `prompt.hjson` and `menu.hjson` (e.g. `myboardname.hjson`) to `./config`
Newly written code will use ES6 and a lot of code has started the migration process. Of note is the `MenuModule` class. If you have created a mod that inherits from `MenuModule`, you will need to upgrade your class to ES6. * Move any non-theme art files, and theme directories to their appropriate locations mentioned above
* Move any module directories such as `message_post_evt` to `./mods/`
## Manual Database Upgrade
A few upgrades need to be made to your SQLite databases: # 0.0.6-alpha to 0.0.7-alpha
No issues
```bash
rm db/file.sqltie3 # safe to delete this time as it was not used previously # 0.0.5-alpha to 0.0.6-alpha
sqlite3 db/message.sqlite No issues
sqlite> INSERT INTO message_fts(message_fts) VALUES('rebuild');
``` # 0.0.4-alpha to 0.0.5-alpha
No issues
## Archiver Changes
If you have overridden or made additions to archivers in your `config.hjson` you will need to update them. See [Archive Configuration](docs/archive.md) and `core/config.js` # 0.0.1-alpha to 0.0.4-alpha
## Node.js 6.x+ LTS is now **required**
## File Base Configuration You will need to upgrade Node.js to [6.x+](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V6.md). If using [nvm](https://github.com/creationix/nvm) (you should be!) the process will go something like this:
As 0.0.4-alpha contains file bases, you'll want to create a suitable configuration if you wish to use the feature. See [File Base Configuration](docs/file_base.md). ```bash
nvm install 6
nvm alias default 6
```
### ES6
Newly written code will use ES6 and a lot of code has started the migration process. Of note is the `MenuModule` class. If you have created a mod that inherits from `MenuModule`, you will need to upgrade your class to ES6.
## Manual Database Upgrade
A few upgrades need to be made to your SQLite databases:
```bash
rm db/file.sqltie3 # safe to delete this time as it was not used previously
sqlite3 db/message.sqlite
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 [Archive Configuration](docs/archive.md) and `core/config.js`
## File Base Configuration
As 0.0.4-alpha contains file bases, you'll want to create a suitable configuration if you wish to use the feature. See [File Base Configuration](docs/file_base.md).