Difference between revisions of "DRAFT1846 Implementation Guide"

From BOARD18 Project WIKI
Jump to navigation Jump to search
m (The DRAFT1846 Database)
m (Where To Get DRAFT1846)
 
Line 15: Line 15:
 
== Where To Get DRAFT1846 ==
 
== Where To Get DRAFT1846 ==
 
The latest version of DRAFT1846 is available as a zip file  
 
The latest version of DRAFT1846 is available as a zip file  
'''[https://drive.google.com/drive/folders/1jlMXIadtm1RWK46qMSkP0_iA5PJtnbfn <span style="color: Green">in this folder</span>]'''<br>
+
'''[https://drive.google.com/drive/folders/1jlMXIadtm1RWK46qMSkP0_iA5PJtnbfn?usp=sharing <span style="color: Green">in this folder</span>]'''<br>
 
<span style="color: Fuchsia">Please always use the latest version.</span>
 
<span style="color: Fuchsia">Please always use the latest version.</span>
  

Latest revision as of 06:07, 26 June 2020

DRAFT1846 is what could be called an "add on" to BOARD18.
It is the result of a separate project and only applies to one game, 1846.
This guide is directed at someone who wishes to install a copy on their own site.

This guide assume that you already have shell access to a server environment that is running Apache with PHP version 5.3 or later and MySQL version 5.5 or later.
You first have to decide whether to create a new domain for the application or to put it on a sub directory of an existing domain.
In this guide, the directory that you choose to use will be referred to as the web root directory regardless of whether it is really a root or not.

The work of setting up a domain is well documented and quite beyond the scope of this guide. So it will be assumed that this work has been done.

Where To Get DRAFT1846

The latest version of DRAFT1846 is available as a zip file in this folder
Please always use the latest version.

The DRAFT1846 Database

Before starting this task, you will have to create a new (empty) MYSQL database on your DB server.
How to do this varies and is beyond the scope of this how to document.

But I do suggest that you create two usernames for access to this database. The first or "root user" should have complete access to the database and should be used to create and load it.
The second or "draft1846 user" should be limited to select, insert and update access. This is the username that you will put in the config.php file in the php sub directory of the web root directory.
The draft1846 web application will use this second username. It is called "draft1846" in the supplied php/config.php file.
The following commands can be used to create this username if the database resides on the web server:

 
CREATE USER 'draft1846'@'localhost' IDENTIFIED BY 'draft1846';
GRANT SELECT, INSERT, UPDATE ON draft1846.* TO 'draft1846'@'localhost';

Many web hosting providers (such as DreamHost) provide web pages (control panels) that have all the capabilities needed to create a database and its associated usernames.

Installing DRAFT1846

Perform these steps on your local PC

  • Download the zip file for the DRAFT1846 version that you wish to install.
  • Using FTP or SCP, move this zip file to your web server.

Perform these steps on your Linux web server

  • Create the MySQL database. See above.
  • Extract uploaded .zip file [see above] into your shell root directory.
  • Move the contents of the webroot sub directory of the extracted directory to your web root directory.
  • If necessary, create a utility directory in your shell root directory.
  • Move the contents of the utility sub directory of the extracted directory to this new utility directory.
  • Rename the webroot/php/configTemplate.php file to webroot/php/config.php.
  • Edit the webroot/php/config.php file.
    • Change DB_HOST only if your DB server is different from your web server.
    • Change DB_DATABASE to the name you gave to your DRAFT1846 database.
    • Change the database user ID and password to the "DRAFT1846 user" [see above].
    • Save the edited file.
  • Rename the webroot/php/configMailTemplate.php file to webroot/php/configMail.php.
  • Edit the webroot/php/configMail.php file.
    • Change MAIL_HOST to point to your SMTP server.
    • Change MAIL_USER to your mail user name on this SMTP server.
    • Change MAIL_PASS to your mail user password on this SMTP server.
    • Change MAIL_SENDER to the email address to which you wish replies to be sent.[1]
    • Change MAIL_TLS to 'Yes' if your SMTP server requires TLS. [2]
    • Save the edited file.
  1. The installer of DRAFT1846 should create an Email address such as admin@my.site.org
    and then use it to forward replies to an admin level player or to a group of admin level players.
  2. Note: Changing MAIL_TLS to 'Yes' may cause some older SMTP servers to reject your email.

Load the DRAFT1846 DataBase

  • Start a command line window on the server.
  • Enter on the command line:
cd ~/utility
mysql -u username -p -h hostname databasename < start1846db.txt
  • Note: The cd command above may have to be modified. The intent is to go to the utility directory.
  • The hostname, databasename, and (root) username should be modified to their appropriate values.
  • When prompted for a password, enter the appropriate password for the root user.

You should now have an empty DRAFT1846 database. All the tables are defined but they are all empty.

Upgrading DRAFT1846


This page is a stub.
The BOARD18 Project will soon be expanding it.