Roster:Install

From WoWRosterWiKi
(Difference between revisions)
Jump to: navigation, search
Line 8: Line 8:
 
[[Image:Roster_fi_phpmyadmin_1.png|thumb|phpMyAdmin Create Database]]
 
[[Image:Roster_fi_phpmyadmin_1.png|thumb|phpMyAdmin Create Database]]
 
[[Image:Roster_fi_phpmyadmin_2.png|thumb|phpMyAdmin Database Created]]
 
[[Image:Roster_fi_phpmyadmin_2.png|thumb|phpMyAdmin Database Created]]
[[Image:Roster_fi_install_0.png|thumb|WoWRoster Install Step 0]]
+
[[Image:Roster_install_0.png|thumb|WoWRoster Install Step 0]]
[[Image:Roster_fi_install_1.png|thumb|WoWRoster Install Step 1]]
+
[[Image:Roster_install_1.png|thumb|WoWRoster Install Step 1]]
[[Image:Roster_fi_install_1b.png|thumb|WoWRoster Install Step 1b]]
+
[[Image:Roster_install_2.png|thumb|WoWRoster Install Step 2]]
[[Image:Roster_fi_install_1c.png|thumb|WoWRoster Install Step 1c]]
+
[[Image:Roster_install_3.png|thumb|WoWRoster Install Step 3]]
[[Image:Roster_fi_install_1d.png|thumb|WoWRoster Install Step 1d]]
+
[[Image:Roster_install_4.png|thumb|WoWRoster Install Step 4]]
[[Image:Roster_fi_install_1e.png|thumb|WoWRoster Install Step 1e]]
+
[[Image:Roster_fi_install_2.png|thumb|WoWRoster Install Step 2]]
+
[[Image:Roster_fi_install_3.png|thumb|WoWRoster Install Step 3]]
+
[[Image:Roster_fi_install_4.png|thumb|WoWRoster Install Step 4]]
+
[[Image:Roster_fi_install_4b.png|thumb|WoWRoster Install Step 4b]]
+
  
 
===Installation Overview===
 
===Installation Overview===
Line 52: Line 47:
 
*: It's easiest to unzip the files on your desktop and figure out where they go after you've done that
 
*: It's easiest to unzip the files on your desktop and figure out where they go after you've done that
  
* Make sure you get all the image packs
+
* Make sure you get the Interface Image Pack
 
*: Every time Blizzard creates new icons for items, talents, spells, etc... a new image pack is released  
 
*: Every time Blizzard creates new icons for items, talents, spells, etc... a new image pack is released  
 
*: For full functionality, be sure to have all current image packs installed  
 
*: For full functionality, be sure to have all current image packs installed  
Line 69: Line 64:
  
 
====Pre-install====
 
====Pre-install====
(Figure 'phpMyAdmin Create Database')<br>
+
This step is optional
(Figure 'phpMyAdmin Database Created')<br>
+
 
 +
The installer can attempt to create the database, if you provide a user with sufficient privileges to do so.<br>
 +
This information will not be stored and only used in the creation of the database.
 +
 
 
Create, or have ready a MySQL database that WoWRoster can use.<br>
 
Create, or have ready a MySQL database that WoWRoster can use.<br>
It should already have a username and password assigned to it.
+
It should already have a user name and password assigned to it.<br>
 +
(See Figure 'phpMyAdmin Create Database')<br>
 +
(See Figure 'phpMyAdmin Database Created')<br>
 +
 
  
 
====Step 1====
 
====Step 1====
Making sure to keep the directory structure intact, move the unzipped files to a web-accessible directory.
+
Making sure to keep the directory structure intact, move the unzipped files to a web-accessible directory. (see [[#Hints|Hints]] section above)
 +
 
  
 
====Step 2====
 
====Step 2====
All files and directories should be owned by your webserver's user/group<br>
+
This step might not be necessary<br>
 +
This may only be needed if you are having problems running or installing Roster
 +
 
 +
All files and directories should be owned by your web server's user/group<br>
 
(Example: chown apache.apache -R *).<br>
 
(Example: chown apache.apache -R *).<br>
 
All .php files should be readable/executable
 
All .php files should be readable/executable
 
<pre>$ chmod a+rx -R *.php</pre>
 
<pre>$ chmod a+rx -R *.php</pre>
 +
  
 
====Step 3====
 
====Step 3====
If you want the installation script to automatically set up your conf.php file for you, it should be readable/writeable
+
If you want the installation script to automatically set up your conf.php file for you, it should be readable/writable
  
 
Note: The installer will attempt to do this for you, but should an error occur, you may need to do this manually:
 
Note: The installer will attempt to do this for you, but should an error occur, you may need to do this manually:
 
<pre>$ chmod 666 conf.php</pre>
 
<pre>$ chmod 666 conf.php</pre>
 +
  
 
====Step 4====
 
====Step 4====
Browse to www.[domain].com/roster/<br>
+
Browse to www.[domain].com/roster/
(Figure 'WoWRoster Install Step 1')
+
 
 +
You should be presented with a license agreement page.<br>
 +
(See Figure 'WoWRoster Install Step 0')
 +
 
 +
If you see the error message "You removed the license.txt file. This file MUST be present to install WoWRoster!"<br>
 +
Then you must restore the license.txt file<br>
 +
Part of the agreement to install and use WoWRoster is keeping this file intact.
 +
 
 +
Click the [ I Agree ] button.
  
 
You should be presented with a page describing your server's settings and information.<br>
 
You should be presented with a page describing your server's settings and information.<br>
Once you are sure that your server meets WoWRoster's requirements, you can click the [ Start Install ] button.
+
Once you are sure that your server meets WoWRoster's requirements, you can click the [ Start Install ] button.<br>
 +
(See Figure 'WoWRoster Install Step 1')
 +
 
 +
On this step, you may be presented with information or errors<br>
 +
The message will also contain a solution if it is an error
 +
* The '''conf.php''' file does not exist and could not be created in Roster's root folder.<br>You must create an empty conf.php file on your server before proceeding. And give it write access
 +
* The '''conf.php''' file has been created in Roster's root folder<br>Deleting this file will interfere with the operation of your Roster installation.
 +
* The file '''conf.php''' is not set to be readable/writable and could not be changed automatically.<br>Please change the permissions to 0666 manually by executing '''chmod 0666 conf.php''' on your server.
 +
* '''conf.php''' has been set to be readable/writable in order to let this installer write your configuration file automatically.
 +
* The cache directory could not be created, create a directory named "cache" manually in the root directory.
 +
* The cache directory exists, but is not set to be writable and could not be changed automatically.<br>Please change the permissions to 0777 manually by executing '''chmod 0777 cache''' on your server.
 +
* The cache directory has been set to be writable in order to let the Template engine to function.
 +
 
 +
Under "Directory Access" if you see a red image next to "Cache:"<br>
 +
Hover over the image for more information
 +
 
 +
If you see "Connection to wowroster.net failed." in the "Version" box<br>
 +
This means your server cannot contact wowroster.net for latest version checking during the install
 +
 
 +
If all is good in the universe, you will see this message<br>
 +
"Roster has scanned your server and determined that it meets the minimum requirements."
 +
 
 +
Click the [ Start Install ] button.
  
On this step, you may be presented with information
 
* 'WoWRoster Install Step 1b' - The conf.php file has been created successfully
 
* 'WoWRoster Install Step 1c' - conf.php could not be created and you should create it manually, or let the installer finish and it will give you a code to copy and paste
 
* 'WoWRoster Install Step 1d' - conf.php has been set writable so the installer can edit it
 
* 'WoWRoster Install Step 1e' - conf.php could not be set readable, so you should do so manually
 
  
 
=====Step 4-1=====
 
=====Step 4-1=====
 
(Figure 'WoWRoster Install Step 2')
 
(Figure 'WoWRoster Install Step 2')
 +
 +
* Default Locale:
 +
*: Choose the default locale setting for WoWRoster
 +
 +
* Database Type:
 +
*: Select your database engine here
  
 
* Database Host:
 
* Database Host:
 
*: Your MySQL server name.
 
*: Your MySQL server name.
 
*: If it resides on the same server as the web server, you should enter 'localhost'
 
*: If it resides on the same server as the web server, you should enter 'localhost'
*: Some hosts may not have the mysql server on the same server as the web server, so you should contact your host and get the correct server location
+
*: Some hosts may not have the MySQL server on the same server as the web server, so you should contact your host and get the correct server location
  
 
* Database Name:
 
* Database Name:
Line 114: Line 152:
  
 
* Database Username:
 
* Database Username:
*: The username with permission to access the database.
+
*: The user name with permission to access the database.
 
*: If you didn't create the database yourself, your host should have given you this information.
 
*: If you didn't create the database yourself, your host should have given you this information.
  
 
* Database Password:
 
* Database Password:
*: The password used with the username from above.
+
*: The password used with the user name from above.
  
* Database Prefix for Roster tables:
+
* Prefix for Roster tables:
 
*: Simply prefixes the name of each table that WoWRoster creates and uses.
 
*: Simply prefixes the name of each table that WoWRoster creates and uses.
 
*: The default of 'roster_' should be sufficient for most installations.
 
*: The default of 'roster_' should be sufficient for most installations.
  
* Main Site URL:
+
* Main Site URL Link:
 
*: Should be detected automatically by the installation script, but if not just put the domain name of your server here
 
*: Should be detected automatically by the installation script, but if not just put the domain name of your server here
 
*: ( ex: <nowiki>http://www.[domain].com</nowiki> )
 
*: ( ex: <nowiki>http://www.[domain].com</nowiki> )
 +
 +
'''Create Database Options'''
 +
If you would like the installer to create the database, you can enter the db user with permissions to create a database here<br>
 +
This information will NOT be saved
 +
 +
* Database Create username:
 +
*: User name with privileges to create new databases
 +
 +
* Database Create password:
 +
*: The password used with the user name from above.
 +
  
 
=====Step 4-2=====
 
=====Step 4-2=====
(Figure 'WoWRoster Install Step 3')
+
WoWRoster Administrator Account Setup
 +
 
 +
A message about MySQL will always appear, this is mainly informational unless your MySQL server version is not high enough to run WoWRoster
 +
 
 +
<pre>MySQL server version 4.1.0 or higher is required for Roster.
 +
 
 +
You are running:
 +
 
 +
    * Your server version: 5.0.45-Debian_1ubuntu3.3-log
 +
    * Your client version: 5.0.45
 +
 
 +
Your server meets the MySQL requirements for Roster.
 +
 
 +
Your configuration file has been written with the initial values
 +
But installation will not be complete until you create an administrator account in this step</pre>
 +
 
 +
(See Figure 'WoWRoster Install Step 3')
  
 
* Administrator Password:
 
* Administrator Password:
Line 135: Line 200:
 
* Administrator Password [ confirm ]:
 
* Administrator Password [ confirm ]:
 
*: Simply re-type the password to verify it.
 
*: Simply re-type the password to verify it.
* Note that the guild/user and officer/upload passwors will be set to this as well
+
* Note that the guild/user and officer/upload passwords will be set to this as well
 
*: You can change them later via RosterCP
 
*: You can change them later via RosterCP
 +
 +
After you're satisfied with the values for the above fields, click the [ Proceed] button to continue.
 +
  
 
====Step 5====
 
====Step 5====
After you're satisfied with the values for the above fields, click the button to proceed.<br>
 
 
The installer will automatically fill your conf.php file.<br>
 
The installer will automatically fill your conf.php file.<br>
(Figure 'WoWRoster Install Step 4')
+
(See Figure 'WoWRoster Install Step 4')
  
 
If the creation of conf.php failed, the installer will give you code to copy and paste in this file.
 
If the creation of conf.php failed, the installer will give you code to copy and paste in this file.
  
You will be notified if your passwords didn't match (Figure 'WoWRoster Install Step 4b'), and it will be reset to a default of "admin"<br>
+
You will be notified if your passwords didn't match, and it will be reset to a default of "admin"<br>
 
You can change this later by going to Roster Config.
 
You can change this later by going to Roster Config.
  
 
This will also be the password for the Officer/Upload and Guild/User logins, change them via RosterCP
 
This will also be the password for the Officer/Upload and Guild/User logins, change them via RosterCP
  
Navigate to [[Roster:CP|Roster Control Panel]], this is where you can [[Roster:CP|configure]] all aspects of WoWRoster.<br>
+
Enter your WoWRoster Admin password to navigate to the [[Roster:InstallGuide|After Install Guide]]<br>
After that, you're ready to begin using WoWRoster.
+
The After Install Guide helps you configure WoWRoster for first time use<br>
 +
you can skip this step by clicking "Skip install guide ->"
  
 
You should now have a functional installation of WoWRoster.<br>
 
You should now have a functional installation of WoWRoster.<br>
 
Remove the files install.php, upgrade.php and the install/ folder for extra security.
 
Remove the files install.php, upgrade.php and the install/ folder for extra security.
  
 +
Navigate to [[Roster:CP|Roster Control Panel]]<br>
 +
This is where you can [[Roster:CP|configure]] all aspects of WoWRoster.
  
  
Line 161: Line 231:
 
As always, we recommend a fresh install, in a clean folder, and a clean database.<br>
 
As always, we recommend a fresh install, in a clean folder, and a clean database.<br>
 
But for those that absolutely need to upgrade, we have worked really hard for you on the upgrade script.
 
But for those that absolutely need to upgrade, we have worked really hard for you on the upgrade script.
 +
  
 
====Special Instructions for < 2.0.0 to 2.0.x====
 
====Special Instructions for < 2.0.0 to 2.0.x====
Line 182: Line 253:
 
Make sure you visit the Roster Config page<br>
 
Make sure you visit the Roster Config page<br>
 
You will need to visit this page as the upgrader only upgrade certain important fields from version 1.6.0
 
You will need to visit this page as the upgrader only upgrade certain important fields from version 1.6.0
 +
  
 
====General Instructions====
 
====General Instructions====
Line 194: Line 266:
 
You should consider using phpMyAdmin (http://www.phpmyadmin.net)<br>
 
You should consider using phpMyAdmin (http://www.phpmyadmin.net)<br>
 
This can use 'Completed Inserts' that will be necessary if you need to restore the database.
 
This can use 'Completed Inserts' that will be necessary if you need to restore the database.
 +
  
 
=====Step 2=====
 
=====Step 2=====
 
Seriously, go back up your database since you skipped step 1.
 
Seriously, go back up your database since you skipped step 1.
 +
  
 
=====Step 3=====
 
=====Step 3=====
 
Back up your conf.php file.<br>
 
Back up your conf.php file.<br>
 
Usually we would never touch this file during an upgrade...but just in case something weird happens
 
Usually we would never touch this file during an upgrade...but just in case something weird happens
 +
  
 
=====Step 4=====
 
=====Step 4=====
Line 206: Line 281:
 
Overwrite ALL files!<br>
 
Overwrite ALL files!<br>
 
It's best to delete everything in the roster folder ''EXCEPT!'' your conf.php file first, before copying over files.
 
It's best to delete everything in the roster folder ''EXCEPT!'' your conf.php file first, before copying over files.
 +
  
 
=====Step 5=====
 
=====Step 5=====
Line 212: Line 288:
 
Select the version you're upgrading from.<br>
 
Select the version you're upgrading from.<br>
 
The script will perform all the necessary changes to upgrade from the version you selected to the newest version.
 
The script will perform all the necessary changes to upgrade from the version you selected to the newest version.
 +
  
 
=====Step 6=====
 
=====Step 6=====
Line 225: Line 302:
  
 
You can try re-installing Roster
 
You can try re-installing Roster
 +
  
 
====Pre re-install====
 
====Pre re-install====
 
Make sure you have the install directory and install.php in your roster folder on your web server
 
Make sure you have the install directory and install.php in your roster folder on your web server
 +
  
 
====Step 1====
 
====Step 1====
 
Delete conf.php from the roster directory
 
Delete conf.php from the roster directory
 +
  
 
====Step 2====
 
====Step 2====
Line 238: Line 318:
 
You can also just drop the database you created for Roster<br>
 
You can also just drop the database you created for Roster<br>
 
If you didn't create a new database for Roster, use the first method for removing the tables
 
If you didn't create a new database for Roster, use the first method for removing the tables
 +
  
 
====Step 3====
 
====Step 3====
Line 247: Line 328:
 
First of all, we'd like to thank you for trying our software and hope it was a good experience for you<br>
 
First of all, we'd like to thank you for trying our software and hope it was a good experience for you<br>
 
Sometimes Roster doesn't work on all servers although we try our best to improve this aspect
 
Sometimes Roster doesn't work on all servers although we try our best to improve this aspect
 +
  
 
====Step 1====
 
====Step 1====
 
Remove/delete the roster directory from your webserver
 
Remove/delete the roster directory from your webserver
 +
  
 
====Step 2====
 
====Step 2====

Revision as of 22:59, 15 June 2008

WR.net

Important note: When you edit this page, you agree to release your contribution into the public domain.
If you do not want this or can not do this because of license restrictions, please do not edit.

Contents


Roster Installation

Installation guide

phpMyAdmin Create Database
phpMyAdmin Database Created
WoWRoster Install Step 0
WoWRoster Install Step 1
WoWRoster Install Step 2
WoWRoster Install Step 3
WoWRoster Install Step 4

Installation Overview


Hints


Installing Roster

Pre-install

This step is optional

The installer can attempt to create the database, if you provide a user with sufficient privileges to do so.
This information will not be stored and only used in the creation of the database.

Create, or have ready a MySQL database that WoWRoster can use.
It should already have a user name and password assigned to it.
(See Figure 'phpMyAdmin Create Database')
(See Figure 'phpMyAdmin Database Created')


Step 1

Making sure to keep the directory structure intact, move the unzipped files to a web-accessible directory. (see Hints section above)


Step 2

This step might not be necessary
This may only be needed if you are having problems running or installing Roster

All files and directories should be owned by your web server's user/group
(Example: chown apache.apache -R *).
All .php files should be readable/executable

$ chmod a+rx -R *.php


Step 3

If you want the installation script to automatically set up your conf.php file for you, it should be readable/writable

Note: The installer will attempt to do this for you, but should an error occur, you may need to do this manually:

$ chmod 666 conf.php


Step 4

Browse to www.[domain].com/roster/

You should be presented with a license agreement page.
(See Figure 'WoWRoster Install Step 0')

If you see the error message "You removed the license.txt file. This file MUST be present to install WoWRoster!"
Then you must restore the license.txt file
Part of the agreement to install and use WoWRoster is keeping this file intact.

Click the [ I Agree ] button.

You should be presented with a page describing your server's settings and information.
Once you are sure that your server meets WoWRoster's requirements, you can click the [ Start Install ] button.
(See Figure 'WoWRoster Install Step 1')

On this step, you may be presented with information or errors
The message will also contain a solution if it is an error

Under "Directory Access" if you see a red image next to "Cache:"
Hover over the image for more information

If you see "Connection to wowroster.net failed." in the "Version" box
This means your server cannot contact wowroster.net for latest version checking during the install

If all is good in the universe, you will see this message
"Roster has scanned your server and determined that it meets the minimum requirements."

Click the [ Start Install ] button.


Step 4-1

(Figure 'WoWRoster Install Step 2')

Create Database Options If you would like the installer to create the database, you can enter the db user with permissions to create a database here
This information will NOT be saved


Step 4-2

WoWRoster Administrator Account Setup

A message about MySQL will always appear, this is mainly informational unless your MySQL server version is not high enough to run WoWRoster

MySQL server version 4.1.0 or higher is required for Roster.

You are running:

    * Your server version: 5.0.45-Debian_1ubuntu3.3-log
    * Your client version: 5.0.45

Your server meets the MySQL requirements for Roster.

Your configuration file has been written with the initial values
But installation will not be complete until you create an administrator account in this step

(See Figure 'WoWRoster Install Step 3')

After you're satisfied with the values for the above fields, click the [ Proceed] button to continue.


Step 5

The installer will automatically fill your conf.php file.
(See Figure 'WoWRoster Install Step 4')

If the creation of conf.php failed, the installer will give you code to copy and paste in this file.

You will be notified if your passwords didn't match, and it will be reset to a default of "admin"
You can change this later by going to Roster Config.

This will also be the password for the Officer/Upload and Guild/User logins, change them via RosterCP

Enter your WoWRoster Admin password to navigate to the After Install Guide
The After Install Guide helps you configure WoWRoster for first time use
you can skip this step by clicking "Skip install guide ->"

You should now have a functional installation of WoWRoster.
Remove the files install.php, upgrade.php and the install/ folder for extra security.

Navigate to Roster Control Panel
This is where you can configure all aspects of WoWRoster.


Upgrading Roster

As always, we recommend a fresh install, in a clean folder, and a clean database.
But for those that absolutely need to upgrade, we have worked really hard for you on the upgrade script.


Special Instructions for < 2.0.0 to 2.0.x

There is no upgrade path from versions lower than 2.0.0

This is because Roster 2.0.0 gathers much more data from WoW than earlier versions and causes errors in the core files.


Special Instructions for 1.6.0 to 1.7.x

This information is specific on upgrading from Roster 1.6.0 to 1.7.x

Back up your conf.php file!
WoWRoster 1.7.x DOES have a new conf.php file, so you should back it up!
The new conf.php file should be automatically be upgraded for you.
If this fails, the upgrader will give you the option to download this file, then you can upload it to your web server.

Access www.[domain].com/roster/upgrade.php
YOU MUST go to www.[domain].com/roster/upgrade.php
If you go to any other page, it WILL display "Detected Invalid Access..."

Make sure you visit the Roster Config page
You will need to visit this page as the upgrader only upgrade certain important fields from version 1.6.0


General Instructions

Step 1

BACK UP YOUR DATABASE.


This cannot be stressed enough.


You should consider using phpMyAdmin (http://www.phpmyadmin.net)
This can use 'Completed Inserts' that will be necessary if you need to restore the database.


Step 2

Seriously, go back up your database since you skipped step 1.


Step 3

Back up your conf.php file.
Usually we would never touch this file during an upgrade...but just in case something weird happens


Step 4

Unzip the new WoWRoster version.
Overwrite ALL files!
It's best to delete everything in the roster folder EXCEPT! your conf.php file first, before copying over files.


Step 5

Access www.[domain].com/roster

Select the version you're upgrading from.
The script will perform all the necessary changes to upgrade from the version you selected to the newest version.


Step 6

Navigate to RosterCP, this is where you can configure all aspects of WoWRoster.

Remove the file install.php for extra security.


Re-Installing Roster

Perhaps there has been some weird problem that you cannot solve
Such as database corruption, updating errors, data errors, etc...

You can try re-installing Roster


Pre re-install

Make sure you have the install directory and install.php in your roster folder on your web server


Step 1

Delete conf.php from the roster directory


Step 2

Drop all `roster_` tables in the database you created for Roster
Note: `roster_` may be different if you changed the table prefix

You can also just drop the database you created for Roster
If you didn't create a new database for Roster, use the first method for removing the tables


Step 3

Run install.php


Un-Installing Roster

First of all, we'd like to thank you for trying our software and hope it was a good experience for you
Sometimes Roster doesn't work on all servers although we try our best to improve this aspect


Step 1

Remove/delete the roster directory from your webserver


Step 2

Drop all `roster_` tables in the database you created for Roster
Note: `roster_` may be different if you changed the table prefix

You can also just drop the database you created for Roster
If you didn't create a new database for Roster, use the first method for removing the tables

Personal tools
Namespaces
Variants
Actions
WoWRoster
Preview Roster
Navigation
Toolbox