FAQ

Installation

Anytime I try to access docarc.pl I get the public page.

That indicates that something's wrong with the authoritzation of your webserver (Apache). You should enable it according to Installation Notes.

How to uninstall the Mozilla/Firefox plugin (when running updates)?

I'd like some IP's to access Document Archive via password authentification, all others should only have public access.

You have to modify .htaccess in your docarc's cgi-bin directory. Insert the following lines into the <Files> section:

  Satisfy Any

  Order Allow,Deny
  Allow from all
  Deny from 192.168.1.0/24

Instead of 192.168.1.0/24 you may insert a space seperated list of IP addresses or subnets whose users should be asked for username and password.

Why do i get an "Internal Server Error" (Error 500) when accessing docarc.pl?

One of the most common reasons are missing Perl packages. Have a look at Apache's error log (eg. under /var/log/httpd/error_log or /var/log/apache/error_log). If it indicates that Apache could not find some packages, please have a look at the Installation Manual. Either you can take your distribution's packages or you have to download them from cpan.org and install them manually.

Usage

How to create subcategories?

Subcategories may be created by separating levels in the Id field with a slash, / (eg. unsorted and unsorted/foobar). Whenever the categorie's description is shown, the descriptions of the different levels are joined by "::".

How to search through the content of the uploaded document files?

Since there are already very good search engines, I do not plan to write my own one. Simply use ht://Dig to search through the whole Document Archive:

1. Create a new docarc user (maybe named `htdig') with simple layout. It's sufficient to give that user guest rights
2. Create a ht://Dig config file with start_url set to the URL of your Document Archive's docarc.pl
3. Run htdig with -c configfile and -u username:password where username and password are set according to the new docarc user
4. Run htmerge -c configfile
5. Use htsearch to search through your Document Archive

Depending on the type of documents you usualy upload into Document Archive, you should specify conversion rules in htdig.conf for using external parsers. Read more about that topic in ht://Dig configuration file manual, ht://Dig FAQ 4.8 and ht://Dig FAQ 4.9.

Since Document Archive 0.9.4 ht://Dig is somehow integrated in docarc. Have a look at Installation Notes on ht://Dig.

How to write accents in Document Archive's input fields?

There are two possibilities:

1. When adding or editing document data, you may use TeX markup if selecting TeX in the drop down box near the Submit button.
2. Write the accents directly into your browser. If you use Linux, you may use the multi-language key (multi_key, AltGr+Shift is a widely used default) to insert them. The configuration files are
   • /usr/X11R6/lib/X11/Xmodmap
   • /usr/X11R6/lib/X11/locale/iso8859-1/Compose
   • ~/.Xmodmap
   Also see man xmodmap. To insert an accent you have to hit the multi_key (eg. AltGr+Shift together), release it, press the accent and afterwards the letter. For example AltGr+Shift, ', a results in á.

Which files to include when doing a backup of all the data?

The essential files include the documents subdirectory of your Document Archive installation and MySQL's docarc database. The latter is a subdirectory of MySQL's database directory (eg. /var/lib/mysql), named like the database (docarc by default). These files include complete information about all the documents. To completely backup user information you have to copy .htpasswd from your Document Archive directory as well. Configuration of the Document Archive system itself is stored in docarc.conf. The need for other files to be copied arises only if you have changed them manually (eg. style.css from your docarc's htdocs directory). To summarize, the following files should be included in a backup (assumed docarc is installed at /srv/www/cgi-bin/docarc and /srv/www/htdocs/docarc):

Templates

When I include the script into my website via frames, it will instantly reload into the full window.

It's not a bug, it's a feature... It assures that Document Archive will be shown correctly when switching between frame (or iframe) based and the traditional layout. The important lines (ie. the ones to delete or uncomment with //) are the first two in the <script>-section of layouts/traditional/layout.html