Difference between revisions of "New Users: Quick Install Guide"

Minor grammar changes, and some rewriting for clarity
(Minor grammar changes, and some rewriting for clarity)
 
Line 17: Line 17:
'''Just three steps to get Uniserver up and running'''
'''Just three steps to get Uniserver up and running'''
|}
|}
Uniform Server is a collection of self contained files you extract to '''any folder''' of your choice. In operation it does not use the registry hence you can pop these files onto a USB memory stick and it becomes completely portable.  
Uniform Server is a collection of self-contained files you extract to '''any folder''' of your choice. In operation it does not use the registry, so you can pop these files onto a USB memory stick and it becomes completely portable.  


It appears to run from a separate drive because it uses the powerful [[New Users: Information Snippets#subst | subst command]] this associates a path (where you copied the files to) with a drive letter. These files are run from that location however are accessed via the drive letter assigned. This all adds up to easy installation and operation, follow this quick guide for installation.
It appears to run from a separate drive because it uses the powerful [[New Users: Information Snippets#subst | subst command]], which associates a path (where you copied the files to) with a drive letter. These files are run from that location but are accessed via the drive letter assigned. This all adds up to easy installation and operation. Follow this quick guide for installation.


== Download ==
== Download ==
Line 25: Line 25:
Download the software package UniServer3_5.exe (if you prefer UniServer3_5.zip) from [http://sourceforge.net/project/showfiles.php?group_id=53691&package_id=48193&release_id=521154 SourceForge] for latest release check the Uniform Server [http://www.uniformserver.com/ web site].
Download the software package UniServer3_5.exe (if you prefer UniServer3_5.zip) from [http://sourceforge.net/project/showfiles.php?group_id=53691&package_id=48193&release_id=521154 SourceForge] for latest release check the Uniform Server [http://www.uniformserver.com/ web site].


Note: The exe file (7MB ) is about half the size of the ZIP file (13.6MB). Extracted size is around 37.6MB, file sizes may vary  
Note: The exe file (7MB ) is about half the size of the ZIP file (13.6MB). Extracted size is around 37.6MB, but file sizes may vary slightly from the figures I have shown.
slightly to the figures I have shown.


== Installation - Step 1 ==
== Installation - Step 1 ==


Installation is a bit of a misnomer; all that is required is to extract the files. First download the above exe file, double click on it; select a folder where you would like the extracted folders and files to be placed. That’s it installation done.
Installation is a bit of a misnomer; all that is required is to extract the files. First download the above exe file, double click on it; select a folder where you would like the extracted folders and files to be placed. That’s all.


Here is an example with a little more detail. Note at step two you can use the default folder, once extracted you will see a folder named '''Uniform Server''' this can be '''moved''' with all its sub-folders (to another folder or copy it to your USB memory stick) it can be '''renamed''' to whatever you like. I have extracted my files to drive G into a folder named A1_web_server (I tend to loose folders hence when viewed in explorer A1 pushes it to the top of the folders list).
Here is an example with a little more detail. Note at step two you can use the default folder. Once extracted you will see a folder named '''Uniform Server'''. This can be '''moved''' with all its sub-folders (to another folder or copied to your USB memory stick), and it can be '''renamed''' to whatever you like. I have extracted my files to drive G into a folder named A1_web_server (I tend to lose folders, so when they're viewed in explorer, A1 pushes it to the top of the folders list).


<table>
<table>
Line 42: Line 41:
# '''Double click''' on the file downloaded ('''UniServer3_5.exe'''''Italic text'')
# '''Double click''' on the file downloaded ('''UniServer3_5.exe'''''Italic text'')
# Select a drive and folder to extract to. For example ('''G:\A1_web_server'''''Italic text'')
# Select a drive and folder to extract to. For example ('''G:\A1_web_server'''''Italic text'')
# Click on '''Extract''' and the extraction process starts (7Z is a fast utility. It is faster than the Windows utilities yet another reason why I prefer the exe file.)
# Click on '''Extract''' and the extraction process starts (7Z is a fast utility. It is faster than the Windows utilities. Yet another reason why I prefer the .exe file.)
# When complete the un-zip window closes
# When complete, the un-zip window closes
</td>
</td>
</tr>
</tr>
Line 56: Line 55:
== Running Uniform Server - Step 2 ==
== Running Uniform Server - Step 2 ==


Use Windows Explorer or MyComputer to locate the folder '''Uniform Server''' (if you renamed it use that new name) here you will find four files '''Server_Start.bat''', '''Disk Start.vbs''', UniController.exe and '''Stop.bat''' these start and stop the servers as follows:
Use Windows Explorer or My Computer to locate the folder '''Uniform Server''' (if you renamed it, use that new name). Here you will find four files '''Server_Start.bat''', '''Disk Start.vbs''', UniController.exe and '''Stop.bat'''. These start and stop the servers as follows:


Note: You only need to use '''Server_Start.bat''' and '''Stop.bat''' to control your servers I have included the other methods for completeness.
Note: You only need to use '''Server_Start.bat''' and '''Stop.bat''' to control your servers. I have included the other methods for completeness.
----
----


=== Alarm Bells ===
=== Alarm Bells ===
Starting the servers for the first time all hell breaks loose regarding fire walls and security programs. When challenged by these programs '''allow all scripts to run''' and '''allow access on all ports'''. Depending on what software or protection you have expect to be challenged several times. However when the servers are re-run everything will be fine.
Starting the servers for the first time all hell breaks loose regarding fire walls and security programs. When challenged by these programs '''allow all scripts to run''' and '''allow access on all ports'''. Depending on what software or protection you have, expect to be challenged several times. However when the servers are re-run, everything will be fine.


The following are a few examples of what to expect:
The following are a few examples of what to expect:
Line 99: Line 98:
</tr>
</tr>
</table>
</table>
Your browser may display an error message '''“something like server or page not found”''' this is perfectly normal. It occurs because the browser is active before the servers start running. Once you have trained your firewall or other security measures to allow Apache and MySQL access next time you start these servers the error message will not occur. However do not be surprised if you occasionally get this error message it depends on what processes (programs) are running at the time and what delays occur.
Your browser may display an error message, something like '''“server or page not found”'''. This is perfectly normal and occurs because the browser is active before the servers start running. Once you have trained your firewall or other security measures to allow Apache and MySQL access, the next time you start these servers the error message will not occur. However do not be surprised if you occasionally get this error message. It depends on what processes (programs) are running at the time and what delays occur.


'''''[[#top | Top]]'''''
'''''[[#top | Top]]'''''
Line 107: Line 106:
<tr>
<tr>
<td>
<td>
# To start the Apache and MySQL servers double click on '''Server_Start.bat'''
# To start the Apache and MySQL servers, double click on '''Server_Start.bat'''
</td>
</td>
<td width="164">
<td width="164">
Line 115: Line 114:
</table>
</table>


'''Note 1:''' Depending on your PC’s speed you may see two command windows (black windows) displayed for a short time. These indicate your servers (Apache and MySQL) are starting. If the windows remain the chances are this is the first time you have run your servers please wait until you are challenged by your firewall.
'''Note 1:''' Depending on your PC’s speed you may see two command windows (black windows) displayed for a short time. These indicate your servers (Apache and MySQL) are starting. If the windows remain open, the chances are this is the first time you have run your servers. Please wait until you are challenged by your firewall.


When challenged make sure you '''allow connection''' on all ports otherwise the servers will be blocked by these security programs.
When challenged make sure you '''allow connection''' on all ports, or otherwise the servers will be blocked by these security programs.


While all this is going on your browser if not already running will start and be redirected to UniServer’s control page ('''apanel'''). You may receive a message '''Unable to connect''' this is because your browser has redirected to apanel before your Apache server has had time to start-up, its not a major problem just refresh your browser and all will be fine.
While all this is going on your browser, if not already running, will start and be redirected to UniServer’s control page ('''apanel'''). You may receive a message '''Unable to connect'''. This is because your browser has redirected to apanel before your Apache server has had time to start-up. It's not a problem; just refresh your browser and all will be fine.


'''Note 2:''' The drive letter defaults to drive '''W'''
'''Note 2:''' The drive letter defaults to drive '''W'''


'''Note 3:''' The server defaults to localhost ('''<nowiki>http://localhost/</nowiki>''') Type this into your browser address bar and the default index '''test page''' (Blue background with Uniform server log image centrally displayed).
'''Note 3:''' The server defaults to localhost ('''<nowiki>http://localhost/</nowiki>''') Type this into your browser address bar and you will see the default index '''test page''' (Violet background with Uniform server log image centrally displayed).


To display your web site copy it into folder '''www''' and again enter''' <nowiki>http://localhost/</nowiki>''' or just refresh the page (Note make sure your site has an index page for example index.html, index.htm or index.php). If your index page is named index.php either delete the default index.php page in folder www or allow overwrite when copying your site.
To display your web site copy it into folder '''www''' and again enter''' <nowiki>http://localhost/</nowiki>''' or just refresh the page (Note make sure your site has an index page for example index.html, index.htm or index.php). If your index page is named index.php either delete the default index.php page in folder www or allow overwrite when copying your site.
Line 164: Line 163:
----
----
=== UniController Beta ===
=== UniController Beta ===
This program allows you to start and stop both servers with the functionality of a standard program (you can minimise and maximise it, places an icon in the toolbar). If you accidentally closed the program just restart it for closing the servers or use stop bat. Be warned that it is a beta version although fully functional it is not pretty looking also I found on my PC is takes a good thirty seconds to start the servers.
This program allows you to start and stop both servers with the functionality of a standard program (you can minimise and maximise it, places an icon in the toolbar). If you accidentally close the program, just restart it to close the servers, or use stop.bat. Be warned that it is a beta version. Although fully functional, it is not pretty looking. Also I found on my PC it takes a good thirty seconds to start the servers.


<table width="60%">
<table width="60%">
Line 178: Line 177:
</tr>
</tr>
</table>
</table>
'''Note 1:''' You can minimise the program which places an icon in the tool bar. Click the Icon to maximise and use the stop button to stop both the Apache and MySQL servers.
'''Note 1:''' You can minimise the program, which places an icon in the tool bar. Click the Icon to maximise and use the stop button to stop both the Apache and MySQL servers.


'''Note 2:''' When run looses focus, (seems to be set to a low order) hence when the browser runs it is placed on top hiding UniController not a major problem click on UniController in the task bar to bring it to the front.
'''Note 2:''' When run, it loses focus (seems to be set to a low order), so when the browser runs it is placed on top, hiding UniController. Not a major problem; click on UniController in the task bar to bring it to the front.


'''Note 3:''' The Drive Letter [A or C-Z] at start-up does not actually display free drives it is merely an indication of potential candidates to use. Hence make sure the drive letter you chose is not in use.
'''Note 3:''' The Drive Letter [A or C-Z] at start-up does not actually display free drives. It is merely an indication of potential candidates to use. Hence make sure the drive letter you chose is not in use.


----
----
=== Quick Check ===
=== Quick Check ===
Whichever method you choose to start the servers your browser will be redirected to UniServer's Admin Panel page allowing you to configure and display server information, I cover this later. To return to apanel at any time type the following '''<nowiki>http://localhost/apanel/</nowiki>''' into your browser address bar.
Whichever method you choose to start the servers your browser will be redirected to UniServer's Admin Panel page allowing you to configure and display server information. I cover this later. To return to apanel at any time, type the following '''<nowiki>http://localhost/apanel/</nowiki>''' into your browser address bar.


General note: When you change Apache port for example to 8080 starting the servers automatically redirects to apanel. To run apanel manually you must include the port number for example type the following '''<nowiki>http://localhost:8080/apanel/</nowiki>''' into your browser address bar.
General note: When you change the Apache port, for example to 8080, starting the servers automatically redirects to apanel. To run apanel manually you must include the port number. For example type the following '''<nowiki>http://localhost:8080/apanel/</nowiki>''' into your browser address bar.


Confirm pages are being severed from folder '''www'''. Type '''<nowiki>http://localhost</nowiki>''' into your browser address bar, a Uniserver logo displayed in the center of the screen confirms correct operation. After a short time redirects back to apanel.
Confirm pages are being served from folder '''www'''. Type '''<nowiki>http://localhost</nowiki>''' into your browser address bar, and a Uniserver logo displayed in the center of the screen confirms correct operation. After a short time it redirects back to apanel.


One final test, copy your own web site (folders and pages) to folder www your index page (index.html or index.htm) will be picked up first and override the default index.php refresh your browser alternatively type '''<nowiki>http://localhost/index.html</nowiki>''' or '''<nowiki>http://localhost/index.html</nowiki>''' into your browser address bar and confirm your pages are displayed.
One final test: copy your own web site (folders and pages) to folder www. Your index page (index.html or index.htm) will be picked up first and override the default index.php. Refresh your browser or alternatively type '''<nowiki>http://localhost/index.html</nowiki>''' or '''<nowiki>http://localhost/index.htm</nowiki>''' into your browser address bar and confirm your pages are displayed.


'''''[[#top | Top]]'''''
'''''[[#top | Top]]'''''