Annotate

README @ 13014:06453c564141

util.startup: Add prosody.started promise to easily execute code after startup To avoid a race where server-started fires before the promise function body is run (on next tick), I moved server-started to fire on the next tick, which seems sensible anyway. Errors are logged, I'm not sure if we ought to be doing something more here. I'm sure we'll find out.
author Matthew Wild <mwild1@gmail.com>
date Sat, 01 Apr 2023 11:56:38 +0100
parent 12223:a68f1617721b
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