Created Fri, Nov 27, 2009 by 少佐. Modified Thu, Mar 25, 2010. Cached Thu, Mar 25, 2010.
You are in: Root/MBox Documentation. vURL: /mbox/code.htm.

Introduction

Welcome to the MBox Sources page, which is the authoritative source for stuff relating to the MBox chat widget.

Table of Contents

  • 1.0: Live MBox Sources
  • 1.1: Main Code Files
  • 1.2: System Code Packages
  • 1.3: Additional JavaScript Files
  • 2.0: Archived MBox Sources
  • 2.1: Most Recent Archive
  • 2.2: Older Archives
  • 3.0: MBox Documentation

    • 1.0: Live MBox Sources [top]

    Here's a list of source files which together comprise the current iteration of MBox (MBox/0.64a, released on Sun, January 3, 2009). Click one of the links in the list to view the contents of a particular source file.

    NOTE: The source files provided here are the actual files which are used by my personal MBox. They are not copies of the files, and are therefore always current.

    Released under the GNU GPL (v2+). For further information about this, please read the GPL license∗. If you want to reuse my code, you must abide by the terms set out in that document.

    1.1: Main Code Files [top]

    The following file is found in the "/" directory of the typical MBox installation. This file was authored by myself.

    • mbox.cgi - MBox server, ties everything together

    1.2: System Code Packages [top]

    The following 19 files are found in the "/lib/" subdirectory of the typical MBox installation. These files were all authored by myself.

    1.3: Additional JavaScript Files [top]

    The following 2 files are found in the "/js/" subdirectory of the typical MBox installation. The code contained within these files was not created by myself. I just want to be entirely clear on this here, in case no-one bothers to read the copyright headers in the files.

    2.0: Archived MBox Sources [top]

    This section provides you with links to archived versions of MBox. Each archive contains a full installation of MBox with factory-default settings. Three user accounts exist in each archive ("Owner", "Administrator", "User", all set to the default password of "12345"), and the Message Archive of each contains three test messages.

    You will need to change the $path variable in "/lib/options.pm" to reflect the location of /mbox.cgi on your Web server, and you'll need to change the password hashes of the included user accounts (in "/data/db/USERS") so that random Internet strangers can't log in on those accounts and break shit.

    Finally, if you wish to make use of the bot (which is enabled by default), you will need to do the following: make a registered user account for the bot to use; log in as the owner; set -botname to the username of the new account. If you want to disable the bot outright, ser -botactive to off (or, if your bot has a user account, simply ban its user account using the 'bun' link on your admin linksbar).

    Apart from needing the above tasks performed, MBox will pretty much run straight out of the box. Remember to CHMOD the /mbox.cgi file as 755 (to make it executable), and to CHMOD the files in your /data/ and /tpl/ subdirectories as 600 (to hide them from public view).

    2.1: Most Recent Archive [top]

    Here is the most recent MBox archive.

    2.2: Older Archives [top]

    Following is a list of legacy (i.e. old, unsupported, probably incompatible) versions of MBox that I actually bothered to package into archive files. Do what you like with these.

    3.0: MBox Documentation [top]

    The MBox documentation now has its own section. For breaking news of new upgrades and things which may appear on this page, hit up the announcements page.