diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi')
| -rw-r--r-- | data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi | 46 |
1 files changed, 42 insertions, 4 deletions
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi index 03eef9ff..4e833b9b 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi +++ b/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi @@ -25,6 +25,44 @@ 1~search_cgi Introduction +2~ Setup search form + +You will need a web server, httpd with cgi enabled, and a postgresql database to which you are able to create databases. + +Setup postgresql, make sure you are able to create and write to the database, e.g.: + +``` code +sudo su postgres + createuser -d -a ralph +``` + +You then need to create the database that sisu will use, for sisu manual in the directory manual/en for example, (when you try to populate a database that does not exist sisu prompts as to whether it exists): + +``` code +createdb SiSUv6a_manual +``` + +SiSU is then able to create the required tables that allow you to populate the database with documents in the directory for which it has been created: + +``` code +sisu --pg --createall -v +``` + +You can then start to populate the database, in this example with a single document: + +``` code +sisu --pg --update -v en/sisu_manual.ssm +``` + +To create a sample search form, from within the same directory run: + +``` code +sisu --sample-search-form --db-pg +``` +and copy the resulting cgi form to your cgi-bin directory + +A sample setup for nginx is provided that assumes data will be stored under /srv/www and cgi scripts under /srv/cgi + 2~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search {~^ Sample search frontend }http://search.sisudoc.org @@ -36,7 +74,7 @@ Note you may set results either for documents matched and object number location % Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. -!_ sisu -F --webserv-webrick<br> +!_ sisu -F --webserv-webrick \\ builds a cgi web search frontend for the database created The following is feedback on the setup on a machine provided by the help command: @@ -63,13 +101,13 @@ By default, [unless otherwise specified] databases are built on a directory basi 2~ Search Form -!_ sisu -F<br> +!_ sisu -F \\ generates a sample search form, which must be copied to the web-server cgi directory -!_ sisu -F --webserv-webrick<br> +!_ sisu -F --webserv-webrick \\ generates a sample search form for use with the webrick server, which must be copied to the web-server cgi directory -!_ sisu -W<br> +!_ sisu -W \\ starts the webrick server which should be available wherever sisu is properly installed The generated search form must be copied manually to the webserver directory as instructed |