Mercurial > prosody-modules
view mod_reload_components/README.markdown @ 4670:1b81b7269858
mod_http_oauth2: Gracefully handle cache write failure
Would previously have thrown an error and probably returned a traceback.
This would only happen if a *lot* of authorization codes were requested
in a short interval.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 02 Sep 2021 23:06:58 +0200 |
parents | 85d04dd87f14 |
children |
line wrap: on
line source
Introduction ============ This module allows to load/unload external components after they have been added/removed to a configuration file. It is necessary to explicitly initiate a reload on Prosody either via prosodyctl reload or config:reload(). Example 1: -------- If Prosody has started with this configuration file: ``` {.lua} VirtualHost "example.com" authentication = "internal_plain" Component "a.example.com" component_secret = "a" Component "b.example.com" component_secret = "b" ``` And the file has changed manually or dynamically to: ``` {.lua} VirtualHost "example.com" authentication = "internal_plain" Component "a.example.com" component_secret = "a" Component "c.example.com" component_secret = "c" ``` Then, the following actions will occur if this module is loaded: 1. The component c.example.com will be loaded and start bouncing for authentication. 2. The component b.example.com will be unloaded and deactivated. The connection with it will not be closed, but no further actions will be executed on Prosody. Example 2: -------- If Prosody has started with this configuration file: ``` {.lua} VirtualHost "example.com" authentication = "internal_plain" Component "a.example.com" component_secret = "a" ``` And the file has changed manually or dynamically to: ``` {.lua} VirtualHost "example.com" authentication = "internal_plain" Component "a.example.com" component_secret = "a" VirtualHost "newexample.com" authentication = "internal_plain" Component "a.newexample.com" component_secret = "a" ``` Then, the following actions will occur if this module is loaded: 1. The component a.newexample.com will be loaded and start bouncing for authentication. Note that its respective VirtualHost is not loaded. Bad things may happen. Usage ===== Copy the module folder into your Prosody modules directory. Place the module between your enabled modules either into the global or a vhost section. No configuration directives are needed Info ==== - 0.9, works