README 2.03 KB
Newer Older
F4BWG's avatar
F4BWG committed
1
NCurses BrandMeister Master Menu
2
========================================
F4BWG's avatar
F4BWG committed
3
This script is for BrandMeister Master Server sysops. It will help you execute typical tasks you have to do on the server.
4
For convenience, the BrandMeister server ID and version number will display in the top menu title.
F4BWG's avatar
F4BWG committed
5

6
7
8
9
10
11
Requirements
========================================
This script relies on the following packages:
  ncurses
  dialog

F4BWG's avatar
F4BWG committed
12
13
14
15
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


F4BWG's avatar
F4BWG committed
16
Installation
17
========================================
F4BWG's avatar
F4BWG committed
18
19
20
21
22

* 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
23
* Edit the file with your favorite editor, and update the MYEDITOR and TITLE variables to your liking.
F4BWG's avatar
F4BWG committed
24
25
26
27
  Common settings for MYEDITOR are:
  MYEDITOR=/usr/bin/vi
  MYEDITOR=/usr/bin/nano
  MYEDITOR=/usr/bin/emacs
F4BWG's avatar
F4BWG committed
28
29
30
31
32
33

* 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.

34
35
36
37
38
39
40

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

41
42
43
* 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"


F4BWG's avatar
F4BWG committed
44
Latest version
45
========================================
F4BWG's avatar
F4BWG committed
46
47
48
49
50
The latest version of this file can be found on the BrandMeister code repository:
https://code.brandmeister.network/F4BWG/NCursesMasterMenu


Questions / Comments / Suggestions
51
========================================
F4BWG's avatar
F4BWG committed
52
Please send all questions, comments and suggestions to the email address: brandmeister at f4bwg.com