My Postcards Platinum Web Application (ver.4) 

User Guide // Setup

 Files and directories 

note for clients hosted on webby: we may apply slight alterations in names and locations of admin programs, contact us for details if you have questions

 Directories 

SCRIPT_DIR - (CHMOD 755)

if your server allows execution of cgi-scripts in any directory then SCRIPT_DIR = ROOT_DIR, otherwise SCRIPT_DIR = /cgi-bin

ROOT_DIR - (CHMOD 755)

By default "platinum", unless you renamed it or requested other directory while installation

ROOT_DIR/cards/ - (CHMOD 777)

Server path to this directory is defined in magic-conf.txt. Directory where card sources are written to (except cards scheduled for delayed delivery. You don't need even to look there - files there are created and deleted automatically. Do not upload any other files to this directory!

ROOT_DIR/queue/ - (CHMOD 777)

Server path to this directory is defined in magic-conf.txt. Directory where card sources and mail notifications for scheduled delivery are written to. All contents are created/removed automatically - do not do anything with this directory. Do not upload or delete files and folders there!

ROOT_DIR/stats/ - (CHMOD 777)

Server path to this directory is defined in magic-conf.txt. Directory where statistics data and reports are accumulated - do not do anything with this directory. Do not upload or delete files and folders there! Good idea is to protect this directory with .htaccess to prevent others from peeking at your stats.

ROOT_DIR/includes/ - (CHMOD 777)

Server path to this directory is defined in magic-conf.txt. Directory where all html and e-mail templates are stored. Also current daily counter file is being written there. You can edit all files there BUT counter (it's dangerous for your server if your cardshop has any noticeable traffic). You can upload any number of template files to this directory.

ROOT_DIR/poems/

Server path to this directory is defined in magic-conf.txt. Directory where you store all source files for poems (*.txt) and java applets (*.jav). You can upload/delete any files there.

ROOT_DIR/images/

WWW address for this directory is defined in magic-conf.txt. You store images there. You can create subdirectories and group images thematically.

ROOT_DIR/music/

WWW address for this directory is defined in magic-conf.txt. You store music files there. You can create subdirectories and group your files thematically.

ROOT_DIR/backs/

You store background files there. You can create subdirectories and group your files thematically.

ROOT_DIR/stamps/

You store stamps (icons) files there. You can create subdirectories and group your files thematically.

ROOT_DIR/classes/

You store Java class files here.

/backs. /stamps, /classes directories are not mandatory, you can put their contents elsewhere, those directories are not defined in global configuration file magic-conf.txt

 Files 

SCRIPT_DIR/magiccard.cgi - main program (CHMOD 755)
SCRIPT_DIR/cardadmin.cgi - card cleanup program (CHMOD 755)
SCRIPT_DIR/magic-conf.txt - global configuration file
SCRIPT_DIR/magic.txt - sample cardshop configuration file
SCRIPT_DIR/later.cgi - admin program required for send later option
SCRIPT_DIR/later.sh, SCRIPT_DIR/send-later.sh, SCRIPT_DIR/send-now.sh - admin shell scripts required for notification email delivery and send later oprions

ROOT_DIR/index.html - sample pickup page with links to other sample pages
ROOT_DIR/card1.shtml - basic composition page with minimum selections
ROOT_DIR/card2.shtml - basic composition page with all selections
ROOT_DIR/card3.shtml - composition page with preselected elements
ROOT_DIR/card4.shtml - composition page with use any picture, sound, etc.
ROOT_DIR/card5.shtml - composition page with all selections and javascript preview

ROOT_DIR/later.txt - automatically generated file with send later dates

ROOT_DIR/poems/applet1.jav, applet2.jav - sample source file for Java applets to be used on postcards
ROOT_DIR/poems/poem1.txt, poem2.txt, poem3.txt - sample files with poetry

ROOT_DIR/includes/mail1.txt, mail2.txt - sample e-mail templates
ROOT_DIR/includes/preview.html, receive.html - sample card templates
ROOT_DIR/includes/sent.html - sample "postcard sent" page
ROOT_DIR/includes/Err_*.html - customizable error pages

SCRIPT_DIR/report.cgi - stats central program (CHMOD 755)
ROOT_DIR/stats/index.html - stats central entrance page

also sample images, midis, backgrounds, stamps and class files in appropriate directories. See full list of all files included in distribution in Reference.

 Global configuration file (magic-conf.txt) 

Be careful when editing this file, make sure you don't have extra-spaces anywhere. If you are editing this file offline and uploading with FTP be sure to select BINARY transfer mode.

CARDS_URL> - Server path to the directory where your card data files will be stored. See above: ROOT_DIR/cards/

INC_DIR> - Server path to the directory where your include files will be stored. See above: ROOT_DIR/includes/

POEMS_DIR> - Server path to the directory where your poetry and applets source files will be stored. See above: ROOT_DIR/poems/

QUEUE_DIR> - Server path to the directory where card sources and mail notifications for scheduled delivery are written to. See above: ROOT_DIR/queue/

STATS_DIR> - Server path to the directory where statistics data and reports are accumulated. See above: ROOT_DIR/stats/

IMG_URL> - WWW address of directory where your images are stored. See above - ROOT_DIR/images

MIDI_URL> - WWW address of directory where your sound files are stored. See above - ROOT_DIR/music

SEND_MAIL> - sendmail program location, most probably will look like /usr/lib/sendmail, if you don't know where it is and what it is - ask your ISP or system administrator

MODE> - notification mail delivery mode, default setting is ASAP, can be set to QUEUE mode. See detailed description in admin chapter

DAYS> - days to send cards in advance, default setting is 30, you can set it to anything

KEEP_PICK> days to keep picked cards, default setting is 7, you can set it to anything

KEEP_NOT_PICK> - days to keep not picked cards, default setting is 7, you can set it to anything

Important notice: you cannot rename this file or move outside SCRIPT_DIR, otherwise your software will not work!

 // index // setup // customize // reference // admin // support // license //  

 My Postcards Platinum Web Application