Move the WebGUI 8 install docs to docs/install.txt but leave a brief

checklist in README for advanced users to quickly see what they need
to do to fire up WebGUI 8.
This commit is contained in:
Scott Walters 2011-04-27 20:02:27 -04:00
parent ae8d0cab32
commit ae64037876
2 changed files with 86 additions and 72 deletions

41
README
View file

@ -2,9 +2,19 @@ This is the PSGI branch of WebGUI8
To try this out:
0) Start from WebGUI 7.10.4 or the example .conf and create.sql that comes with WebGUI 8
1) Run testEnvironment.pl to install Plack
2) $ cd <WebGUI directory>
3) $ plackup app.psgi
2) Get a new wgd from http://haarg.org/wgd
3) $ wgd reset --upgrade
4) $ cd /data/WebGUI (or whereever you unpacked it)
5) $ rsync -r -a (or cp -a) /data/WebGUI/www/extras /data/domains/www.example.com/public/
6) $ export PERL5LIB='/data/WebGUI/lib:/data/WebGUI/t/lib'
To start it:
7) $ plackup app.psgi
See docs/install.txt for more detailed installation instructions.
Currently, the best performance is achieved via:
@ -16,33 +26,6 @@ You can benchmark your server via:
I'm currently getting 370 requests/second, whereas I'm getting 430/second on the non-PSGI WebGUI8 branch.
= INSTALL =
* Recent Perl (5.12.1 or better)
* Install ImageMagick (http://www.imagemagick.org/, compile and install the source or binary package)
* Run sbin/testEnvironment.pl as root to install Perl modules
* MySQL with a user account
* Load share/create.sql
* Copy WebGUI.conf.original to something named after the site's URL and ending in .conf,
such as www.example.com.conf and edit it, making sure to insert your site's URL and
the database connection information (dbuser, dbpass, dsn)
* wgd reset --uploads
* Continue with the UPGRADE instructions below
= UPGRADE =
* Run sbin/testEnvironment.pl. WebGUI 8 adds new dependencies.
* Update wgd. Get it from http://haarg.org/wgd, put in /data/wre/prereqs/bin/ or /usr/local/bin,
and do chmod ugo+x /data/wre/prereqs/bin/wgd to make it executable. WebGUI has a new upgrades system
for wgd to support. The old system silently ignores the new upgrade scripts.
* wgd reset --upgrade
This is needed even for new WebGUI 8 installs. The create.sql and WebGUI.conf.original are both
from 7.10.x.
* rsync -r -a (or cp -a) /data/WebGUI/www/extras /data/domains/www.example.com/public/
* export PERL5LIB='/data/WebGUI/lib:/data/WebGUI/t/lib'
Previously, this would break Apache if it were set; now it's required for the stuff plackup loads to
find the rest of WebGUI.
= ARCHITECTURE =
* The root level app.psgi file loads all the config files found and