User Tools

Site Tools


Table of Contents

Installation Guide

This guide will walk you through installation of the Telegard/2 BBS software.


This software is incomplete. You are installing a development snapshot. These instructions are the easiest way to configure and run Telegard in its current iteration. While other directories or runtimes may work, they have not bee tested. You should take care to ensure permissions are set properly. This program is NOT intended to be run as the root user, but as a regular non-priveleged user.

While this software is written in JRuby for portability, it has only been tested on Linux. Porting plans to other platforms can be found on the Roadmap.


1) Clone the git/hg repository or download and extract a snapshot.

2) Telegard expects to be located in base directory of '/opt/telegard'

mkdir -p /opt/telegard

3) Copy the distribution files to the base directory

cp -a opentelegard/telegard /opt/telegard

4) Install openjdk >=8 from your distro's package manager: Debian (or those based on Debian, such as NetRunner or BunsenLabs)

sudo apt-get install openjdk-9-jre


sudo yum install openjdk

5) Download version 9.2.0 or later of JRuby : * DO NOT use a pre-packed jruby from a linux distro.

6) Extract the JRuby distribution to the 'contrib' directory in /opt/telegard

 cd /opt/telegard/contrib ; tar -xzvf jruby-dist-
 ln -sf /opt/telegard/contrib/jruby- /opt/telegard/contrib/jruby

7) Check the variable TELEGARD_HOME in the provided shell scripts: * /opt/telegard/tg * /opt/telegard/ * /opt/telegard/

8) If you are using a different JRE, such as the official OpenJDK binary or

 the Oracle JDK, you will need to enable and set JAVA_HOME for the files 
 in step 7.

9) Load the runtime environment for starting Telegard

source /opt/telegard/

10) Install the required JRuby GEMS: jgem install rake rdoc-rake bcrypt sequel

When finished, you can run 'jgem list' and should see:

*** LOCAL GEMS ***

bcrypt (3.1.12 java)
cmath (default: 1.0.0)
csv (default: 1.0.0)
fileutils (default: 1.1.0)
ipaddr (default: 1.2.0)
jar-dependencies (default: 0.3.12)
jruby-openssl (default: 0.10.0 java)
jruby-readline (default: 1.2.2 java)
json (default: 2.1.0 java, 1.8.6 java)
psych (default: 3.0.2 java)
rake (12.3.1)
rake-ant (default: 1.0.4)
rdoc (default: 6.0.1, 3.12.2)
rdoc-rake (1.0.1)
scanf (default: 1.0.0)
sequel (5.11.0)
webrick (default: 1.4.2)

11) Start the database server

cd /opt/telegard ; ./ start

12) Generate & edit the sample configuration file

./tg -g
cp bbs/conf/telegard.conf.yaml.sample bbs/conf/telegard.conf.yaml
# launch your favorite editor: [vim, nano, ee, nv, kate, ...etc]
nano bbs/conf/telegard.conf.yaml

You should probably also alter the security.conf.yaml secret line. Somewhere in the middle. This will be fixed in a later release, but doing this will ensure your passwords are salted with a more unique key than what is shipped with this dev release.

13) Create the database schema

rake db:migrate

14) Create the documentation

rake doc:rdoc

15) Login


16) Your username is 'sysop' and the pwd is 'changeme'

17) Login again, this time, type “NEW” to create a new user.

guide/install.txt · Last modified: 2018/08/21 06:26 by Chris Tusa