README

NCurses BrandMeister Master Menu
========================================
This script is for BrandMeister Master Server sysops. It will help you execute typical tasks you have to do on the server.
For convenience, the BrandMeister server ID and version number will display in the top menu title.

Requirements
========================================
This script relies on the following packages:
  ncurses
  dialog

Optionally, if you install the Twidge twitter client you can twitt directly from the menu. This is ideal to announce updates
made to the server, and restarts. The git repository for Twidge can be found here: https://github.com/jgoerzen/twidge


Installation
========================================

* Copy this file where you would like it to reside, and provide execution rights.
* For example:
  mv bm-menu.sh /opt/BrandMeister
  chmod 755 /opt/BrandMeister/bm-menu.sh
* Edit the file with your favorite editor, and update the MYEDITOR and TITLE variables to your liking.
  Common settings for MYEDITOR are:
  MYEDITOR=/usr/bin/vi
  MYEDITOR=/usr/bin/nano
  MYEDITOR=/usr/bin/emacs

* Assuming your shell is bash, edit the /etc/bash.bashrc file, and add the following line at the end:
/opt/BrandMeister/bm-menu.sh

* Login to the server, and the menu should appear.


Troubleshooting
========================================
* If when starting the script, you get an empty screen and immediately go back to the prompt, you might be missing the dialog package.
  Please run the below command and try again:
  apt-get install dialog

* If you see some strange ASCII characters instead of the lines around the menu, change the character encodinfg settings of your terminal to "UTC-8"


Latest version
========================================
The latest version of this file can be found on the BrandMeister code repository:
https://code.brandmeister.network/F4BWG/NCursesMasterMenu


Questions / Comments / Suggestions
========================================
Please send all questions, comments and suggestions to the email address: brandmeister at f4bwg.com