Skip to content

Add Part 9: Module Reference for bundled modules#296

Merged
briankwest merged 1 commit into
mainfrom
docs/module-reference-backfill
Jun 11, 2026
Merged

Add Part 9: Module Reference for bundled modules#296
briankwest merged 1 commit into
mainfrom
docs/module-reference-backfill

Conversation

@briankwest

Copy link
Copy Markdown
Collaborator

Summary

Back-fills per-module documentation for the ~56 bundled FreeSWITCH modules that the topical chapters did not cover — previously these were only name-dropped in the module-loading tables. Every value is verified against the module C source and the shipped conf/vanilla/ configuration, consistent with the manual's existing standard.

New section: Part 9 — Module Reference

docs/module-reference/, grouped by src/mod/ category:

Subcategory Pages
Applications 21 (mod_curl, mod_lcr, mod_nibblebill, mod_osp, mod_cidlookup, mod_avmd, mod_vmd, mod_voicemail_ivr, …)
Endpoints mod_h323, mod_opal
Dialplan Engines mod_dialplan_asterisk, mod_dialplan_directory
File Formats and Streaming mod_vlc, mod_webm, mod_imagick, mod_opusfile, mod_png, mod_shell_stream
Speech (ASR/TTS) mod_pocketsphinx, mod_tts_commandline
Events, CDR, and Logging mod_amqp, mod_erlang_event, mod_event_multicast, mod_smpp, mod_snmp, mod_fail2ban, mod_cdr_pg_csv, mod_format_cdr, mod_json_cdr, mod_odbc_cdr, mod_graylog2
Caching and Data Stores mod_hiredis, mod_memcache, mod_mongo, mod_redis
XML Interfaces and Directories mod_xml_rpc, mod_xml_scgi, mod_xml_ldap, mod_ldap
Embedded Languages mod_basic, mod_managed
(consolidated pages) Timers (mod_timerfd / mod_posix_timer), Say (all mod_say_*)

Each page documents: purpose, the module load name and default-load status, its configuration file and parameter table with a real example, the dialplan applications and API commands it registers, the channel variables it reads/sets, and any custom events.

Supporting changes

  • channel-variables.mdx — new "Module Reference Variables" index mapping the 125 module-introduced channel variables back to their Part 9 pages (core variables the modules merely read are not duplicated).
  • module-loading.mdx — the Optional Modules section now cross-references Part 9.
  • appendix-vanilla-config-map.mdx — 27 optional-module config rows now link to their Part 9 page; fixed voicemail_ivr.conf.xml (was mis-attributed to mod_voicemail / Chapter 19).

Validation

npm run build passes cleanly — all 56 pages, the catalog index, and every new internal link compile with no MDX errors or broken links.

🤖 Generated with Claude Code

Back-fill per-module documentation for the ~56 bundled FreeSWITCH modules
that the topical chapters did not cover (previously only name-dropped in the
module-loading tables). Each value is verified against the module C source
and the shipped conf/vanilla configuration.

New docs/module-reference/ section (Part 9), grouped by src/mod category:
Applications, Endpoints, Dialplan Engines, File Formats, Speech (ASR/TTS),
Events/CDR/Logging, Caching and Data Stores, XML Interfaces and Directories,
and Embedded Languages, plus consolidated Timers and Say pages. Each page
documents purpose, the module load name, its configuration file and parameters,
the dialplan applications and API commands it registers, the channel variables
it reads or sets, and any custom events.

Also:
- channel-variables.mdx: add a "Module Reference Variables" index mapping the
  125 module-introduced channel variables to their Part 9 pages.
- module-loading.mdx: cross-reference the Optional Modules section to Part 9.
- appendix-vanilla-config-map.mdx: point 27 optional-module config rows at
  their Part 9 pages and fix voicemail_ivr.conf.xml (was mis-attributed to
  mod_voicemail / Chapter 19).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@briankwest briankwest requested a review from a team as a code owner June 11, 2026 18:32
@briankwest briankwest merged commit 17c81fb into main Jun 11, 2026
1 check passed
@briankwest briankwest deleted the docs/module-reference-backfill branch June 11, 2026 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants