SuSE Support Database

Title: S.u.S.E. Dochost

---

Mainpage ---- Searchform ---- History ---- Versions ---- Categories ---- Contents
Deutsch
---

S.u.S.E. Dochost

Full-text search and the central documentation server

Starting with S.u.S.E.-Linux 5.2 two new packages are part of the distribution :

When used together the documentation of S.u.S.E.-Linux can be installed in a central place on a documentation server. Then it can be accessed from any desired host in the net with extended search facilities. The documentation includes the complete S.u.S.E. help system as well as the online manuals, HOWTOs etc.

There is no need for clients to store the documentation in a local place, so less disk-storage is required.

In addition ht://Dig gives access to a comfortable full-text search in the whole documentation.

Even in environments without networking facilities ht://Dig can be used for a full-text search in the documentation.

Preconditions on the documentation server

The following packages must be installed :

It is possible to run a documentations server without clients. You can then do a full text search on your local machine.

Preconditions on the client machine

Installation

The package dochost defines three new variables in /etc/rc.config :

DOC_HOST
DOC_SERVER
DOC_ALLOW
These steer the access to the documentation server as well as its configuration.

Client installation :

Simply let DOC_HOST point to the documentation server. After a call to /usr/bin/help the Web-browser then reads from the documentation server instead of just reading the local documentation. E.g.

DOC_HOST="doku.domain.top"
The value of DOC_SERVER should be "no".

Server installation :

No complete net access is required for the server installation. It can also be used if you only want to use ht://Dig locally for a full-text search.

Please set the following variables in /etc/rc.config (use the menue System administration -> Change configuration file in YaST to change them).

START_HTTPD="yes"
should be set since a precondition for the usage as a server is a running Web-server.
DOC_SERVER="yes"
This activates the configuration as a documentation server. Above all the local references of the S.u.S.E. helpsystem are then altered to be references to the server. Access via the Web server is then possible.
DOC_ALLOW="LOCAL .yourdomain.top"
In DOC_ALLOW all machines/domains are stored which should have permission to access the local man pages of the documentation server via http-rman. This entry will be written to /etc/hosts.allow to allow the access. Your local domain or a list of the machines that should have access-permission should be entred there.

If you additionally want to use the full-text search, the database in ht://Dig must be initialized first. The package dochost automatically creates a suitable configuration file for it. Currently the full-text indices have a size of around 70 MB. Thus at least this amount of space should be available below /opt/www/htdig.

Now run (as root) the following command for the initialization :

/usr/sbin/suserundig
Normally the initialization takes longer than one hour ...

Now the full-text search (available via the help system) is fully functional.

Have fun !

---

Keywords: HELP, DOC, DOCU, DOCUMENTATION

---

Categories: Documentation

---

Feedback welcome: Send Mail to rb@suse.de (Please give the following subject: SDB-ray_dochost)

---

Mainpage ---- Searchform ---- History ---- Versions ---- Categories ---- Contents
Deutsch
---

SDB-ray_dochost, Copyright SuSE GmbH, Nuremberg, Germany - Version: 05. Mar 1998
Impressum - Last generated: 24. Feb 1999 15:19:47 by maddin with sdb_gen 1.00.0