Configuration

1. Use the Bibwiki preferences page

You can either edit the file   BibwikiSettings.php   directly or use the Bibwiki preferences page to configure Bibwiki. But not everyone can view or change the Bibwiki preferences: You have to access from IP address 127.0.0.1 and you have to be logged in as a member of the group 'sysop'.

If you want to allow another IP to change the settings you have to add this IP in the variable   $wgAllowEditSettingsFromIPs   in the file   BibwikiSettings.php. Example:

    $wgAllowEditSettingsFromIPs = "127.0.0.1, 230.23.23.24";

2. Amazon Access Key

To import entries from Amazon or to fetch book covers you have to obtain an Amazon Access Key and set the variable   $accesskey   to that key. You can get a free key from Amazon Web Services. The Amazon Access Key should look like this:   123ABCDEFGHIJK4L56M7.

    $accesskey = "123ABCDEFGHIJK4L56M7";
    $wgFetchAndViewBookCovers = true;

3. Paths

  • The two mandatory settings are   $wgBibPath   and   $wgDefaultBib.   $wgBibPath   is the absolute path to your bibliographies (= .bib files) and   $wgDefaultBib   is the filename of the default bibliography. Bibwiki must have write access to this file.
    Example:

       $wgBibPath = '/usr/local/teTeX/bibtex/bib';
       $wgDefaultBib = 'my.bib';
    
    
  • If you don't have a bibliography file yet, create an empty file with the ending '.bib' (e.g. default.bib) in the folder   $wgBibPath.
  • Set   $wgBackupPath   to an absolute path where Bibwiki can create backups of the bibliographies. After every change Bibwiki will copy a backup of the bibliography to this location. This is highly recommended. Bibwiki must have write access to this location.

4. Digital Documents

  • Specify an absolute path in the variable   $wgDownloadsPath   where Bibwiki can save downloaded documents. This path must be within the webserver's reach and Bibwiki must have write access.
  • Let Bibwiki know the URL to this path in   $wgDownloadsUrl.
  • Example:

       $wgDownloadsPath = '\www\htdocs\papers';
       $wgDownloadsUrl = '/papers';
    
  • Learn more about how Bibwiki handles digital documents.

5. Export

  • If you want to use the export function to create lists of references via BibTeX, you have to install BibTeX, which is part of all TeX/LaTeX distributions.
  • Set   $wgEnableExport   to   true.
  • Set   $wgBibTeXExecutable   to the location of the BibTeX executable.
  • Set   $wgTempDir   to a location (absolute path) where Bibwiki has write access and can create files for temporary use.
  • To use the export function, PHP and the webserver must be allowed to execute BibTeX via   exec(...).   Since this can lead to security leaks, this function is sometimes disabled in   php.ini.   Check the variables   disable_functions,     safe_mode   and   safe_mode_exec_dir.
  • Setting up the export function is quite cumbersome. Click here to get detailed information.

6. Restrict Editing

Set the variable   $wgRestrictEditsToBureaucrats   to   true   to restrict editing your bibliographies (changing, deleting, importing, creating) to members of the groups 'bureaucrats' and 'sysops'.