===========================================================
 PositLog Install Manual

 Copyright (c) 2006-2008 Hidekazu Kubota All right reserved
  <hidekaz@positlog.org>
   http://positlog.org/

 Change Log:

 2008-01-25 version 0.6rc1
===========================================================

--------------------------------------------------------
--------------------------------------------------------
1. Introduction
--------------------------------------------------------
--------------------------------------------------------

This document describes the way of a clean install of PositLog.

--------------------------------------------------------
--------------------------------------------------------
2. System Requirements
--------------------------------------------------------
--------------------------------------------------------

 - Perl 5.8+

 - PositLog does not officially support the server that uses ScriptAlias. Using ScriptAlias means, in other words, .cgi directory and .html directory must be different. Some functions are not available on such server. The ways to install is partially different from this document. Please see also scriptalias.txt.

--------------------------------------------------------
--------------------------------------------------------
3. Check Path of perl
--------------------------------------------------------
--------------------------------------------------------

PositLog presumes that perl is installed in the following path:

 /usr/bin/perl

If perl is not installed here, fix the path in all .cgi files.

--------------------------------------------------------
--------------------------------------------------------
4. Install
--------------------------------------------------------
--------------------------------------------------------

Create a directory for PositLog on your Web space.
e.g.) /var/www/html/positlog/
This directory is called PositLog Root Directory.

I recommend that no files except PositLog files are in this directory.

The URL corresponded to this directory is called PositLog Root URL.
e.g.) html://xxx.com/positlog/

----------------------------------------
(1) Extract Archive
----------------------------------------

Extract the zipped archive of PositLog.

----------------------------------------
(2) Set PositLogConfig.pm
----------------------------------------

Open document/English/PositLogConfig.pm and set Root URL ($rooturl).

That is the minimum configuration to install. 
Set other configurations if you need.

----------------------------------------
(3) Create Essential Directories
----------------------------------------

First, create essential two directories just under PositLog Root Directory : 

 admindata (777)
 bgimages (777)
@
Next, create Page data Directory ($datapath). The path is configured in PositLogConfig.pm. The default path is "./pages/".
@
The file tree will be the diagram below if you use default settings :

@PositLog Root Directory (755)
@|- admindata (777)
@|- bgimages (777)
@|- pages (777)

----------------------------------------
(4) Copy Files
----------------------------------------

Copy (or upload) PositLogConfig.pm to PositLog Root Directory.

Copy (or upload) .cgi files and .pm files just under the extracted directory to PositLog Root Directory.


The added file tree will be the diagram below :

PositLog Root Directory (755)
 |- clearCache.cgi (755)
 |- createadmin.cgi (755)
 |- createPage.cgi (755)
 |- deleteSprite.cgi (755)
 |- fileloader.cgi (755)
 |- fileupload.cgi (755)
 |- groupSprite.cgi (755)
 |- pagerss.cgi (755)
 |- positlog.cgi (755)
 |- PositLogAuth.pm (755)
 |
 |- PositLogConfig.pm (755)
 |
 |- PositLogLink.pm (755)
 |- PositLogParam.pm (755)
 |- PositLogSprites.pm (755)
 |- recentcontents.cgi (755)
 |- saveSprite.cgi (755)
 |- saveStyles.cgi (755)
 |- tag.cgi (755)
 |- ungroupSprite.cgi (755)
 |- unlockPassword.cgi (755)


----------------------------------------
(5) Copy Directories
----------------------------------------

Copy (or upload) directories (and including files) just under the extracted directory to PositLog Root Directory.

@admintools
@extlib
@lang
@PositLogPlugin
@system

Set the permisions of directories to 755, files to 644 except files descrived in next section (6).

----------------------------------------
(6) Set Permissions to CGI
----------------------------------------

Set the permissions of following .cgi files to 755.

(That is to say, the permissions of all .cgi files in PositLog are set to 755.)
@
PositLog Root Directory (755)
 |- admintool (755)
 |    |- admin.cgi (755)
 |    |- adminnavi.cgi (755)
 |    |- admintop.cgi (755)
 |    |- pagemanager.cgi (755)
 |    |- pageproperty.cgi (755)
 |    |- positlogadmin.cgi (755)
 |    |- usermanager.cgi (755)
 |    |- userproperty.cgi (755)
 |- system
 |    |- fckeditor
            |- editor
                |- filemanager
                     |- connectors
                          |- perl (777) 
                               |- connector.cgi (755)
                               |- upload.cgi (755)



Set permission for CGI to write system/fckeditor/editor/filemanager/connectors/perl/ directory.



-------------------------------------------------
(7) Set .htaccess under admindata directory
-------------------------------------------------

The archive includes .htaccess that should be put under admindata directory.
Change the file named "htaccess_admindata" into  ".htaccess", 
and put it under admindata directory.

Notice that the file explorer of Windows cannot name a file ".htaccess".
Change the name on an FTP software.

PositLog Root Directory (755)
 |- admindata (777)
 |    |- .htaccess (644)

-------------------------------------------------
(8) Set .htaccess under PositLog Root Directory
-------------------------------------------------

The archive also includes the sapmles of .htaccess that should be put under PositLog Root Directory.
They are "htaccess" and "htaccess_mod_rewrite".
Change the name of one of them into ".htaccess",
and put it under PositLog Root Directory.
@
PositLog with these .htaccess files does not work under some server settings.
If so, change the settings in .htaccess or delete it from the server.


(a) htaccess 

This is a basic example.

- Options -Indexes

 This line hides a file list of a directory when a URL which maps to a directory is requested. 
 (See also http://httpd.apache.org/docs/2.0/en/mod/core.html#options)

- DirectoryIndex positlog.cgi index.html

 This line returns positlog.cgi when a PositLog Root URL is requested.
 If the homepage of PositLog is set by PositLog Aministration Tools,
 it returns the homepage.
 (See also  http://positlog.com/071208Yf.html#id_spr6eaob to set a homepage)
@
- AddHandler cgi-script .cgi .pm .dat .spr

 This line hide the inner data structures of PositLog (.dat and .spr files) from HTTP access.


(b) htaccess_mod_rewrite

This is RewriteEngine sample.

First, check if mod_write is available on the web server.
If available, Set 
  $mod_rewrite = 1;
in PositLogConfig.pm, and use this sample.

This sample enables to replace such URL as
  positlog.cgi?load=000000XX
to 
  000000XX.html

It also enables to user rel-tag of microformats.
 (http://microformats.org/wiki/rel-tag)


----------------------------------------
(9) Create Administrator
----------------------------------------

Open createadmin.cgi on the web browser.
Enter the user id and password of Administrator (admin), and push "Create" button.

Delete createadmin.cgi from the web server after that.

The file named "key.dat" has been created under admindata directory.
This is authentication data of Administrator.

If you would like to change user id or password of Administrator, 
delete key.dat and run createadmin.cgi again.


--------------------------------------------------------
--------------------------------------------------------
5. Start PositLog
--------------------------------------------------------
--------------------------------------------------------

----------------------------------------
(1) Log in to Administration Tools
----------------------------------------

Open admintools/admin.cgi on the web browser.
Enter the user id and password of Administrator on log-in screen,
and push [Login] button.

Attention:
  Temporary cookies must be available on the web browser to log in.

----------------------------------------
(2) Create New Page
----------------------------------------

First, create a new page.
Section "Create new page" is on the top page of Administration Tools.
(http://positlog.org/071208sA.html)

Enter the new page name into the field and push "Create this page" button to create it.
@
The new page is added on the page list.
Open "edit" link to edit the new page.
Open "open" link to browse it.
(http://positlog.org/071208Yf.html#id_spr9esau)

See also online manual pages to get more detailed information.
http://positlog.org/071208Rq.html

Security Section should be read among them.
http://positlog.org/071213gV.html



=====================================================
That's all. Thank you!
