1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
Configuration
=============
General settings
----------------
INVITATION_EXPIRY
*****************
Setting name: ``INVITATIONS_INVITATION_EXPIRY``
Type: Integer
Default: 3
How many days before the invitation expires.
----
CONFIRM_INVITE_ON_GET
*********************
Setting name: ``INVITATIONS_CONFIRM_INVITE_ON_GET``
Type: Boolean
Default: True
If confirmations can be accepted via a `GET` request.
----
ACCEPT_INVITE_AFTER_SIGNUP
**************************
Setting name: ``INVITATIONS_ACCEPT_INVITE_AFTER_SIGNUP``
Type: Boolean
Default: False
If ``True``, invitations will be accepted after users finish signup.
If ``False``, invitations will be accepted right after the invitation link is clicked.
Note that this only works with Allauth for now, which means `ACCOUNT_ADAPTER` has to be
``invitations.models.InvitationsAdapter``.
----
GONE_ON_ACCEPT_ERROR
********************
Setting name: ``INVITATIONS_GONE_ON_ACCEPT_ERROR``
Type: Boolean
Default: True
If `True`, return an HTTP 410 GONE response if the invitation key
is invalid, or the invitation is expired or previously accepted when
accepting an invite. If `False`, display an error message and redirect on
errors:
* Redirects to `INVITATIONS_SIGNUP_REDIRECT` on an expired key
* Otherwise, redirects to `INVITATIONS_LOGIN_REDIRECT` on other errors.
----
ALLOW_JSON_INVITES
******************
Setting name: ``INVITATIONS_ALLOW_JSON_INVITES``
Type: Boolean
Default: False
Expose a URL for authenticated posting of invitees
----
SIGNUP_REDIRECT
***************
Setting name: ``INVITATIONS_SIGNUP_REDIRECT``
Type: String
Default: "account_signup"
URL name of your signup URL.
----
LOGIN_REDIRECT
**************
Setting name: ``INVITATIONS_LOGIN_REDIRECT``
Type: String
Default: ``LOGIN_URL`` from Django settings
URL name of your login URL.
----
ADAPTER
*******
Setting name: ``INVITATIONS_ADAPTER``
Type: String
Default: "invitations.adapters.BaseInvitationsAdapter"
Used for custom integrations. Set this to `ACCOUNT_ADAPTER` if using django-allauth.
----
EMAIL_MAX_LENGTH
****************
Setting name: ``INVITATIONS_EMAIL_MAX_LENGTH``
Type: Integer
Default: 254
If set to `None` (the default), invitation email max length will be set up to 254. Set this to an integer value to set up a custome email max length value.
----
EMAIL_SUBJECT_PREFIX
********************
Setting name: ``INVITATIONS_EMAIL_SUBJECT_PREFIX``
Type: String or None
Default: None
If set to `None` (the default), invitation email subjects will be prefixed with the name of the current Site in brackets (such as `[example.com]`). Set this to a string to for a custom email subject prefix, or an empty string for no prefix.
----
INVITATION_MODEL
****************
Setting name: ``INVITATIONS_INVITATION_MODEL``
Type: String
Default: ``invitations.Invitation``
App registry path of the invitation model used in the current project, for customization purposes.
----
INVITE_FORM
***********
Setting name: ``INVITATIONS_INVITE_FORM``
Type: String
Default: ``invitations.forms.InviteForm``
Form class used for sending invites outside admin.
----
ADMIN_ADD_FORM
**************
Setting name: ``INVITATIONS_ADMIN_ADD_FORM``
Type: String
Default: ``invitations.forms.InvitationAdminAddForm``
Form class used for sending invites in admin.
----
ADMIN_CHANGE_FORM
*****************
Setting name: ``INVITATIONS_ADMIN_CHANGE_FORM``
Type: String
Default: ``invitations.forms.InvitationAdminChangeForm``
Form class used for updating invites in admin.
----
CONFIRMATION_URL_NAME
*********************
Setting name: ``INVITATIONS_CONFIRMATION_URL_NAME``
Type: String
Default: "invitations:accept-invite"
Invitation confirmation URL
Allauth related settings
------------------------
INVITATION_ONLY
***************
Setting name: ``INVITATIONS_INVITATION_ONLY``
Type: Boolean
Default: False
If the site is invite only, or open to all (only relevant when using allauth).
|
