apps/README

   1 monolith/apps directory
   2 -----------------------
   3
   4 msp - monolith server pages
   5 ---------------------------
   6
   7 MSPs (".msp" files) are HTML files with additional mark-up. The main
   8 benefit is that they allow you to embed working monolith widgets into
   9 existing HTML pages.
  10
  11 The current implementation of MSPs should be regarded as very much
  12 "version 0.1". We will probably rewrite it from scratch when we have
  13 time to use something which looks a lot more like XML. However, the
  14 current version is usable; indeed http://www.annexia.org/ is built
  15 using MSPs.
  16
  17 The msp app contained in this directory is just a wrapper around the
  18 ml_msp widget which can be found in the ../widgets/ directory. For
  19 full documentation on writing MSP files, look at the new_ml_msp(3)
  20 manual page.
  21
  22 To use MSPs, add the following to your /etc/rws/hosts/<hostname> file:
  23
  24 begin rewrite
  25 ^/(.*\.msp)$    /so-bin/msp.so?page=$1  last,qsa
  26 ^/$             /index.msp              qsa,external
  27 ^/(.*)/$        /$1/index.msp           qsa,external
  28 end rewrite
  29
  30 msp root:       <document root directory>
  31 msp database:   dbname=<name of the database>
  32
  33 stats - monolith statistics/debugging application
  34 -------------------------------------------------
  35
  36 The stats interface allows you to browse around the internals of a
  37 running rws/monolith server, displaying structures and updating them
  38 in real time. It can be quite useful for debugging.
  39
  40 For security reasons, this application does not install itself by
  41 default. You need to manually copy the stats.so file to
  42 /usr/share/rws/so-bin, and make sure it is mode 0755. You should also
  43 consider NOT installing this on live servers - at least until rws
  44 supports access control. This is because the sensitive internal
  45 information revealed by stats might make it easier for a cracker to
  46 break into your system.
  47
  48 To run the stats application, point your browser at
  49 http://yourhostname/so-bin/stats.so . It should be self-explanatory
  50 from there on.