Bug 7844: Plack intranet tooling for developers
[koha.git] / misc / plack / README.plack
1 Bug 7844 - plack intranet tooling for developers
2
3 koha.psgi example and plackup.sh script to run any Koha site
4 intranet or opac interface under plack with optional multi-process
5 Starman server
6
7   plackup.sh site-name [intranet]
8
9 site-name is used to find config /etc/koha/sites/site-name/koha-conf.xml
10
11 All configuration is specified in koha.psgi, which you are welcomed to edit
12 and tune according to your development needs (enable memcache, enable/disable
13 debugging modules for plack and so on).
14
15 For deployment of opac or intranet you would probably want to take a look
16 in plackup.sh and enable starman as web server (which is pre-forking server
17 written in perl) and put some web server in front of it to serve static web
18 files (e.g. ngnix, apache)
19
20 When you are happy with it, rename koha.psgi and plackup.sh it to site name
21 and save it for safe-keeping.
22
23 This commit message is included in patch as README.plack because it includes
24 useful information for people using plack for first time.
25
26 Test scenario:
27 1. install plack and dependencies, as documented at
28    http://wiki.koha-community.org/wiki/Plack
29
30 2. start ./plackup.sh sitename i[ntranet]
31
32 3. open intranet page http://localhost:5001/ and verify that it redirects
33    to http://localhost:5001/cgi-bin/koha/mainpage.pl
34
35 4. start ./plackup.sh sitename
36
37 5. open OPAC http://localhost:5000/ and verify that it redirects to
38    http://localhost:5000/cgi-bin/koha/opac-main.pl
39
40 6. next step is to take a look into koha.psgi and enable additional
41    debug modules, save file and reload page (plackup will reload
42    code automatically)