DRAFT1846 Implementation Guide - Revision history

Rich: /* Where To Get DRAFT1846 */

2020-06-26T13:07:11Z

Where To Get DRAFT1846

← Older revision		Revision as of 13:07, 26 June 2020
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>

Rich: /* The DRAFT1846 Database */

2020-06-08T12:22:24Z

The DRAFT1846 Database

← Older revision		Revision as of 12:22, 8 June 2020
Line 30:		Line 30:
	GRANT SELECT, INSERT, UPDATE ON draft1846.* TO 'draft1846'@'localhost';		GRANT SELECT, INSERT, UPDATE ON draft1846.* TO 'draft1846'@'localhost';
	</pre>		</pre>
	<span style="color: Green">Many web hosting providers [such as ~~dreamhost]~~ provide web pages that have all the capabilities needed to create a database and its associated usernames.</span>		<span style="color: Green">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.</span>

	== Installing DRAFT1846 ==		== Installing DRAFT1846 ==

Rich: /* Where To Get DRAFT1846 */

2020-06-08T12:18:01Z

Where To Get DRAFT1846

← Older revision		Revision as of 12:18, 8 June 2020
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>]'''		'''[https://drive.google.com/drive/folders/1jlMXIadtm1RWK46qMSkP0_iA5PJtnbfn <span style="color: Green">in this folder</span>]'''<br>
			<span style="color: Fuchsia">Please always use the latest version.</span>

	== The DRAFT1846 Database ==		== The DRAFT1846 Database ==

Rich: /* Configuring DRAFT1846 */ deleted

2020-05-31T22:15:38Z

Configuring DRAFT1846: deleted

← Older revision		Revision as of 22:15, 31 May 2020
Line 70:		Line 70:

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

	~~== Configuring DRAFT1846 ==~~

	== Upgrading DRAFT1846 ==		== Upgrading DRAFT1846 ==

	{{Stub}}		{{Stub}}

Rich: /* Installing DRAFT1846 */ initial contents

2020-05-31T22:14:27Z

Installing DRAFT1846: initial contents

← Older revision		Revision as of 22:14, 31 May 2020
Line 32:		Line 32:

	== Installing DRAFT1846 ==		== 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.<ref>The installer of DRAFT1846 should create an Email address such as '''admin@my.site.org''' <br>and then use it to forward replies to an admin level player or to a group of admin level players.</ref>
			** Change MAIL_TLS to 'Yes' if your SMTP server requires TLS. <ref>Note: Changing MAIL_TLS to 'Yes' may cause some older SMTP servers to reject your email.</ref>
			** Save the edited file.

			<references/>

			===Load the DRAFT1846 DataBase===
			* Start a command line window on the server.
			* Enter on the command line:
			<pre>cd ~/utility
			mysql -u username -p -h hostname databasename < start1846db.txt
			</pre>
			* 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.

	== Configuring DRAFT1846 ==		== Configuring DRAFT1846 ==

Rich: /* The DRAFT1846 Database */ initial contents

2020-05-31T21:50:14Z

The DRAFT1846 Database: initial contents

← Older revision		Revision as of 21:50, 31 May 2020
Line 18:		Line 18:

	== The DRAFT1846 Database ==		== The DRAFT1846 Database ==
			Before starting this task, you will have to create a new (empty) MYSQL database on your DB server. <br>
			'''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. <br>
			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. <br>
			The draft1846 web application will use this second username. It is called "draft1846" in the supplied php/config.php file. <br>
			The following commands can be used to create this username '''if the database resides on the web server''':
			<pre>
			CREATE USER 'draft1846'@'localhost' IDENTIFIED BY 'draft1846';
			GRANT SELECT, INSERT, UPDATE ON draft1846.* TO 'draft1846'@'localhost';
			</pre>
			<span style="color: Green">Many web hosting providers [such as dreamhost] provide web pages that have all the capabilities needed to create a database and its associated usernames.</span>

	== Installing DRAFT1846 ==		== Installing DRAFT1846 ==

Rich at 21:36, 31 May 2020

2020-05-31T21:36:18Z

← Older revision		Revision as of 21:36, 31 May 2020
Line 11:		Line 11:
	the '''web root directory''' regardless of whether it is really a root or not.		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 ~~how to~~. So it will be assumed that this work has been done.'''		'''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 ==		== Where To Get DRAFT1846 ==

Rich: added text

2020-05-31T21:35:45Z

added text

← Older revision		Revision as of 21:35, 31 May 2020
Line 2:		Line 2:
	It is the result of a separate project and only applies to one game, 1846.<br>		It is the result of a separate project and only applies to one game, 1846.<br>
	This guide is directed at someone who wishes to install a copy on their own site.		This guide is directed at someone who wishes to install a copy on their own site.
			__NOTOC__
			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. <br>
			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. <br>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 how to. So it will be assumed that this work has been done.'''

	== Where To Get DRAFT1846 ==		== Where To Get DRAFT1846 ==

Rich: /* Where To Get DRAFT1846 */

2020-05-31T21:27:57Z

Where To Get DRAFT1846

← Older revision		Revision as of 21:27, 31 May 2020
Line 4:		Line 4:

	== Where To Get DRAFT1846 ==		== Where To Get DRAFT1846 ==
			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>]'''

	== The DRAFT1846 Database ==		== The DRAFT1846 Database ==

Rich at 18:18, 31 May 2020

2020-05-31T18:18:02Z

← Older revision		Revision as of 18:18, 31 May 2020
Line 3:		Line 3:
	This guide is directed at someone who wishes to install a copy on their own site.		This guide is directed at someone who wishes to install a copy on their own site.

	== Where ~~to get~~ DRAFT1846 ==		== Where To Get DRAFT1846 ==

	== The Database ==		== The DRAFT1846 Database ==

	== Installing ~~the Software~~ ==		== Installing DRAFT1846 ==

	== Configuring DRAFT1846 ==		== Configuring DRAFT1846 ==

			== Upgrading DRAFT1846 ==

	{{Stub}}		{{Stub}}