prosody-modules
tip
mod_invites_webgen/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_invites_webgen/README.md @ 6344:eb834f754f57 draft default tip

Merge update
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Fri, 18 Jul 2025 20:45:38 +0700
parent 6277:e22c550003bb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6277
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
1 ---
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
2 labels:
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
3 - 'Stage-Alpha'
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
4 summary: 'Enable create invitations via the web'
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
5 ...
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
6
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
7 Introduction
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
8 ============
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
9
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
10 This module allows users to create new invites from the server's website.
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
11 It is quite handy when you don't have a phone with you but still want to
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
12 invite the person in front of you to chat.
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
13
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
14 Details
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
15 =======
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
16
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
17 The invitation will create account-and-contact invites (the "add to roster"
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
18 kind of invite). Once user have sucessfully enter their credential, the module
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
19 redirect them to the invite page.
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
20
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
21 It depends on these module and their purpose:
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
22
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
23 - [mod_http]: for obvious reason :).
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
24 - [mod_invites][doc:modules:mod_invites]: generate the actual invite.
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
25 - [mod_invites_register_web][doc:modules:mod_invites_register]: serve the
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
26 invite page.
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
27
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
28 Configuration
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
29 =============
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
30
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
31 The configuration utilizes the same `allow_user_invites` and
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
32 `allow_contact_invites` as [mod_invites_adhoc].
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
33
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
34 If you specify a `site_name`, it will uses that else it will fallback to the
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
35 `VirtualHost` that it was loaded onto.
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
36
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
37 After successfully enabling this module, it should be available via the default
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
38 URL:
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
39
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
40 ```lua
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
41 https://prosody.example.tld/webgen
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
42 ```
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
43
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
44 HTML templates can be overridden by using `invites_register_template_path`,
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
45 see the `html/` directory in the sources for the files needed.
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
46
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
47 Names of the files MUST match the default. More over, you can offer multiple
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
48 (human) languages by adding the `&l=` to the URL. Meaning this module will
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
49 serve `webgen.html` for your default URL:
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
50
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
51 ```lua
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
52 https://prosody.example.net/webgen?t=aowiefjoaij
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
53 ```
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
54
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
55 And the `webgen.en.html` in the directory you have specified in
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
56 your config file, it will be served at:
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
57
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
58 ```lua
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
59 https://prosody.example.net/webgen?t=aowiefjoaij&l=en
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
60 ```
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
61
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
62 So in your `webgen.html`, you can point to the English version by using an
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
63 `<a>` tag like this:
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
64
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
65 ```lua
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
66 <a href="/webgen?t={token}&l=en">English</a>
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
67 ```
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
68
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
69 You can modify the URL in your config under `http_path` with `invites_webgen`:
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
70
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
71 ```lua
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
72 http_path = {
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
73 invites_webgen = "/registration"
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
74 }
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
75 ```
e22c550003bb mod_invites_webgen: add README.md
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
76