prosody-modules
b1882a40c246
mod_export_skeletons/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_export_skeletons/README.md @ 4819:b1882a40c246

mod_export_skeletons: Update examples too
author Kim Alvefur <zash@zash.se>
date Fri, 10 Dec 2021 00:20:21 +0100
parent 4818:d66162e850cd
child 4821:17fbe82d4bfe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4815
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: Export message archives in sanitized minimal form for analysis
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 ---
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 Exports message archives in a format stripped from private information
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 and message content.
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 # Usage
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 prosodyctl mod_export_skeletons [options] user@host*
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 Multiple user JIDs can be given.
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 Some storage drivers such as [SQL][doc:modules:mod_storage_sql] allows
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 exporting all users at once by giving the special username `*`, i.e.
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 `prosodyctl mod_export_skeletons \*@example.com`.
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
4816
e7d1d68f0279 mod_export_skeletons: Document archive name override option
Kim Alvefur <zash@zash.se>
parents: 4815
diff changeset
18 ## Options
e7d1d68f0279 mod_export_skeletons: Document archive name override option
Kim Alvefur <zash@zash.se>
parents: 4815
diff changeset
19
4817
e8e0cb97c480 mod_export_skeletons: Fix override docs
Kim Alvefur <zash@zash.se>
parents: 4816
diff changeset
20 `--store=archive`
e8e0cb97c480 mod_export_skeletons: Fix override docs
Kim Alvefur <zash@zash.se>
parents: 4816
diff changeset
21 : For overriding the store name, e.g. for compat with `archive2` or
4816
e7d1d68f0279 mod_export_skeletons: Document archive name override option
Kim Alvefur <zash@zash.se>
parents: 4815
diff changeset
22 querying MUC archives with `muc_log`
e7d1d68f0279 mod_export_skeletons: Document archive name override option
Kim Alvefur <zash@zash.se>
parents: 4815
diff changeset
23
4815
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 `--start=timestamp`
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 : Start of time span to export in [XEP-0082] format
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 `--end=timestamp`
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 : End of time span to export in [XEP-0082] format
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 # Output
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 All content is stripped, leaving only the basic XML structure, with
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 child tags sorted.
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 Top level attributes are given special treatment since they carry
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 protocol semantics. Notably the `@to` and `@from` JIDs are replaced by
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 symbolic labels to convey what form (bare, full or host) they had. The
4818
d66162e850cd mod_export_skeletons: Generate ids based on log2 of the original length
Kim Alvefur <zash@zash.se>
parents: 4817
diff changeset
38 `@id` attribute is replaced with a string with the length based on log2
d66162e850cd mod_export_skeletons: Generate ids based on log2 of the original length
Kim Alvefur <zash@zash.se>
parents: 4817
diff changeset
39 of the original length.
4815
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 ## Example
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42
4819
b1882a40c246 mod_export_skeletons: Update examples too
Kim Alvefur <zash@zash.se>
parents: 4818
diff changeset
43 ``` xml
b1882a40c246 mod_export_skeletons: Update examples too
Kim Alvefur <zash@zash.se>
parents: 4818
diff changeset
44 <message from='full' id='xxxxx' type='chat' to='bare'><body/><x xmlns='jabber:x:oob'><url/></x></message>
b1882a40c246 mod_export_skeletons: Update examples too
Kim Alvefur <zash@zash.se>
parents: 4818
diff changeset
45 <message from='bare' id='xxxxx' type='error' to='full'><error><remote-server-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/><text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/></error></message>
b1882a40c246 mod_export_skeletons: Update examples too
Kim Alvefur <zash@zash.se>
parents: 4818
diff changeset
46 <message from='full' id='xxxxx' type='chat' to='bare'><body/><x xmlns='jabber:x:oob'><url/></x></message>
b1882a40c246 mod_export_skeletons: Update examples too
Kim Alvefur <zash@zash.se>
parents: 4818
diff changeset
47 <message from='full' id='xxxxxx' type='normal' to='bare'><x xmlns='jabber:x:conference'/></message>
4815
9c2af2146ee2 mod_export_skeletons: Command to aid in analysis of archive contents
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 ```