OpenGu...Config(3pm)

📦
version 0.84 · 3 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

💖 OpenGuides::Config 💖

okay bestie, gather round, because we're diving into OpenGuides::Config — that's the 3pm manual, aka the User Contributed Perl Documentation section, aka the place where Perl modules spill their whole life story. This one handles the OpenGuides config variables, and yes it is exactly as chaotic-iconic as that sounds. 🎀

✨ NAME ✨

OpenGuides::Config — bestie, it literally handles OpenGuides configuration variables. That's the whole job. That's the vibe. 💅

🌸 DESCRIPTION 🌸

It does config stuff for OpenGuides. Periodt. 💜

It's distributed and installed as part of the OpenGuides project, and it is not intended for independent installation — so don't try to adopt it and raise it on your own, it already has a family. 🫶

Real talk: this documentation is probably only useful to OpenGuides developers. If that's not you, you can still read it for fun, no gatekeeping here. ✨

🦋 METHODS 🦋

🌟 new

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

It initialises itself from the config file you specified, plus environment variables of the form OPENGUIDES_CONFIG_READ_ONLY. 🎀

Any variable that isn't set in that file but does have a sensible default gets initialised the way we describe down in ACCESSORS. Everything else? Gets a value of undef. Yeah. Not set. Blank. The void. 😭

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

Same deal as above, except it pulls the variables from a hashref you supply instead of from a file. Iconic, honestly. ✨

👑 ACCESSORS 👑

Every single accessor below is read-write. And on top of that, each one also has a read-write accessor named like dbname__qu — that one holds an English-language question suitable for asking for a value for that variable. 💅

You shouldn't write to those __qu ones, but like... nothing stops you. It's not enforced. Do with that information what you will. 🙈

The defaults mentioned below are the ones applied when ->new is called, and only to variables that weren't supplied in the config file.

  • dbname — no default listed, it just vibes.
  • dbuser — also just vibing.
  • dbpass — your lil secret. 🔒
  • dbhost — where the database lives.
  • dbport — the door number.
  • dbencoding — encoding, bestie.
  • script_name — default: "wiki.cgi"
  • install_directory — default: "/usr/lib/cgi-bin/openguides/"
  • script_url — and here's the tea: this one is constrained to always end in / ✨
  • custom_lib_path — custom lib path, as advertised.
  • use_plucene — default: true
  • use_lucy — default: false
  • search_content_munger_module — the munger. 🧚
  • indexing_directory — default: "/usr/lib/cgi-bin/openguides/indexes"
  • enable_page_deletion — default: false
  • admin_pass — default: "Change This!" (bestie. change it. no cap. 😭)
  • stylesheet_url — the drip. 💅
  • 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 — charset time.
  • contact_email — how the people reach you. 📧
  • 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 — leaflet or not, your call.
  • gmaps_api_key — the key. 🔑
  • centre_long — centre longitude, lowkey.
  • centre_lat — centre latitude, highkey.
  • default_gmaps_zoom — zoom level default.
  • default_gmaps_search_zoom — search zoom level default.
  • show_gmap_in_node_display — show it or don't.
  • force_wgs84 — force it. 💪
  • google_analytics_key — analytics key.
  • licence_name — the licence name. (British spelling, we don't make the rules. 🇬🇧)
  • licence_url — the licence URL.
  • licence_info_url — the licence info URL.
  • spam_detector_module — begone, spam. 🚫
  • host_checker_module — checks hosts, apparently.
  • custom_macro_module — macros but make them yours.
  • static_path — static path.
  • static_url — and same energy as script_url: this one is constrained to always end in / ✨
  • send_moderation_notifications — send them or nah.
  • moderate_whitelist — the whitelist, obviously.
  • website_link_max_chars — default: 25
  • read_only — read only mode, go off.
  • responsive — responsive design, slay. 📱

🌈 AUTHOR 🌈

The OpenGuides Project (openguides-dev@lists.openguides.org) — say hi, they're lovely. 🫶

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 — go read that one next, bestie, it's the main character. 👑

and that's the whole page, no crumbs left. 💅 this was documented as perl v5.32.0, dated 2021-01-30, and yeah the footer says OpenGu...Config(3pm) because apparently even the footer got shy. stay configured, bestie 🦋✨

📦 where this page comes from