|
StaticStore » StaticStore Manual » Installation
1. Installation
1.1 StaticStore Installation Instructions
1.1.1 StaticStore requirements
1.1.2 Installation Instructions for Unix/Linux
1.2 Installation Notes (Please Read)
1.2.1 Extra Fields/Keys
1.2.2 How to add extra fields/keys at setup/installation
time
1.3 Unix/Linux installation Trouble Shooter
1.4 Upgrade Instructions to upgrade to a newer version of StaticStore
1.5 Moving StaticStore to another host
1.5.1 Backup your data
1.5.2 Do clean install of StaticStore on the new
host
1.5.3 Restore your backups
1.1 StaticStore Installation Instructions
The StaticStore installation should take less than 15 minutes. Follow the installation
instructions below exactly. Do the steps as you read through them. The installation
instructions below could have been written in a couple of sentences, but have been
written to be as comprehensive as possible, so that you get it right the first time.
1.1.1 Requirements
- A Unix/Linux based host or server
- Perl 5.002+
- Standard cgi-bin access / StaticStore also supports perl extensions
- Telnet or SSH access
- FTP Access
- A version 4+ browser for the use of the web admin control panel
- MYSQL with Perl DBI Modules installed
1.1.2 Installation Instructions For Unix/Linux:
Click here if you want to upgrade to a newer version
of StaticStore SQL for upgrade instructions.
Step 1. UNZIP THE .ZIP ARCHIVE IN WHICH StaticStore
CAME
Unzip the .zip archive in which StaticStore came.
Step 2 - CREATE A DATA DIRECTORY
Create a directory called 'staticstore_data' or whatever you would like to name
it. Place it somewhere where the web server cannot access it's contents.
Another way of saying this would be to say that you need to create a 'staticstore_data'
directory where it cannot be accessed from a web browser when users are browsing
your web site.
Do not create this directory in your public HTML folder because it can create
security risks. Also do not create this directory in your cgi-bin directory. If
you are unsure about where to place this directory, contact your host and ask them
where you can place data files used by your cgi scripts so that the public cannot
view it's contents.
Fictional Examples where you can create it:
Create it in for example:
/home/yourdomain.com/staticstoredata
Let's say that your cgi-bin directory is situated under: /home/yourdomain.com/cgi-bin
Let's also say your public HTML directory is situated under: /home/yourdomain.com/www
Step 3 - COPY/FTP DATA FILES AND ASSIGN PERMISSIONS
When you unzipped the .zip archive of StaticStore, a 'data' directory should
have been extracted. Transfer it's contents to the 'staticstore_data' directory
you have just created.
Now, assign permissions of 777 to the 'data' directory. Also assign permissions
of 777 to the files that you just transferred to the 'data' directory.
How do I set/assign permissions
to directories and files?
Step 4 - COPY/FTP CGI SCRIPTS
When you unzipped the .zip archive of StaticStore, a 'cgi' directory should have
been extracted. Copy/Ftp all the files in the cgi directory to your cgi-bin directory
on your host. Please note that the cgi directory that was unzipped contains a subdirectory
for the 'admin' files. This directory is called 'admin'. Also create this sub directory
in your cgi-bin directory and copy/ftp the 'admin' cgi scripts to this directory.
You can for example place the general program script files here:
/cgi-bin/staticstore
and the admin script files here:
/cgi-bin/staticstore/admin
Step 5 - SET PERMISSIONS OF .cgi AND .pm FILES TO 755
Set the permissions of all the .cgi and .pm files that you transferred to your cgi-bin
directory to 755 except config.cgi
How do I set/assign permissions
to directories and files?
Step 6 - ASSIGN PERMISSIONS OF 777 TO config.cgi
Assign the permission setting of 777 to config.cgi which you just copied/ftp'ed
with the rest of the .cgi and .pm files.
Step 7 - CREATE A DIRECTORY TO STORE GENERATED HTML FILES
Create a directory called 'html' or whatever you want to call it in your public
HTML document tree. Your public HTML document tree would be where you store the
public HTML files of your web site. Do not create this directory under your cgi-bin
directory.
Create it for example in your public HTML directory as follows:
http://www.yourdomain.com/store/
or
http://www.yourdomain.com/products/
When running setup.cgi, do not set the StaticStore 'html' directory to be your
Public HTML directory. This can create potential security risks and
can interfere with other files inside your public HTML directory. The StaticStore
'html' directory where generated files are to be written to must be a subdirectory
inside your public 'html' directory.
Step 8 - COPY/FTP FILES AND ASSIGN PERMISSIONS OF 777 TO THE 'HTML' DIRECTORY
When you unzipped the zip archive in which StaticStore came, there were 3 directories.
Ftp/copy the contents of the 'html' directory to the directory you have created
in the above step.
Now assign the permission setting of 777 to the directory that you just
created.
How do I set/assign
permissions to directories and files?
Step 9 - SET UP THE SYSTEM FROM THE WEB
Run setup.cgi from your web browser. setup.cgi is located in the admin directory
where you copied the admin cgi scripts.
You should type something like the example below to execute setup.cgi in your
browsers:
http://www.yourdomain.com/cgi-bin/staticstore/admin/setup.cgi
Please read the installation notes below before running
setup.cgi
1.2 Installation Notes (Please Read)
1.2.1 Extra Fields Keys
StaticStore offers you the facility to add extra fields. Note that extra fields
are also referred to as extra fields/keys in setup.cgi - setup.cgi enables you
to configure StaticStore and additionally add extra fields. Note that the option
to add extra fields is only available at setup time.
What is extra fields keys?
Extra fields/keys enables you to add additional fields for your product/item
listings. You can have up to 20 extra fields/keys. Plan your extra fields well.
You can come back to change your extra fields at a later stage, but changing the
extra fields/keys is destructive because if the tables changes the product/items
inside them have to be discarded and new tables created.
The following standard fields for product/item listings is available
by default:
| title |
The product/item title is stored here |
| description |
The product/item description is stored here |
| keywords |
The keywords describing the product/item or web site. |
| url |
The URL of the web site (used for affiliate sales only in
most cases) |
| price |
The price of the product/item. |
| shipcost |
The flat-rate shipping cost if applicable. |
| urldate |
The date when the product was added |
1.2.2 How to add extra fields/keys at setup/installation
time
| Note that the option of adding extra fields is
only available when you run setup.cgi
This section assumes that it's the first time you run setup.cgi and you
would like to make use of extra fields/keys.
If there is already product/items in your database and you want to add
extra fields, please see:
The StaticStore Website
If there is already product/items in your database and you are not worried
about loosing your product/items and want to add extra fields, see:
The StaticStore Website
When you run setup.cgi you will reach a section where there is a 'Create Extra
Fields/Keys' button. Click this button. Once you clicked the 'Add Field/Key'
button, you will be presented with a form where you can add extra fields/keys.
Below is a description of the details you need to supply to create an extra
field:
|
|
Field/Key Name: This is the name of the extra field you
would like to add.
Field/Key Descriptive Name: This name will be identified
with the field name. For example: Colors, Size, Weight, etc...The descriptive
name will be used to describe the field when it's contents is displayed in the
control panel.
Field/Key size: (Number of characters) - This is the maximum
number of characters that is allowed in the field.
Visible in product/item listings when browsing control panel?
It might be a good idea to set this to 'No' if this field/key is going to contain
large amounts of text or an image. The control panel lists product/items and
when each product/item has a lot of text the pages listing the product/items
in their respective directories/categories might load slowly.
Do you want this field/key to be searched? If you choose
'Yes' above then this field will be searched for matches when end users search
your search engine. This setting has no effect if this is a image field/key
or if this field/key will only contain numericals.
Is this going to be an image field/key? Set this to 'Yes'
if this field is going to represent an image field/key. Image fields/keys holds
URLs to images. When used in your product/item listings, the image is automatically
displayed - you just enter a URL path to an image and the image is displayed
with your product/items.
Is this field going to contain numbers or characters? Choose
numbers if this field/key will only hold numerical values. Choose characters
if this field will hold characters and numericals. If this is going to be an
image field, then this setting defaults to 'Characters'. Set this to 'Characters'
if you are not sure what it does as this will still hold numbers.
Text if no value is available: You could for example use:
N/A or Not Available - This text is displayed
when this field/key has no value in your product/item listings.
When you completed the details, click on the 'Add Field/Key' button. When you
have added all the fields you require, click the 'Apply Field/Key Changes & Create
New product/items Table' button.
For more information on extra fields/keys, see the following:
Extra Fields/Key Q&A's in the StaticStore Knowledge Base
3.4 Extra Field/Key Settings
1.3 Unix/Linux Installation Trouble Shooter
Installation of StaticStore should be very easy if you follow the installation
instructions exactly as described in the installation steps.
In a lot of cases, simply going over the steps of the installation instructions
might solve the problem.
Is the permissions of the 'data' directory 777 ?
To set the permissions of the 'data' directory, do the following:
Step 1
Ftp/Telnet into your hosting account.
Step 2
Set permissions of the 'data' directory to 777
Is the permissions of the files in the 'data' directory set to 777 ?
Step 1
Ftp/Telnet/SSH into your hosting account.
Step 2
Set all the files that you transferred to the 'data' directory
to the permission setting of 777
Is the permissions for the 'html' directory correct?
To assign/set permissions of 777 to the 'html' directory, do the following:
Step 1
FTP/Telnet/SSH into your hosting account
Step 2
Set the permissions of the 'html' directory to 777
Is the path to the perl interpreter in the .cgi files correct?
If you are not sure where your perl interpreter is located, telnet/ssh into your
hosting account/server and type the following at the prompt: which perl
This command will display the location of perl.
You may also contact your host and ask them what the path to your Perl program
is. Most virtual hosting accounts comes with extensive documentation that should
provide you with the path to Perl.
If the path to Perl is not correct do the following to correct it:
Open all cgi scripts with a text editor and ensure that the first line which
reads
#/usr/bin/perl is set to the correct path where your perl interpreter resides.
If it is not set to the correct path of perl, please change the path to the correct
location of your perl interpreter. You will have to open all scripts to set the
path of perl if the current path is not correct.
Does all the .cgi and .pm files have the correct permissions?
Ensure that all the .cgi and .pm script files have permissions set to 755 - Also
ensure that config.cgi has the permission setting of 777
1.4 Upgrade Instructions to upgrade to a newer version
of StaticStore
For Linux/Unix
The upgrade should take minutes and is a very simple process.
To upgrade your existing copy of StaticStore, do the following:
1. Download the latest build and unzip the files that comes with the .zip archive.
2. Replace all your existing StaticStore .cgi and .pm files with the new ones that
came with the .zip archive. Do not replace config.cgi - Note that it is very important
that you don't replace this file with the one that comes with the .zip archive.
If you replace config.cgi you will need to supply paths via setup.cgi again as config.cgi
contains all the configuration paths.
3. Ensure that all .cgi and .pm files you transferred has the permission setting
of 755 on your host.
4. In the StaticStore .zip archive there will be a directory called 'html'. Transfer
all the image files located in the 'html' directory to your StaticStore 'html' directory
replacing the old image files. Your StaticStore 'html' directory is the directory
where HTML files are placed when generated. See the installation instructions for
more information about the 'html' directory.
Upgrade Guidelines
Never replace any files your existing StaticStore installation files other than
the .cgi and .pm files.
Ensure that the .cgi and .pm files that you replaced has the permission setting
of 755
1.5 Moving StaticStore to another host
Step 1. Backup your data
Please refer to backup documentation to make a complete backup of all your data.
9.6.1 How to backup data
Step 2. Do clean install of StaticStore on
the new host
Please refer to the installation instructions to do a clean installation.
1.1 StaticStore Installation Instructions
Step 3. Restore your backup
Restore your backup to the new installation of StaticStore on your new host.
Please refer to backup documentation for instructions on restoring a backup.
9.6.2 How to restore backed-up data
|
