https://ark.lparchaeology.com/wiki/api.php?action=feedcontributions&user=Guy&feedformat=atomARK - User contributions [en]2024-03-28T19:54:35ZUser contributionsMediaWiki 1.27.1https://ark.lparchaeology.com/wiki/index.php?title=The_ARK_Help_System&diff=3287The ARK Help System2014-07-04T17:04:09Z<p>Guy: /* Item level */</p>
<hr />
<div>As of version 1.2 - a contextual help system has been introduced to ARK.<br />
<br />
The help system works by using the [[Markup]] system to display help relevant to the context. There are 4 contexts in which help might be displayed, these are:<br />
<br />
* Page Level - ie to help users understand how a page works<br />
* Record level - to help users understand the specifics of a record (context, plan, photo etc.)<br />
* Subform Level - to provide inline help for specific subforms<br />
* Field Level - to provide help relating to a specific field<br />
<br />
The help is displayed using a subform (sf_help.php) which can be either placed "inline" in the page or within an overlay. By default the help buttons fire an overlay, javascript is required to show or hide the inline help panels<br />
<br />
By default, help is OFF. You enable help at all 4 help levels as follows.<br />
<br />
==Page Level==<br />
<br />
In the page settings (NOT IMPLEMENTED)<br />
<br />
==Item level==<br />
<br />
Turn on op_help in the config array for the record nav: that would be $conf_entry_nav for the data entry pages. This will enable the help button in the record nav and set up the help to work properly.<br />
<br />
This will then try to find markup with a nickname for that page view and that type of item:<br />
<br />
* detfrm_cxt<br />
* regist_cxt<br />
* etc.<br />
<br />
This then includes the relevant markup.<br />
<br />
==Subform Level==<br />
<br />
Default behaviour in subforms is to list the help for each field in the subform. To overide this and just use a single arbitrary piece of markup, use:<br />
<br />
* op_help_nname => 'markupnickname',<br />
<br />
Place this on the sf_conf and specifiy the nickname of the markup you wish to use.<br />
<br />
To turn the help button on and off in the sfNav set the sf_nav_type to one of the options that include help.<br />
<br />
==Field Level==<br />
<br />
In the field settings (NOT IMPLEMENTED)<br />
<br />
==For all levels==<br />
<br />
A new subform conf will need to be entered in the page_settings.php file:<br />
<br />
<pre><br />
<br />
$conf_mcd_help =<br />
array(<br />
'view_state' => 'max',<br />
'edit_state' => 'view',<br />
'sf_nav_type' => 'nmedit',<br />
'sf_title' => 'help', <br />
'sf_html_id' => 'help', // Must be unique<br />
'script' => 'php/subforms/sf_help.php',<br />
'op_modtype' => FALSE, //if each modtype uses same fields (see below)<br />
'fields' =><br />
array(<br />
)<br />
);<br />
<br />
</pre><br />
<br />
This needs to be named $conf_mcd_help, otherwise the help system will not be able to find it. The subform has one 'op' value that can be applied:<br />
<br />
'op_textile' => TRUE<br />
<br />
If this op is specified, then the help will be printed using the Textile tool - which means it can be used to print complex formatted HTML (along with images, etc.). For more information on Textile see this link: http://txstyle.org/<br />
<br />
<br />
==Other things to bear in mind==<br />
<br />
The help uses the Markup system to attach the help to the fields. Therefore, the contents of the help at the subform level can either be edited directly from the help subform - or using the Markup Admin tools. By default the system assumes the nickname of the markup is 'help_' concatenated onto whatever the field_id is. For instance, the help for a field with id 'conf_field_description' would be 'help_conf_field_description'. It is possible to specify a different nickname, by including the option 'op_help_nname' in the field and setting a new nickname.<br />
<br />
As the names for the nicknames of the markup are usually help_ prefixed on the name of the field - the length of the nname field in cor_tbl_markup maybe too short. If you get an Error when updating or adding help related to the size of the field in the database then run this SQL command to fix it:<br />
<pre><br />
ALTER TABLE `cor_tbl_markup` CHANGE `nname` `nname` VARCHAR( 255 ) CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL DEFAULT<br />
</pre></div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=The_ARK_Help_System&diff=3286The ARK Help System2014-07-04T16:56:38Z<p>Guy: </p>
<hr />
<div>As of version 1.2 - a contextual help system has been introduced to ARK.<br />
<br />
The help system works by using the [[Markup]] system to display help relevant to the context. There are 4 contexts in which help might be displayed, these are:<br />
<br />
* Page Level - ie to help users understand how a page works<br />
* Record level - to help users understand the specifics of a record (context, plan, photo etc.)<br />
* Subform Level - to provide inline help for specific subforms<br />
* Field Level - to provide help relating to a specific field<br />
<br />
The help is displayed using a subform (sf_help.php) which can be either placed "inline" in the page or within an overlay. By default the help buttons fire an overlay, javascript is required to show or hide the inline help panels<br />
<br />
By default, help is OFF. You enable help at all 4 help levels as follows.<br />
<br />
==Page Level==<br />
<br />
In the page settings (NOT IMPLEMENTED)<br />
<br />
==Item level==<br />
<br />
Turn on op_help in the record nav, so that would be $conf_entry_nav for the data entry pages. This will enable the help button in the record nav and set up the help to work properly.<br />
<br />
This will then try to find markup with a nickname for that page view and that type of item:<br />
<br />
* detfrm_cxt<br />
* regist_cxt<br />
* etc.<br />
<br />
This then includes the relevant markup.<br />
<br />
==Subform Level==<br />
<br />
Default behaviour in subforms is to list the help for each field in the subform. To overide this and just use a single arbitrary piece of markup, use:<br />
<br />
* op_help_nname => 'markupnickname',<br />
<br />
Place this on the sf_conf and specifiy the nickname of the markup you wish to use.<br />
<br />
To turn the help button on and off in the sfNav set the sf_nav_type to one of the options that include help.<br />
<br />
==Field Level==<br />
<br />
In the field settings (NOT IMPLEMENTED)<br />
<br />
==For all levels==<br />
<br />
A new subform conf will need to be entered in the page_settings.php file:<br />
<br />
<pre><br />
<br />
$conf_mcd_help =<br />
array(<br />
'view_state' => 'max',<br />
'edit_state' => 'view',<br />
'sf_nav_type' => 'nmedit',<br />
'sf_title' => 'help', <br />
'sf_html_id' => 'help', // Must be unique<br />
'script' => 'php/subforms/sf_help.php',<br />
'op_modtype' => FALSE, //if each modtype uses same fields (see below)<br />
'fields' =><br />
array(<br />
)<br />
);<br />
<br />
</pre><br />
<br />
This needs to be named $conf_mcd_help, otherwise the help system will not be able to find it. The subform has one 'op' value that can be applied:<br />
<br />
'op_textile' => TRUE<br />
<br />
If this op is specified, then the help will be printed using the Textile tool - which means it can be used to print complex formatted HTML (along with images, etc.). For more information on Textile see this link: http://txstyle.org/<br />
<br />
<br />
==Other things to bear in mind==<br />
<br />
The help uses the Markup system to attach the help to the fields. Therefore, the contents of the help at the subform level can either be edited directly from the help subform - or using the Markup Admin tools. By default the system assumes the nickname of the markup is 'help_' concatenated onto whatever the field_id is. For instance, the help for a field with id 'conf_field_description' would be 'help_conf_field_description'. It is possible to specify a different nickname, by including the option 'op_help_nname' in the field and setting a new nickname.<br />
<br />
As the names for the nicknames of the markup are usually help_ prefixed on the name of the field - the length of the nname field in cor_tbl_markup maybe too short. If you get an Error when updating or adding help related to the size of the field in the database then run this SQL command to fix it:<br />
<pre><br />
ALTER TABLE `cor_tbl_markup` CHANGE `nname` `nname` VARCHAR( 255 ) CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL DEFAULT<br />
</pre></div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=The_ARK_Help_System&diff=3285The ARK Help System2014-07-04T16:04:58Z<p>Guy: </p>
<hr />
<div>As of version 1.2 - a contextual help system has been introduced to ARK.<br />
<br />
The help system works by using the [[Markup]] system to display help relevant to the context. There are 4 contexts in which help might be displayed, these are:<br />
<br />
* Page Level - ie to help users understand how a page works<br />
* Record level - to help users understand the specifics of a record (context, plan, photo etc.)<br />
* Subform Level - to provide inline help for specific subforms<br />
* Field Level - to provide help relating to a specific field<br />
<br />
The help is displayed using a subform (sf_help.php) which can be either placed "inline" in the page or within an overlay. By default the help buttons fire an overlay, javascript is required to show or hide the inline help panels<br />
<br />
By default, help is OFF. You enable help using op_help at all 4 help levels.<br />
<br />
* Page Level - in page settings (NOT IMPLEMENTED)<br />
* Record level - in the record nav settings<br />
* Subform Level - in the sf_conf<br />
* Field Level - in the field conf (NOT IMPLEMENTED)<br />
<br />
Beyond this, there is very little configuration needed to enable the help system. The most important thing is to configure an sf_conf:<br />
<br />
==Configuring the subform==<br />
<br />
A new subform conf will need to be entered in the page_settings.php file:<br />
<br />
<pre><br />
<br />
$conf_mcd_help =<br />
array(<br />
'view_state' => 'max',<br />
'edit_state' => 'view',<br />
'sf_nav_type' => 'nmedit',<br />
'sf_title' => 'help', <br />
'sf_html_id' => 'help', // Must be unique<br />
'script' => 'php/subforms/sf_help.php',<br />
'op_modtype' => FALSE, //if each modtype uses same fields (see below)<br />
'fields' =><br />
array(<br />
)<br />
);<br />
<br />
</pre><br />
<br />
This needs to be named $conf_mcd_help, otherwise the help system will not be able to find it. The subform has one 'op' value that can be applied:<br />
<br />
'op_textile' => TRUE<br />
<br />
If this op is specified, then the help will be printed using the Textile tool - which means it can be used to print complex formatted HTML (along with images, etc.). For more information on Textile see this link: http://txstyle.org/<br />
<br />
==Configuring the navigation==<br />
<br />
The help is launched using an icon (anchor tag) in the title bar of the area you want help for (eg the record nav or the sf nav).<br />
<br />
To turn the help button on in the record nav, set this up in the record nav conf.<br />
<br />
To turn on the help button for sf_nav, set this up in the sf_conf 'sf_nav_type' configuration option. Currently the help icon will appear when sf_nav_type is set to 'full' or 'help'.<br />
<br />
==Other things to bear in mind==<br />
<br />
The help uses the Markup system to attach the help to the fields. Therefore, the contents of the help can either be edited directly from the help subform - or using the Markup Admin tools. By default the system assumes the nickname of the markup is 'help_' concatenated onto whatever the field_id is. For instance, the help for a field with id 'conf_field_description' would be 'help_conf_field_description'. It is possible to specify a different nickname, by including the option 'op_help_nname' in the field and setting a new nickname.<br />
<br />
As the names for the nicknames of the markup are usually help_ prefixed on the name of the field - the length of the nname field in cor_tbl_markup maybe too short. If you get an Error when updating or adding help related to the size of the field in the database then run this SQL command to fix it:<br />
<pre><br />
ALTER TABLE `cor_tbl_markup` CHANGE `nname` `nname` VARCHAR( 255 ) CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL DEFAULT<br />
</pre></div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3263Basic Installation2014-02-27T19:13:04Z<p>Guy: /* MySQL */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Check and Install Dependencies===<br />
<br />
====Dependencies====<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
====on LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install <code>mysql-server</code> and <code>mysql</code>, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====on OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
If you successfully logged in as Jane Doe, pat yourself on the back and now mask sure you finish the last few steps:<br />
<br />
You now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself on ARK and make yourself and administrator. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You <b>should</b> now remove the default doe_jd user to prevent unauthorised access to your system.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3262Basic Installation2014-02-27T18:47:28Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Check and Install Dependencies===<br />
<br />
====Dependencies====<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
====on LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====on OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
If you successfully logged in as Jane Doe, pat yourself on the back and now mask sure you finish the last few steps:<br />
<br />
You now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself on ARK and make yourself and administrator. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You <b>should</b> now remove the default doe_jd user to prevent unauthorised access to your system.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3261Basic Installation2014-02-27T18:46:57Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Check and Install Dependencies===<br />
<br />
====Dependencies====<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
If you successfully logged in as Jane Doe, pat yourself on the back and now mask sure you finish the last few steps:<br />
<br />
You now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself on ARK and make yourself and administrator. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You <b>should</b> now remove the default doe_jd user to prevent unauthorised access to your system.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3260Basic Installation2014-02-27T18:45:40Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
=== Check and Install Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
If you successfully logged in as Jane Doe, pat yourself on the back and now mask sure you finish the last few steps:<br />
<br />
You now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself on ARK and make yourself and administrator. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You <b>should</b> now remove the default doe_jd user to prevent unauthorised access to your system.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3259Basic Installation2014-02-27T18:08:18Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
If you successfully logged in as Jane Doe, pat yourself on the back and now mask sure you finish the last few steps:<br />
<br />
You now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself on ARK and make yourself and administrator. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You <b>should</b> now remove the default doe_jd user to prevent unauthorised access to your system.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3258Basic Installation2014-02-27T18:07:13Z<p>Guy: /* Final Configuration */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
If you successfully logged in as Jane Doe, pat yourself on the back and now mask sure you finish the last few steps:<br />
<br />
You now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself on ARK and make yourself and administrator. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You *should* now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3257Basic Installation2014-02-27T18:05:27Z<p>Guy: /* environment settings */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3256Basic Installation2014-02-27T18:04:28Z<p>Guy: /* Unpack ARK */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You can now rename the ark package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3255Basic Installation2014-02-27T18:02:14Z<p>Guy: /* Initial Setup */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3254Basic Installation2014-02-27T18:00:48Z<p>Guy: /* Initial Setup */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
Once you have created the database and user, you should update your settings files<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3253Basic Installation2014-02-27T17:59:42Z<p>Guy: /* Create Database and User */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to create a new database, import the SQL into it and create a new user on your MySQL server.<br />
<br />
The basic ARK database is included in the ARK package as an SQL file. <br />
<br />
ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3252Basic Installation2014-02-27T17:55:07Z<p>Guy: /* Create Database */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database and User==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3251Basic Installation2014-02-27T17:53:17Z<p>Guy: /* OSX or WINDOWS */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3250Basic Installation2014-02-27T17:52:31Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3249Basic Installation2014-02-27T17:50:38Z<p>Guy: /* Install Dependencies */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.<br />
<br />
If you would prefer a simple package based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
=====MS4W=====<br />
<br />
This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on our website] for installing this package.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3248Basic Installation2014-02-27T17:45:58Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3247Basic Installation2014-02-27T17:45:14Z<p>Guy: /* environment settings */</p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3246Basic Installation2014-02-27T17:44:37Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3245Basic Installation2014-02-27T17:43:31Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
In addition the following packages are useful:<br />
<br />
#phpMyAdmin<br />
<br />
Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX or WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your webserver directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
You now need to import the SQL code into MySQL. The easiest way to do this is using phpMyAdmin, but you also accomplish it using the command line mysql tools:<br />
<br />
===Using phpMyAdmin===<br />
<br />
Use the phpMyAdmin interface to create a new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file. This file should be self-explanatory - however there is an explanation of the relevant settings at [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php].<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3244Basic Installation2014-02-27T12:43:25Z<p>Guy: /* Dependencies */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3243Basic Installation2014-02-26T20:04:42Z<p>Guy: /* Install Dependencies */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====OSX OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3242Basic Installation2014-02-26T20:03:55Z<p>Guy: /* Install Dependencies */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
Most Linux distros include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.<br />
<br />
If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].<br />
<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3241Basic Installation2014-02-26T20:02:04Z<p>Guy: /* Dependencies */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3240Basic Installation2014-02-26T20:01:44Z<p>Guy: /* Install Dependencies */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3239Basic Installation2014-02-26T19:57:48Z<p>Guy: /* Final Configuration */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself. Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.<br />
<br />
Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3238Basic Installation2014-02-26T19:56:03Z<p>Guy: /* Browse to ARK directory */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to your ARK===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
Log in using these details and then finalise your configuration.<br />
<br />
===Final Configuration===<br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
Once you have created this new administrator, you should logout and log back in again using you new username.<br />
<br />
You should now remove the default doe_jd user to prevent unauthorised access.<br />
<br />
Use the ARK system to configure the markup you need for the ARK name you specified in the settings file.<br />
<br />
Use the ARK system to add the site code you specified as the default site code in the settings files.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3237Basic Installation2014-02-26T19:49:35Z<p>Guy: /* Using phpMyAdmin */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server Apache and MySQL servers running, phpMyAdmin is a very convenient tool for administering databases. If you install this tool then you can use it to set up your ARK database.<br />
<br />
Use the phpMyAdmin interface to create a new database on your server. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.<br />
<br />
Now create a new user and grant them privileges on the new database. ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Individual (human) users on the website are managed by the ARK system.<br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3236Basic Installation2014-02-26T19:43:36Z<p>Guy: /* Initial Setup */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3235Basic Installation2014-02-26T19:42:51Z<p>Guy: /* Initial Setup */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to edit some of the configuration directives in the settings files located inside the "config" folder of your ARK installation.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3234Basic Installation2014-02-26T19:41:18Z<p>Guy: /* MAC OR WINDOWS */</p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
There are several ways to install the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so.<br />
<br />
If you would prefer a simple installer, please consider using either WAMP or MAMP to install a complete stack on your system.<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3232Basic Installation2014-02-26T19:34:58Z<p>Guy: </p>
<hr />
<div>If you are comfortable setting up an Apache web server and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.<br />
<br />
If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3231Basic Installation2014-02-26T19:31:30Z<p>Guy: /* Browse to ARK directory */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.<br />
<br />
After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3230Basic Installation2014-02-26T19:28:53Z<p>Guy: /* File Uploads and phMagick */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.<br />
<br />
For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3229Basic Installation2014-02-26T19:27:55Z<p>Guy: /* Preflight Checks */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
====File Uploads and phMagick====<br />
<br />
It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.<br />
<br />
If you intend to upload files such ad PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore these test failures.<br />
<br />
For further information on how to install the relevant PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3228Basic Installation2014-02-26T19:19:43Z<p>Guy: /* Cleanup */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3227Basic Installation2014-02-26T19:18:44Z<p>Guy: </p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Debug==<br />
<br />
If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:<br />
<br />
<pre><br />
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
to<br />
<br />
<pre><br />
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES<br />
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING<br />
</pre><br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3226Basic Installation2014-02-26T19:15:21Z<p>Guy: /* Install Dependencies */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include an Apache web server. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:<br />
<br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ may not run ARK or may produce "deprecated" errors as some functions have been deprecated. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3225Basic Installation2014-02-26T19:08:33Z<p>Guy: </p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<pre><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</pre><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3224Basic Installation2014-02-26T19:07:56Z<p>Guy: /* environment settings */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:<br />
<br />
<code><br />
// The folder name of THIS instance of ARK (relative to the domain)<br />
$ark_dir<br />
// The server path to the ark directory<br />
$ark_server_path<br />
// The path to the PEAR installation<br />
$pear_path<br />
</code><br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3223Basic Installation2014-02-26T19:04:42Z<p>Guy: /* Unpack ARK */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
You should then rename the ark package's folder to your desired name. Make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3222Basic Installation2014-02-26T18:56:59Z<p>Guy: /* Unpack ARK */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this directory will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation. Consult the documentation of your distribution if you are unsure where this is. It is likely to be either <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
This directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation.<br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3221Basic Installation2014-02-26T18:55:50Z<p>Guy: </p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. Consult the documentation of your distribution if you are unsure where this is. It is likely to be either <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
This directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. <br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3220Basic Installation2014-02-26T18:54:07Z<p>Guy: /* Initial Setup */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. Consult the documentation of your distribution if you are unsure where this is. It is likely to be either <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
This directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. <br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
Use the interface to create a database and configure a user for your ARK.<br />
<br />
ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. <br />
<br />
Import the arkv1_1.sql file from the ARK source code into your database using the import tab on phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
Start with the general <code>settings.php</code> file.<br />
<br />
You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database. <br />
<br />
You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.<br />
<br />
====environment settings====<br />
<br />
Next edit your <code>env_settings.php</code> file.<br />
<br />
Change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment.<br />
<br />
Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database and user that you created earlier.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the user and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3218Basic Installation2014-02-26T18:23:19Z<p>Guy: /* Initial Configuration */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. Consult the documentation of your distribution if you are unsure where this is. It is likely to be either <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
This directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. <br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
You can use this to create a database, an configure a user. ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. Import the arkv1_1.sql file from the ARK source code into your database using phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Setup==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
In <code>settings.php</code> you can update the name of your ARK, this value will be used for the presentation of your website. You will also need to create a markup nickname (nname) for your ARK. This will let you store and access a human readable name for your ARK on the database.<br />
You should also set your default site code here, but you will need to add it to the ARK database once you are connected. <br />
<br />
====environment settings====<br />
<br />
In <code>env_settings.php</code> change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment. Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database that you created in the setup stages.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the user and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3217Basic Installation2014-02-26T18:22:37Z<p>Guy: </p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. Consult the documentation of your distribution if you are unsure where this is. It is likely to be either <code>/var/www/</code> or <code>/srv/www/</code>.<br />
<br />
This directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. <br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
You can use this to create a database, an configure a user. ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. Import the arkv1_1.sql file from the ARK source code into your database using phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Configuration==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
<br />
In <code>settings.php</code> you can update the name of your ARK, this value will be used for the presentation of your website. You will also need to create a markup nickname (nname) for your ARK. This will let you store and access a human readable name for your ARK on the database.<br />
You should also set your default site code here, but you will need to add it to the ARK database once you are connected. <br />
<br />
====environment settings====<br />
<br />
In <code>env_settings.php</code> change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment. Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database that you created in the setup stages.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the user and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3216Basic Installation2014-02-26T18:20:49Z<p>Guy: /* Dependencies */</p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. Consult the documentation of your distribution if you are unsure where this is. It is likely to be either <code>/var/www/</code> or <code>/srv/www/</code>.<br />
This directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. <br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this folder will be used to navigate your brower, so call it something short, easy to remember and unique to your installation. <br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
You can use this to create a database, an configure a user. ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. Import the arkv1_1.sql file from the ARK source code into your database using phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Configuration==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
In <code>settings.php</code> you can update the name of your ARK, this value will be used for the presentation of your website. You will also need to create a markup nickname (nname) for your ARK. This will let you store and access a human readable name for your ARK on the database.<br />
You should also set your default site code here, but you will need to add it to the ARK database once you are connected. <br />
<br />
====environment settings====<br />
In <code>env_settings.php</code> change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment. Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database that you created in the setup stages.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the user and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks.<br />
<br />
[[category:Administrator]]</div>Guyhttps://ark.lparchaeology.com/wiki/index.php?title=Basic_Installation&diff=3215Basic Installation2014-02-26T18:19:54Z<p>Guy: </p>
<hr />
<div>Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:<br />
<br />
===Download source===<br />
<br />
Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.<br />
<br />
===Dependencies===<br />
<br />
ARK requires the following open source software packages to be installed on your server:<br />
<br />
#Apache<br />
#PHP 5.4<br />
#MySQL<br />
<br />
ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer bundled with ARK so that users can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.<br />
<br />
==Install Dependencies==<br />
<br />
====LINUX====<br />
<br />
=====Apache=====<br />
<br />
Most Linux distros include a web service (like Apache) consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with <br />
<code> sudo service httpd start </code><br />
<br />
If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].<br />
<br />
On most Linux distributions these packages will be installed by default.<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. Consult the documentation of your distribution if you are unsure where this is. It is likely to be either <code>/var/www/</code> or <code>/srv/www/</code>.<br />
This directory will be used to navigate your browser, so call it something short, easy to remember and unique to your installation. <br />
<br />
=====PHP=====<br />
<br />
ARK 1.1 requires PHP 5.4. PHP 5.5+ will not run ARK as some functions have been deprecated. This will be updated in future releases of ARK. It is important to ensure that you have the gd and dbase php extensions enabled.<br />
<br />
=====MySQL=====<br />
<br />
MySQL is included in many Linux distros, but if you do not have it you may need to install mysql-server and mysql, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website]. <br />
<br />
You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.<br />
<br />
====MAC OR WINDOWS====<br />
<br />
=====MAMP/WAMP=====<br />
<br />
For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these service.<br />
<br />
ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.<br />
<br />
==Unpack ARK==<br />
<br />
Unpack the ARK source code into the desired location in your server directory. By default this folder will be used to navigate your brower, so call it something short, easy to remember and unique to your installation. <br />
<br />
==Create Database==<br />
<br />
===Using the Command Line===<br />
<br />
You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance: <br />
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';<br />
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code><br />
<br />
The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information. <br />
ARK only requires one user on the database, individual users on the website are managed by ARK.<br />
<br />
You will also need to create a database for your ARK to connect to. <br />
<code>CREATE DATABASE arkv1_1</code><br />
<br />
You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.<br />
<br />
The ARK database is included in the ARK package as an SQL file. You can load this into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.<br />
<br />
===Using phpMyAdmin===<br />
<br />
Once you have your server running you should be able to navigate to phpmyadmin, which is a very useful tool for administrating a database. You can access it at [localhost:8888/phpMyAdmin] by default.<br />
<br />
You can use this to create a database, an configure a user. ARK only requires one user on the database, individual users on the website are managed by PEAR, which is bundled in the ARK package. Import the arkv1_1.sql file from the ARK source code into your database using phpmyadmin.<br />
<br />
More information on how to use phpmyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].<br />
<br />
==Initial Configuration==<br />
<br />
===Config===<br />
<br />
You will need to update the values in the config/ folder of your ARK installation to match the environment that you are working in.<br />
<br />
====settings====<br />
In <code>settings.php</code> you can update the name of your ARK, this value will be used for the presentation of your website. You will also need to create a markup nickname (nname) for your ARK. This will let you store and access a human readable name for your ARK on the database.<br />
You should also set your default site code here, but you will need to add it to the ARK database once you are connected. <br />
<br />
====environment settings====<br />
In <code>env_settings.php</code> change the $server flag on line 52 to match your server type, either mac, windows or linux. <br />
<br />
Then in the correct code block, alter the paths to match the locations of the relevant directories in your ARK environment. Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.<br />
<br />
Alter the database settings at the end of the file to match the database that you created in the setup stages.<br />
<br />
<b>You are now ready to connect to your ARK!</b><br />
<br />
===Preflight Checks===<br />
<br />
Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.<br />
<br />
This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.<br />
<br />
===Browse to ARK directory===<br />
<br />
After browsing to the ARK directory you should now be able to see the login pages for the database. The default database is created with the following admin user account:<br />
<br />
<pre><br />
username: doe_jd<br />
password: janedoe<br />
<br />
</pre><br />
<br />
You will now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself, [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for your ARK name and [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code].<br />
<br />
If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.<br />
<br />
==Cleanup==<br />
<br />
Once you have pass all pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.<br />
<br />
If you plan on suing your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the user and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks.<br />
<br />
[[category:Administrator]]</div>Guy