enigma-bbs/docs/admin/updating.md

32 lines
1.4 KiB
Markdown
Raw Normal View History

2018-12-04 03:17:27 +00:00
---
layout: page
title: Updating
---
2020-05-31 04:39:27 +00:00
# Updating
Keeping your system up to date ensures you have the latest fixes, features, and general improvements. Updating ENiGMA½ can be a bit of a learning curve compared to traditional binary-release systems you may be used to, especially when running from Git cloned source.
2018-12-04 03:17:27 +00:00
2020-05-31 04:39:27 +00:00
## Updating From Source
If you have installed using Git source (if you used the `install.sh` script) follow these general steps to update your system:
2018-12-04 03:17:27 +00:00
2020-05-31 04:39:27 +00:00
1. **Back up your system**!
2. Pull down the latest source:
```bash
cd /path/to/enigma-bbs
git pull
```
3. :bulb: Review `WHATSNEW.md` and `UPDATE.md` for any specific instructions or changes to be aware of.
4. Update your dependencies:
```bash
npm install # or 'yarn'
```
4. Merge updates from `config/menu_template.hjson` to your `config/yourbbsname-menu.hjson` file (or simply use the template as a reference to spot any newly added default menus that you may wish to have on your system as well!).
5. If there are updates to the `art/themes/luciano_blocktronics/theme.hjson` file and you have a custom theme, you may want to look at them as well.
6. Finally, restart your running ENiGMA½ instance.
2020-05-15 03:31:21 +00:00
:information_source: Visual diff tools such as [DiffMerge](https://www.sourcegear.com/diffmerge/downloads.php) (free, works on all major platforms) can be very helpful for the tasks outlined above!
2018-12-04 03:17:27 +00:00
2020-05-31 04:39:27 +00:00
:information_source: It is recommended to tail the logs and poke around a bit after an update.
2018-12-04 04:33:55 +00:00