Mercurial Mercurial > prosody > prosody-modules / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_invites_register_web/README.markdown
author Kim Alvefur <zash@zash.se>
Fri, 11 Sep 2020 17:13:34 +0200
changeset 4108 476afcbfb3e9
parent 4097 a2116f5a7c8f
child 4109 233e170eb027
permissions -rw-r--r--
various: Add some dependency metadata
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4097
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     1
 
---
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     2
 
labels:
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     3
 
- 'Stage-Beta'
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
     4
 
summary: 'Register accounts via the web using invite tokens'
4108
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4097
diff changeset 
     5
 
rockspec:
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4097
diff changeset 
     6
 
  dependencies:
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4097
diff changeset 
     7
 
  - easy_invite
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4097
diff changeset 
     8
 
  - invites
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4097
diff changeset 
     9
 
  - invites_page
476afcbfb3e9 various: Add some dependency metadata
Kim Alvefur <zash@zash.se>
parents: 4097
diff changeset 
    10
 
  - register_apps
4097
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
    11
 
...
a2116f5a7c8f mod_invites_register_web: New module to allow web registration with an invite token
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset 
    12
 












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    13


Introduction












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    14


============












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    15














a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    16


This module is part of the suite of modules that implement invite-based












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    17


account registration for Prosody. The other modules are:












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    18














a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    19


- mod_invites












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    20


- mod_invites_adhoc












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    21


- mod_invites_page












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    22


- mod_invites_register












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    23


- mod_invites_register_web












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    24


- mod_register_apps












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    25














a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    26


For details and a full overview, start with the mod_invites documentation.












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    27














a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    28


Details












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    29


=======












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    30














a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    31


mod_invites_register_web implements a web-based registration form that












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    32


validates invite tokens. It also supports guiding the user through client












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    33


download and configuration via mod_register_apps.












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    34














a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    35


There is no specific configuration for this module (though it uses the












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    36


optional `site_name` to override the displayed site name.












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    37














a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    38


This module depends on mod_invites_page solely for the case where an invalid












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    39


invite token is received - it will redirect to mod_invites_page so that an












a2116f5a7c8f
mod_invites_register_web: New module to allow web registration with an invite token



Matthew Wild <mwild1@gmail.com>


parents: 

diff
changeset




    40


appropriate error can be served to the user.














prosody-modules