Mercurial > prosody-modules

annotate mod_muc_cache_media/README.md @ 6559:228859ea4781

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_members_json: do not automatically unban entities This would otherwise serve to evade temporary bans.
author Jonas Schäfer <jonas@wielicki.name>
date Sat, 06 Jun 2026 08:40:31 +0200
parents c25b98d42ed0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6412
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
1 ---
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
2 labels:
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
3 - 'Stage-Alpha'
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
4 summary: 'Cache media sent to a MUC'
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
5 ---
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
6
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
7 Introduction
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
8 ============
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
9
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
10 This checks for media coming in to the MUC (currently just in the form of OOB
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
11 or SIMS) and then downloads it to a local cache to be served from instead.
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
12
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
13 This saves privacy leaks for senders (leaking their domains) and to some extent
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
14 for receivers (who probably trust the MUC more than arbitraty participants in
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
15 it).
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
16
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
17 When a message is moderated, any associated media is deleted from the cache.
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
18
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
19 This does not use Prosody's internal HTTP server and assumes you will serve the
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
20 folder of static files somehow.
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
21
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
22 Files which cannot be cached (due to HTTP errors or limits below) will be passed
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
23 through still with the original URL unchanged by default.
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
24
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
25 Configuration
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
26 =============
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
27
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
28 `muc_media_store_path` : the path on disk where to store media files
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
29 `muc_media_public_base` : the base URI where you will serve the media
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
30 `muc_media_max_size` : the maximum size of file to cache
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
31
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
32 Compatibility
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
33 =============
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
34
c25b98d42ed0 mod_muc_cache_media: Initial commit
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
35 Requires Prosody 13.0 or higher.