---
name: "OpenGuides::Config"
section: "3pm"
platform: "linux"
package: "openguides"
version: "0.84-1.1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/OpenGuides::Config"
---

# OpenGuides::Config(3pm)

Handle OpenGuides configuration variables.

## NAME

OpenGuides::Config - Handle OpenGuides configuration variables.

## DESCRIPTION

Does config stuff for OpenGuides.  Distributed and installed as part of the OpenGuides project, not intended for independent installation. This documentation is probably only useful to OpenGuides developers.

## METHODS

- **new**

  ```
    my $config = OpenGuides::Config->new( file => "wiki.conf" );
  ```

  Initialises itself from the config file specified and environment variables of the form OPENGUIDES\_CONFIG\_READ\_ONLY.  Variables which are not set in that file, and which have sensible defaults, will be initialised as described below in ACCESSORS; others will be given a value of `"undef"`.

  ```
    my $config = OpenGuides::Config->new( vars => { dbname => "foo" } );
  ```

  As above but gets variables from a supplied hashref instead.

## ACCESSORS

Each of the accessors described below is read-write.  Additionally, for each of them, there is also a read-write accessor called, for example, `"dbname__qu"`.  This will contain an English-language question suitable for asking for a value for that variable.  You shouldn't write to them, but this is not enforced.

The defaults mentioned below are those which are applied when `"->new"` is called, to variables which are not supplied in the config file.

- •

  dbname

- •

  dbuser

- •

  dbpass

- •

  dbhost

- •

  dbport

- •

  dbencoding

- •

  script\_name (default: `"wiki.cgi"`)

- •

  install\_directory (default: `"/usr/lib/cgi-bin/openguides/"`)

- •

  script\_url (this is constrained to always end in `"/"`)

- •

  custom\_lib\_path

- •

  use\_plucene (default: true)

- •

  use\_lucy (default: false)

- •

  search\_content\_munger\_module

- •

  indexing\_directory (default: `"/usr/lib/cgi-bin/openguides/indexes"`)

- •

  enable\_page\_deletion (default: false)

- •

  admin\_pass (default: `"Change This!"`)

- •

  stylesheet\_url

- •

  site\_name (default: `"Unconfigured OpenGuides site"`)

- •

  navbar\_on\_home\_page (default: true)

- •

  recent\_changes\_on\_home\_page (default: true)

- •

  random\_page\_omits\_locales (default: false)

- •

  random\_page\_omits\_categories (default: false)

- •

  content\_above\_navbar\_in\_html (default: false)

- •

  home\_name (default: `"Home"`)

- •

  site\_desc (default: `"A default configuration of OpenGuides"`)

- •

  default\_city (default: `"London"`)

- •

  default\_country (default: `"United Kingdom"`)

- •

  default\_language (default: `"en"`)

- •

  http\_charset

- •

  contact\_email

- •

  formatting\_rules\_node (default: `"Text Formatting Examples"`)

- •

  formatting\_rules\_link (default: `"http://openguides.org/text_formatting"`

- •

  backlinks\_in\_title (default: false)

- •

  geo\_handler (default: `1`)

- •

  ellipsoid (default: `"WGS-84"`)

- •

  use\_leaflet

- •

  gmaps\_api\_key

- •

  centre\_long

- •

  centre\_lat

- •

  default\_gmaps\_zoom

- •

  default\_gmaps\_search\_zoom

- •

  show\_gmap\_in\_node\_display

- •

  force\_wgs84

- •

  google\_analytics\_key

- •

  licence\_name

- •

  licence\_url

- •

  licence\_info\_url

- •

  spam\_detector\_module

- •

  host\_checker\_module

- •

  custom\_macro\_module

- •

  static\_path

- •

  static\_url (this is constrained to always end in `"/"`)

- •

  send\_moderation\_notifications

- •

  moderate\_whitelist

- •

  website\_link\_max\_chars (default: `25`)

- •

  read\_only

- •

  responsive

## AUTHOR

The OpenGuides Project (openguides-dev@lists.openguides.org)

## COPYRIGHT

```
     Copyright (C) 2004-2020 The OpenGuides Project.  All Rights Reserved.
```

The OpenGuides distribution is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

## SEE ALSO

OpenGuides