prosody-modules
805515dd2960
mod_invites_webgen/README.markdown

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.markdown @ 5945:805515dd2960 default tip

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