annotate README @ 12659:c0eea4f6c739

usermanager: Add back temporary is_admin to warn about deprecated API usage Goal: Introduce role-auth with minimal disruption is_admin() is unsafe in a system with per-session permissions, so it has been deprecated. Roll-out approach: 1) First, log a warning when is_admin() is used. It should continue to function normally, backed by the new role API. Nothing is really using per-session authz yet, so there is minimal security concern. The 'strict_deprecate_is_admin' global setting can be set to 'true' to force a hard failure of is_admin() attempts (it will log an error and always return false). 2) In some time (at least 1 week), but possibly longer depending on the number of affected deployments: switch 'strict_deprecate_is_admin' to 'true' by default. It can still be disabled for systems that need it. 3) Further in the future, before the next release, the option will be removed and is_admin() will be permanently disabled.
author Matthew Wild <mwild1@gmail.com>
date Mon, 15 Aug 2022 15:25:07 +0100
parents a68f1617721b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 # Prosody IM Server
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 ## Description
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4
12223
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
5 Prosody is a server for Jabber/XMPP written in Lua. It aims to be easy to use
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
6 and light on resources. For developers, it aims to give a flexible system on
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
7 which to rapidly develop added functionality or rapidly prototype new
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
8 protocols.
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 ## Useful links
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11
7359
a5a080c12c96 Update every link to the documentation to use HTTPS
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 2665
diff changeset
12 Homepage: https://prosody.im/
a5a080c12c96 Update every link to the documentation to use HTTPS
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 2665
diff changeset
13 Download: https://prosody.im/download
a5a080c12c96 Update every link to the documentation to use HTTPS
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 2665
diff changeset
14 Documentation: https://prosody.im/doc/
9945
606b2567ff18 README: Add link to current issue tracker
Kim Alvefur <zash@zash.se>
parents: 9944
diff changeset
15 Issue tracker: https://issues.prosody.im/
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17 Jabber/XMPP Chat:
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 Address:
1391
b910ef82622d README: Update for new MUC address
Matthew Wild <mwild1@gmail.com>
parents: 1192
diff changeset
19 prosody@conference.prosody.im
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20 Web interface:
10692
a0480ee2233a README: Update link to web chat
Kim Alvefur <zash@zash.se>
parents: 9945
diff changeset
21 https://chat.prosody.im/
12223
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
22
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23 Mailing lists:
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 User support and discussion:
7359
a5a080c12c96 Update every link to the documentation to use HTTPS
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 2665
diff changeset
25 https://groups.google.com/group/prosody-users
12223
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
26
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 Development discussion:
7359
a5a080c12c96 Update every link to the documentation to use HTTPS
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 2665
diff changeset
28 https://groups.google.com/group/prosody-dev
12223
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
29
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30 ## Installation
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31
12223
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
32 See the accompanying INSTALL file for help on building Prosody from source.
a68f1617721b README: Reflow text to ~78 columns
Kim Alvefur <zash@zash.se>
parents: 10692
diff changeset
33 Alternatively see our guide at https://prosody.im/doc/install
1192
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
34
b1b42ce4f0f6 Finally add README and INSTALL files
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
35