Changeset 18739 in project


Ignore:
Timestamp:
07/07/10 19:10:13 (11 years ago)
Author:
Mario Domenech Goulart
Message:

Documentation for `qwiki-install!'

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/qwiki

    r18723 r18739  
    8181will be committing to the repository while you are setting this up).
    8282
    83 ==== Run the installation script
    84 
    85 Now you are ready to run the qwiki installation script which will
     83==== Deploy qwiki
     84
     85Now you are ready to run the qwiki installation procedure which will
    8686create an initial checkout, process all files to make a cached HTML
    8787file and create populate the search index.
    8888
    89   # qwiki-install <repos-uri> <checkout-path> <web-path>
    90 
    91 ; {{<repos-uri>}} : the URI for the subversion repository from where a copy can be checked out
    92 
    93 ; {{<checkout-path>}} : the path to where the checkout of the repository will be stored
    94 
    95 ; {{<web-path>}} : the path used by the web-server to serve wiki pages
    96 
    97 {{<checkout-path>}} and {{<web-path>}} should not overlap.
     89The best way to do that is by creating a script which sets the require
     90parameters and calls {{qwiki-install!}}.  Here's a simple example:
     91
     92<enscript highlight=scheme>
     93(use qwiki qwiki-install qwiki-svn)
     94
     95;; the URI for the subversion repository from where a copy can be
     96;; checked out
     97(qwiki-repos-uri "file:///path/to/the/repository/directory")
     98
     99;; the path to where the checkout of the repository will be stored
     100(qwiki-source-path "/path/to/the/checkout/directory")
     101
     102;; the path used by the web server to serve wiki pages
     103(qwiki-web-path "/path/to/web/server/documents/directory")
     104
     105;; install qwiki
     106(qwiki-install!)
     107</enscript>
     108
     109Here's a more complex example:
     110
     111<enscript highlight=scheme>
     112(use qwiki qwiki-install qwiki-search qwiki-menu qwiki-svn)
     113
     114;; Try to read the svnwiki user password
     115(handle-exceptions
     116 exn
     117 (begin
     118   (with-output-to-port (current-error-port)
     119     (lambda ()
     120       (print "Could not read the password file for the SVN user.  Aborting.")))
     121   (exit 1))
     122 (qwiki-repos-password
     123  (with-input-from-file "the-password-file" read-line)))
     124
     125(search-install!)
     126(menu-install!)
     127(qwiki-repos-username "the-wiki-user")
     128(qwiki-css-file "/wiki.css")
     129(qwiki-title "The wiki")
     130
     131(qwiki-repos-uri "file:///var/svn/")
     132(qwiki-source-path "/tmp/qwiki")
     133(qwiki-web-path "/var/www/spiffy/wiki")
     134
     135(qwiki-install!)
     136</enscript>
     137
     138The values for {{qwiki-source-path}} and {{qwiki-web-path}} should not
     139overlap.
    98140
    99141The exact directory locations are up to you, of course, but they will
     
    133175When you run this, your qwiki installation should be available at
    134176http://localhost:8080
     177
    135178==== Customizing Qwiki
    136179
Note: See TracChangeset for help on using the changeset viewer.