Where is out-of-source module's `module.conf` syntax documented? (e.g. `mod_freetdm|https://github...`)

toraritte · August 31, 2024, 10:41pm

I found these modules.conf snippets that I haven’t seen before, and I’m wondering where it is documented and if there are other rules that I don’t know of?

github.com

signalwire/freeswitch/blob/94b8ebaea7b03b3b23c2ffbe51ff3ea6589944f5/build/modules.conf.in#L170


      
          #say/mod_say_zh
          #timers/mod_posix_timer
          #timers/mod_timerfd
          xml_int/mod_xml_cdr
          #xml_int/mod_xml_curl
          #xml_int/mod_xml_ldap
          #xml_int/mod_xml_radius
          xml_int/mod_xml_rpc
          xml_int/mod_xml_scgi
          
          #mod_freetdm|https://github.com/freeswitch/freetdm.git -b master
          
          ## Experimental Modules (don't cry if they're broken)
          #../../contrib/mod/xml_int/mod_xml_odbc

and

mod_kazoo|https://github.com/freeswitch/mod_kazoo.git -b master

I started digging into the source to figure it out, but I’m taking a break after not having been able to find much in the span of an hour. As far as I can tell, bootstrap.sh hasn’t got much to do with parsing modules.conf. The parts that I found relevant(?) in conifigure.ac and Makefile.am are the ones below, but these would never touch the source URL:

github.com

signalwire/freeswitch/blob/94b8ebaea7b03b3b23c2ffbe51ff3ea6589944f5/configure.ac#L2300-L2311


      
          CONF_MODULES='$$(grep -v "\#" $(switch_builddir)/modules.conf | sed "s/|.*//" | sed -e "s|^.*/||" | sort | uniq )'
          CONF_DISABLED_MODULES='$$(grep "\#" $(switch_builddir)/modules.conf | grep -v "\#\#" | sed "s/|.*//" | sed "s/\#/\#\//"| sed -e "s|^.*/||" | sort | uniq )'
          OUR_MODS='$$(if test -z "$(MODULES)" ; then tmp_mods="$(CONF_MODULES)"; else tmp_mods="$(MODULES)" ; fi ; mods="$$(for i in $$tmp_mods ; do echo $$i-all ; done )"; echo $$mods )'
          OUR_CLEAN_MODS='$$(if test -z "$(MODULES)" ; then tmp_mods="$(CONF_MODULES)"; else tmp_mods="$(MODULES)" ; fi ; mods="$$(for i in $$tmp_mods ; do echo $$i-clean ; done )"; echo $$mods )'
          OUR_INSTALL_MODS='$$(if test -z "$(MODULES)" ; then tmp_mods="$(CONF_MODULES)"; else tmp_mods="$(MODULES)" ; fi ; mods="$$(for i in $$tmp_mods ; do echo $$i-install ; done)"; echo $$mods )'
          OUR_UNINSTALL_MODS='$$(if test -z "$(MODULES)" ; then tmp_mods="$(CONF_MODULES)"; else tmp_mods="$(MODULES)" ; fi ; mods="$$(for i in $$tmp_mods ; do echo $$i-uninstall ; done)"; echo $$mods )'
          OUR_TEST_MODS='$$(if test -z "$(MODULES)" ; then tmp_mods="$(CONF_MODULES)"; else tmp_mods="$(MODULES)" ; fi ; mods="$$(for i in $$tmp_mods ; do echo $$i-print_tests ; done )"; echo $$mods )'
          OUR_CHECK_MODS='$$(if test -z "$(MODULES)" ; then tmp_mods="$(CONF_MODULES)"; else tmp_mods="$(MODULES)" ; fi ; mods="$$(for i in $$tmp_mods ; do echo $$i-check ; done )"; echo $$mods )'
          OUR_DISABLED_MODS='$$(tmp_mods="$(CONF_DISABLED_MODULES)"; mods="$$(for i in $$tmp_mods ; do echo $$i-all ; done )"; echo $$mods )'
          OUR_DISABLED_CLEAN_MODS='$$(tmp_mods="$(CONF_DISABLED_MODULES)";  mods="$$(for i in $$tmp_mods ; do echo $$i-clean ; done )"; echo $$mods )'
          OUR_DISABLED_INSTALL_MODS='$$(tmp_mods="$(CONF_DISABLED_MODULES)"; mods="$$(for i in $$tmp_mods ; do echo $$i-install ; done)"; echo $$mods )'
          OUR_DISABLED_UNINSTALL_MODS='$$(tmp_mods="$(CONF_DISABLED_MODULES)"; mods="$$(for i in $$tmp_mods ; do echo $$i-uninstall ; done)"; echo $$mods )'

github.com

signalwire/freeswitch/blob/94b8ebaea7b03b3b23c2ffbe51ff3ea6589944f5/Makefile.am#L520-L536


      
          src/mod/modules.inc: $(switch_builddir)/modules.conf
          	@echo "OUR_MODULES=$(OUR_MODS)" > $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_CLEAN_MODULES=$(OUR_CLEAN_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_TEST_MODULES=$(OUR_TEST_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_CHECK_MODULES=$(OUR_CHECK_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_INSTALL_MODULES=$(OUR_INSTALL_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_UNINSTALL_MODULES=$(OUR_UNINSTALL_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_DISABLED_MODULES=$(OUR_DISABLED_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_DISABLED_CLEAN_MODULES=$(OUR_DISABLED_CLEAN_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_DISABLED_INSTALL_MODULES=$(OUR_DISABLED_INSTALL_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          	@echo "OUR_DISABLED_UNINSTALL_MODULES=$(OUR_DISABLED_UNINSTALL_MODS)" >> $(switch_builddir)/src/mod/modules.inc
          
          $(OUR_MODULES): $(switch_builddir)/modules.conf libfreeswitch.la src/mod/modules.inc
          	@set fnord $$MAKEFLAGS; amf=$$2; \
          	(cd src/mod && $(MAKE) $(AM_MAKEFLAGS) $@) \
          	   || case "$$amf" in *=*) exit 1;; *k*) fail=yes;; *) exit 1;; esac; \
          	test -z "$$fail"

I also tried looking up keywords git and clone in the FreeSWITCH repo, found a ton of utility shell scripts, so maybe one of them will be the key.

Topic		Replies	Views
Trying to install mod_event_zmq Installation	1	189	August 14, 2023
Notice to alert the Community about core api changes breaking some modules FreeSWITCH alert , update	1	369	August 11, 2024
About the Modules category Modules	0	198	July 19, 2022
Mod_console json-log-format settings Modules how-to	4	56	May 9, 2024
What is `libks` and `signalwire-c`? FreeSWITCH	1	36	August 30, 2024

Where is out-of-source module's `module.conf` syntax documented? (e.g. `mod_freetdm|https://github...`)

Related topics