My Postcards Platinum c Web Application (version 6)

Owner's Manual: Setup

  1. Directories and permissions
  2. Mail delivery setup
  3. Other settings
  4. Changes from version 5
Here and later: if permissions are not specified - system default permissions (defined by UMASK) would be enough and there is no need to change them
  1. Directories and permissions

    NOTE: This section describes default setup. It may be changed during the installation according to customer's request.

    All these locations are specified in global cardshop configuration which can be edited with web-based admin. You should never have to edit most of these. This info is intended mostly for troubleshooting.

    URLs relative to server's DOCUMENT_ROOT

    $PG_DIR - (chmod 755)
    Setup root. All sample composition pages are stored there. By default "/platinum/", unless you renamed it or requested an other directory name during installation. It has to be world-viewable.
    $PRG_DIR - (chmod 755)
    Directory, where main executables are stored. If your server allows execution of cgi-scripts in any directory then $PRG_DIR = $PG_DIR, otherwise $PRG_DIR = /cgi-bin/ It has to be world-executable.
    $ADM_DIR - (chmod 755)
    Directory, where admin programs are stored. By default "/platinum/admin". We STRONGLY recommend you to password-protect that directory after your cardshop is live ! It has to be world-viewable.
    $LYRICS_DIR, $CAPTION_DIR, $BLURB_DIR- (chmod 755)
    Directories, where the files with lyrics, captions and blurbs are stored. They have to be world-viewable.
    $SSI_INC_DIR - (chmod 755)
    Directory, where the files that are intended to be "included" in generated posty pages similar to SSI (e.g. footer, header, ads, etc.). It has to be world-viewable.

    Server path for various locations

    $CARDS_PATH - (chmod 731)
    Directory where card sources are written to. It should not necessarily be world-viewable.
    You don't need to look there - files there are created and deleted automatically. Do not upload or delete files and folders there!
    For sysadmins: detailed setup of card datafiles storage is described in the "administration" section of this manual
    $QUEUE_PATH - (chmod 731)
    Directory where e-mail notifications for scheduled delivery are written to. It should not necessarily be world-viewable.
    All contents are created/removed automatically - do not do anything with this directory. Do not upload or delete files and folders there!
    For sysadmin: detailed setup of card datafiles storage is described in "administration" section of this manual
    $STATS_PATH - (chmod 777)
    Directory where stat data and reports are accumulated - do not do anything with this directory. Do not upload or delete files and folders there! It should not necessarily be world-viewable.
    $INC_PATH - (chmod 731)
    Directory where custom configs, html, e-mail and error templates are stored. It should not necessarily be world-viewable. It contains 4 subdirectories with predefined names.
    $INC_PATH/html
    HTML templates for cards are to be stored there, You can upload any number of files there. Read more about HTML templates in the "customization" section of this manual.
    $INC_PATH/errors
    Special templates for error pages are stored there. All those pages have fixed names, you can edit them, but do not delete or rename! Adding there any other files will get you nowhere - the program will not "see" them.
    $INC_PATH/mail
    E-mail templates for cardshop are to be stored there. You can upload any number of files there. Read more about e-mail templates in "customization" section of this manual.
    $INC_PATH/conf
    Custom configuration files are to be stored there. All files in this subdirectory should have extension *.txt and permissions chmod 666. You can create any number of files in this directory. The format of those files is explained below. Starting with Version 6 these files can be managed via web-based interface.
    $POEMS_PATH (chmod 731)
    Directory where you store all source files for poems (*.txt) and java applets (*.jav). You can upload/delete any files there. Read more details about those files in "customization" section. It should not necessarily be world-viewable.
    $SAVE_PATH (chmod 777)
    Directory where the card datafiles are written to. It must be world-viewable.
    $LYRICS_PATH, $CAPTION_PATH, $BLURB_PATH (chmod 755)
    Directories, where the files with lyrics, captions and blurbs are stored. These must be world-viewable.
    $USER_PATH (chmod 731)
    Directory where the members data is stored. It should not be world-viewable. Subdirectories inside should have permissions 777. You don't need even to look there - files there are created and deleted automatically. Do not upload or delete files and folders there!
    $SSI_INC_PATH (chmod 777)
    Directory, where the files that are intended to be "included" in generated posty pages similar to SSI (e.g. footer, header, ads, etc.). It has to be world-viewable.
    $ADMIN_PATH (chmod 755)
    Directory, where admin programs are stored. We STRONGLY recommend you to password-protect that directory after your cardshop is live !

    Web-visible URLs

    $IMG_URL
    WWW address for the directory where your images are stored. You can create subdirectories within it to organize your images.
    IMPORTANT! there is a subdirectory inside it- "upload" (chmod 777) It is used to store uploaded files. You should be checking its content occasionally and clean it up. It must be world-viewable.
    $MIDI_URL
    WWW address for the directory where your music files are stored. You can create subdirectories within it to organize your music files. It must be world-viewable.
    $SAVE_URL
    WWW address for $SAVE_PATH. You won't need to change it unless you have changed $SAVE_PATH It must be world-viewable.

    Other locations, not reflected in global config.

    $PG_DIR/backs/
    Sample background files are stored there. You can create subdirectories within it to organize your background files.
    $PG_DIR/stamps/
    Sample stamp files are stored there.
    $PG_DIR/js/
    Java-scripts used in sample composition pages are stored there. Unless you are comfortable with this scripting language better leave all these intact.
    All these directories are not mandatory, you can put their contents elsewhere, presuming you edit the links accordingly. These directories are not defined in global configuration. All must be world-viewable. You can create subdirectories within.
  2. Mail delivery setup

    All settings below can be edited using the web-based admin program in global configuration section.

    SEND_MAIL
    sendmail program location, most probably will look like /usr/lib/sendmail for Solaris and /usr/sbin/sendmail for BSD and LINUX. If you don't know where it is and what it is and still want to change it - ask your webhost for assistance.
    MODE
    notification mail delivery mode, default setting is ASAP, can be set to QUEUE mode. See detailed description in "administration" section
    DAYS
    days to send cards in advance, default setting is 30, you can set it to anything between 1 and 180
    STORED
    days to store cards, default setting is 14, you can set it to anything between 1 and 180. Be sure to check "administration" section - "Storing large amounts of card datafiles" before changing this setting.
    MX_CHECK
    verify MX record for the email address? ("yes" or "no", default is "no") Enabling this feature helps to reduce amount of bounced mails, however it could lead to some user's complaints since there are some email providers still operating without a valid MX record.
  3. Other settings

    All settings below can be edited using the web-based admin program in global configuration section.

    COOKIE_TIME
    time to store membership cookies, in milliseconds
    COOKIE_DOMAIN
    blank by default, you can setup your domain here if you are familiar with cookie functioning
    DATE_FORMAT, DAY_FORMAT
    date output in POSIX format, DATE is used to show current time in card templates, DAY is used in selection for scheduled delivery
    MAX_FILE_SIZE
    maximum size for uploaded files, in bytes
  4. Changes from version 5

    This section describes only changes from previous version, not the new features added. New features are documented in other sections of this guide. The changes are minimal.
    1. Global configuration file is renamed from magics.cfg to platinum.cfg. More configurable parameters are added.
    2. Stats are visualized with the help of new program "admin.cgi", old "report.cgi" is removed.

My Postcards Platinum c Web Application, version 6.
Copyright c 1996-2002 Webby, Inc. All rights reserved.