Maxscape File System Link

The symbolic link '/maxscape' points to the root directory of the Maxscape webserver installation. Because only the '/maxscape' link, instead of the absolute path is used by the Maxscape code, the actual Maxscape installation can be located under an arbitrary path (/usr/src/maxscape/3.00). The link is also useful as an entry point to change to a directory (cd /maxscape/etc).

> ln -s /opt/maxscape/3.00 /maxscape      # Link to the Maxscape distribution
> ln -s /usr/src/maxscape/3.00 /maxscape  # Link to the source installation

Maxscape Server Directory Tree

The Maxscape server root directory contains the following directories and files:


/maxscape
  README.install      Installation Description.
  README.licence      Maxscape License.
  History             History of cvs controled files and folders.
  TagFile             Cvs Tags.
  cvssh               Shell scripts around CVS.
  bin                 Administration and management scripts.
  etc                 Configuration files.
  etc/init.d          Maxscape start scripts and deamons.
  lib                 Libraries.
  local               Local data.
  man                 Manual pages.
  sbin                Maxscape management scripts and deamons.
  server              Application server root folder.
  var                 Variable files and folders like log files.
  var/home            Unix user home directories.
  ...

Configuration, Resource, Skeleton and Start/Stop Files

Most of the servers configuration files are located under the '/maxscape/etc' directory:

/maxscape/etc
  maxscape.cnf         Maxscape global Configuration File.
  analog               Configuration Directory for analog.
    analog.conf        Analog Configuration File.
    header.txt         Analog Header File.
  apache               Maxscape Apache Configuration Directory.
    httpd.conf         Apache configuration main file.
    magic              Magic data for mod_mime_magic Apache module.
    mime.types         Controls apache Internet media types.
    modules.conf       Apache Dynamic Shared Object (DSO) configuration.
    rewrite.conf       Maxscape HTTPD (apache) generic rewrite rules.
    startup.pl         Apache mod_perl startup script.
  init.d               Maxscape, Apache, Mysql, Oracle boot scripts.
    apachectl          Apache HTTPD Deamon start/stop Script.
    maxscape           Maxscape overall Startup Boot Script.
    mysql              Mysql Deamon start/stop Shell Script.
    oracle             Oracle deamon start/stop Script.
    maxscape_chat      Maxscape Chat Server start/stop Script.
    maxscape_daemon    Maxscape Process Control Daemon start/stop Script.
  profile              Global Profile for shell scripts, interac. shells.
  project              Hacks avoid platform/version specific path.
  skel                 Skeletons for Login Resource Files.
    .exrc              Maxscape init resource file for vi.
    .inputrc           .inputrc for readline lib for 'bash'.
    .pgp               Maxscape Pretty Good Privacy (PGP) User Accounts.
    .profile           Global Maxscape user account borne shell profile.
    .projectrc         cvssh resource file.
    .ssh               Secure Shell (SSH) User Account Directory.
      authorized_keys  Maxscape SSH authorized_keys.
    .tcshrc            Maxscape tcsh init recource file.
  ssleay.cnf           SSLeay configuration file.

Daemon, Administration Scripts and Binaries

Daemon and administration scripts are found under the '/maxscape/sbin' directory:

/maxscape
  init.d
    maxscape                   Maxscape start script.
    maxdaemon                  Control daemon start script.
    apachectl                  Apache start script.
    mysql.server               Mysql or Mariadb start script.
    ...
  sbin                         Deamon Binaries and Daemon Start Scripts.
    ChatServer                 Maxscape Chat Server.
    ChatServer.safe            Maxscape Chat Daemon fail safe Script.
    maxdaemon                  Maxscape Process Control Daemon.
    maxdaemon.safe             Process Control Daemon fail safe Script.

    create_db.mysql            Creates a new application server Database Instance.
    create_application_server  Creates an application server Directory Structure.
    create_users               Creates UNIX Users during the first Installation.
    install_db.mysql           Installation of a new application server Database.
    ...
  bin                          Maxscape Binaries.
    WebAdmin                   Command line Administration Server Interface
    dumpPages.pl               Dumps dynamic Pages to static HTML Pages.
    ...

Unix User Accounts

The Unix user accounts are located under the '/maxscape/var/home' directory.

/maxscape/var/home
  su        # Super user with root priviledges.
  maxscape  # Development, management and administration user.
  maxrun    # Run-time user with restricted priviledges.
  mysql     # Mysql database user account.

Application Server Directory Structure

All files, that are special to an application site, are placed under the '/maxscape/server' directory. Each application server is uniquely defined by its application server name and installed in a separate directory named '/maxscape/server/'application server name'/'.

/maxscape/server/'application server'
  bin                                 Place to put helpful scripts
  cgi-bin                             CGI scripts
  docs                                Document root of the site
  etc                                 Application  server configuration files
  lib                                 Modules and functions
  logs                                Link to the Apache log files
  tables                              Text dump of the content database

Application Libraries and Modules

Libraries and applications global to a application server should be placed under the '/maxscape/server/'application server name'/lib' directory. Although this is not mandatory, it helps to standardize the programming system. To prevent name clashes, put files in a own directory and prefix modules with this prefix (e.g. $myObject = myScape::myClass->new();).

/maxscape/lib/
  perl                                    Site global Application modules.
  perl/maXscape/SiteApplication.pm        Site global applications.
  perl/maXscape/SiteApplication/Page.pm   Site Application of the 'Page' class.
  ...

Application server global functions and modules are located under the related /maxscape/server/'your application Server'/lib directory:

/maxscape/server/'your application Server'/lib/
  perl                                    'your' Libraries.
  perl/yourScape                          'your' Libraries.
  perl/yourScape/ServerApplication.pm     'your' Applications.
  perl/yourScape/ServerConfiguration.pm   'your' Configuration.
  ...

Process local functions and modules are located under the related /maxscape/server/'your application Server'/lib/perl/Maxscape directory, as described in 'Processes' manual section.

Next ∙ Previous ∙ Top ∙ Join ∙ Contact © Maxscape