User Tools

Site Tools


guide:admin

System Operator's Guide

OpenTG is a modern implementation of a classic Bulletin Board System (BBS). Sucessful operation of your BBS will require an understanding of the architecture, design, configuration, and features of the software.

Installation

Please refer to the installation guide for detailed instructions on getting the software installed and running.


Configuration

OpenTG provides a configuration file that provides operators the ability to change the runtime settings, behavior, look & feel, and rules that will be enforced. The configuration file is a YAML formatted text file located in the /conf directory of the base installation. This section will explain the configuration sections and the options provided.

The default base directory on Linux is

/opt/telegard/bbs/conf

Generating an Example

The installation process should generate a working configuration file. If you need to generate one by hand, you can use pass a '-g' flag to the 'tg' command. For example:

/opt/telegard$ ./tg -g
Sample config created: conf/telegard.conf.yaml.sample

Example

---
bbs:
  name: Telegard/2 BBS
  tagline: Another Installation of OpenTelegard/2
  theme: opentg
  enabled: true
database:
  host: localhost
  name: opentg
  user: sa
  pass: <hashed pw hidden>
login:
  attempts: 5
  lockout: 8
  usehint: true
  allownew: true
signup:
  default_group: USERS
  ask_address: true
  ask_postal: true
  ask_country: true
  ask_phone: true
  ask_gender: true
  ask_bday: true
  ask_custom1: true
  custom1: How did you hear about us? (75 chars max)
  ask_custom2: false
  custom2: ''
  ask_custom3: false
  custom3: ''
notify:
  notify_user: true
  user_name: SYSOP
  notify_group: true
  group_name: SYSOPS
  on_signup: true
  on_bbslist_submission: true
  on_user_lockout: true
feature:
  bbslist: true
limits:
  timebank_max: 300
  files_upload_max: 1024
editors:
  default_editor: nano
  nano_exec: /bin/rnano
  nano_restrict: -R
  nvim_exec: /usr/local/bin/nvim
  nvim_restrict: -Z
  allow_tgedit: false
announcements:
  pause_between: true
  auto_purge: true  

Section: BBS

This section is for the BBS main configuration variables.

Variable Description Options
name The name of your sytem
tagline A slogan or tagline that provides a short description of your BBS.
theme the default template theme for rendering output. opentg
enabled Turns the bbs on or off. If set to 'false', the BBS will disconnect new users with a message and end. true, false

Section: Database

Configuration settings for the database backend. Currently, the system only supports an embedded server. The only thing you might want to change is the password. See the section of the install guide on setting the database password.

Variable Description Options
host Database server hostname localhost
name Database name opentg
user Database username sa
pass Database password for username

Section: Login

Variable Description Options
attempts Number of failed login attempts before disconnect. integer
lockout Number of failed attempts for a single username before lockout. integer
usehint Display a password hint after failed attempts. true, false
allownew Allow new-users to register at the login prompt. true, false

Section: Signup

The new user signup form can be customized. You can choose to enable or disable certain questions which are not required and may not be desirable to your users. The form also provides 3 custom questions you may choose to use.

Variable Description Options
default_group Default group new users are added to. USERS, LOCKED, COSYSOP, SYSOP
ask_address ask for a mailing address true, false
ask_postal ask for a postal zip code true, false
ask_country ask for a country true, false
ask_phone ask for phone number true, false
ask_gender ask gender true, false
ask_bday ask birthday true, false
ask_custom1 ask a custom question #1 true, false
custom1 quoted string
ask_custom2 ask a custom question #2 true, false
custom2 quoted string
ask_custom3 ask a custom question #3 true, false
custom3 quoted string

Section: Notify

Notifications are a way that operators and users can stay informed about events.

Variable Description Options
notify_user Notify a specific user true, false
user_name Which user to notify <valid-username>
notify_group Notify a group of users true, false
group_name Which group to notify <valid-groupname>
on_signup Notify on new user sign-ups true, false
on_bbslist_submission Notify on new BBS List submission true, false
on_user_lockout Notify on user lockout true, false

Section: Feature

This configuration section allows you to enable or disable certain features of the system.

Variable Description Options
bbslist BBS Directory List feature true, false

Section: Limits

Enforceable limits

Variable Description Options
timebank_max Maximum amount a single use may store in their time bank <integer of minutes>
files_upload_max Maximum filesize a user may upload <integer of megabytes>

Section: Editors

Configuration settings specific to text editors

Variable Description Options
default_editor Default editor to be used by all users. nano, nvim
nano_exec filesystem location of the executable binary for nano. for example: /usr/bin/nano <full filesystem path>
nano_restrict command line switch passed to nano for Restricted mode. This mode prevents certain functions such as changing the filename, escaping to shell, etc which could become a security hole if left unrestricted. On some systems /bin/rnano is a shortcut for running in this mode. for example: -R -R
nvim_exec neovim executable path <full filesystem path>
nvim_restrict command line switch passed to nvim for Restricted mode -Z
allow_tgedit allow the very basic, line to line editor 'tgedit' true, false

Section: Announcements

Configuration variables specific to the announcements feature

Variable Description Options
pause_between use a “pause” prompt after displaying each announcement true, false
auto_purge should expired news items be deleted automatically true, false

Groups and Role Based Access Controls

This section describes the Role Based Access Control (RBAC) features and how to configure them.

Group Definition

guide/admin.txt · Last modified: 2018/10/23 21:25 (external edit)