view mod_s2s_reload_newcomponent/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 4d73a1a6ba68
children
line wrap: on
line source

---
labels:
summary: |
    Module to automatically load new components when config:reload is done
    in console
...

Introduction
============

Currently, module:reload command in console doesn't load new components.
This module will automatically load the new components (if any) when the
config:reload command is run in the console.

Details
=======

In order to use the plugin, simply load the plugin by adding
"s2s\_reload\_newcomponent" to the modules enabled list. The plugin
requires configuration to be reloaded via console plugin's
config:reload() command.

Now, add a new component in the prosody configuration and then run
config:reload() command in the console plugin. The new component should
become active in prosody at this point and can be used.

Dependency
==========

Needs console plugin to reload configuration.

Compatibility
=============

  ----- -------
  0.7   works
  ----- -------