Skip to content

Commit f690c7a

Browse files
committed
Add more glossary definitions, use some of them, improve some markdown
1 parent 16446c2 commit f690c7a

File tree

6 files changed

+84
-16
lines changed

6 files changed

+84
-16
lines changed

content/admin/guide/managing.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@
22

33
## ejabberdctl
44

5-
With the `ejabberdctl` command line administration script you can
6-
execute `ejabberdctl commands` (described in the next section,
7-
[ejabberdctl Commands](#ejabberdctl-commands)) and also many general
8-
`ejabberd commands` (described in section
9-
[ejabberd Commands](#ejabberd-commands)).
10-
This means you can start, stop and perform many
11-
other administrative tasks in a local or remote ejabberd server (by
12-
providing the argument `–node NODENAME`).
5+
def:ejabberdctl
6+
: Command line administration script to start/stop ejabberd and execute API commands.
7+
8+
With `ejabberdctl` you can execute:
9+
10+
- [ejabberdctl commands](#ejabberdctl-commands)
11+
like `start` and `stop` an ejabberd server
12+
13+
- [ejabberd API commands](#ejabberd-commands)
14+
for everyday administrative tasks in your running ejabberd servers
15+
16+
`ejabberdctl` can connect to a local ejabberd server,
17+
and even remote ones if you properly set the
18+
[erlang cookie](security.md#erlang-cookie)
19+
and provide the argument `–node NODENAME`.
1320

1421
The `ejabberdctl` script can be configured in the file
1522
`ejabberdctl.cfg`. This file includes detailed information about each

content/admin/guide/mqtt/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ In summary:
2727
- You get support on solution design for real-time infrastructure and can get help choosing between XMPP and MQTT, from
2828
a vendor that has no interest in selling one protocol more than another.
2929

30-
ejabberd Business Edition offers a different clustering than eCS. Using MQTT with ejabberd Business Edition means
30+
ejabberd Business Edition offers a different clustering than [](def:eCS). Using MQTT with ejabberd Business Edition means
3131
you can leverage:
3232

33-
- The clustering engine of eBE will be used for the MQTT service. It means that you have a more scalable cluster, that supports
33+
- The clustering engine of [](def:eBE) will be used for the MQTT service. It means that you have a more scalable cluster, that supports
3434
geoclustering. With geoclustering, you can deploy a single MQTT service across different datacenters, spread in different
3535
regions. You can deploy a truly global service.
3636
- The backend integration that are supported in ejabberd Business Edition will be available in MQTT. You have no need

content/admin/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**ejabberd** is *cross-platform*, distributed, fault-tolerant, and based on open standards to achieve real-time communication.
66

7-
**ejabberd** is designed to be a *rock-solid and feature rich* XMPP server.
7+
**ejabberd** is designed to be a *rock-solid and feature rich* [](def:XMPP) server.
88

99
**ejabberd** is suitable for small deployments, whether they need to be *scalable* or not, as well as extremely large deployments.
1010

content/developer/ejabberd-api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ how to start using ejabberd's API,
1717
how to adjust it to your needs,
1818
and integrate ejabberd with your existing systems.
1919

20-
def:API command
20+
def:api command
2121
: Command defined in some ejabberd module API backend, that can be executed using some API frontend.
2222

2323
ejabberd's API currently includes over 200 API Commands,

content/get-started/index.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Meet **ejabberd**, your superpowerful messaging framework
44

5-
This web site is dedicated to help you use and develop for ejabberd XMPP messaging server.
5+
This web site is dedicated to help you use and develop for ejabberd [](def:XMPP) messaging server.
66

77
ejabberd has been in development since 2002 and is used all over the world to power the largest XMPP deployments.
88
This project is so versatile that you can deploy it and customize it for very large scale, no matter what your use case is.
@@ -33,16 +33,21 @@ Welcome to the beginning of your journey of ejabberd mastery!
3333

3434
## Options to use ejabberd
3535

36-
ejabberd can be used in different ways. The most common one is to use ejabberd Community Edition. This is the standard Open Source version that everyone loves: highly scalable and flexible.
36+
ejabberd can be used in different ways. The most common one is:
37+
38+
- [**ejabberd Community Server**](https://www.process-one.net/ejabberd/),
39+
the public Open Source version
40+
that everyone loves: highly scalable and flexible.
3741

3842
Fortunately, if you need more than just the ejabberd platform software, [ProcessOne](https://www.process-one.net/) can help you with a commercial offering. Commercial offering come in two type of packaging:
3943

40-
- **ejabberd Business Edition**, including features for large companies
44+
- [**ejabberd Business Edition**](https://www.process-one.net/ejabberd-features/)
45+
including features for large companies
4146
(enhanced geodistributed companies and mobile support to develop
4247
own, rich clients) and world-class support, that can please even the
4348
most demanding businesses, with 24/7 options.
4449

45-
- [Fluux.io](https://fluux.io) being a way to access and benefit of all the features
50+
- [**Fluux.io**](https://fluux.io) being a way to access and benefit of all the features
4651
of ejabberd Business Edition at an attractive and scalable
4752
price. Fluux.io allows you to keep control of your data thanks
4853
to integration API you can implement on your backend to become a

content/glossary.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,72 @@
44

55
---
66

7+
def:bosh
8+
: [Bidirectional-streams Over Synchronous HTTP](https://xmpp.org/about/technology-overview/#bosh): an extension for [XMPP](def:XMPP) defined in [XEP-0124](https://xmpp.org/extensions/xep-0124.html) that allows long lived connections for XMPP over HTTP.
9+
See [mod_bosh](admin/configuration/modules.md#mod_bosh).
10+
711
def:command
812
: May refer to:
913

1014
- [](def:ad-hoc command)
1115
- [](def:API command)
1216
- shell command
1317

18+
def:eBE
19+
: ejabberd Business Edition.
20+
See [Options to use ejabberd](get-started/index.md#options-to-use-ejabberd)
21+
22+
def:eCS
23+
: ejabberd Community Server, see [Options to use ejabberd](get-started/index.md#options-to-use-ejabberd)
24+
25+
def:erlang
26+
: [Erlang](https://www.erlang.org/) is a programming language used to build massively scalable soft real-time systems with requirements on high availability. Some of its uses are in telecoms, banking, e-commerce, computer telephony and instant messaging. Erlang's runtime system has built-in support for concurrency, distribution and fault tolerance.
27+
28+
def:iq
29+
: [Stanza](def:Stanza) that provides a structured request-response mechanism.
30+
31+
def:jid
32+
: [Jabber ID](https://xmpp.org/rfcs/rfc6122.html) is a unique identifier for an entity in the XMPP network (like a server, a service, an account, a chat room, ...). It consists of three parts: a local part, a domain part, and an optional resource part, formatted as `localpart@domain/resource`.
33+
34+
def:mnesia
35+
: [Mnesia](https://www.erlang.org/doc/apps/mnesia/mnesia_chap1.html) is a distributed database specifically designed for industrial-grade telecommunications applications written in Erlang. It is used by default in ejabberd as it requires no initial configuration. However, for large volumes of data, it is recommended to [setup a SQL database](admin/configuration/database.md).
36+
37+
def:muc
38+
: [Multi-User Chat](https://xmpp.org/about/technology-overview/#muc), an extension for [XMPP](def:XMPP) defined in [XEP-0045](https://xmpp.org/extensions/xep-0045.html) for multi-party information exchange whereby multiple users can exchange messages in the context of a chat room.
39+
See [mod_muc](admin/configuration/modules.md#mod_muc).
40+
1441
def:node
1542
: May refer to:
1643

1744
- disco node, see [mod_disco](admin/configuration/modules.md#mod_disco)
1845
- [](def:erlang node)
1946
- pubsub node, see [mod_pubsub](admin/configuration/modules.md#mod_pubsub)
47+
48+
def:omemo
49+
: OMEMO is an extension for [XMPP](def:XMPP) defined in [XEP-0384](https://xmpp.org/extensions/xep-0384.html) that allows end-to-end encryption between clients.
50+
51+
def:otp
52+
: [Open Telecom Platform](https://www.erlang.org/) is a set of Erlang libraries and design principles providing middle-ware to develop these systems. It includes its own distributed database, applications to interface towards other languages, debugging and release handling tools.
53+
54+
def:presence
55+
: [Stanza](def:Stanza) that provides information about network availability of an account (online, away, offline, ...).
56+
57+
def:pubsub
58+
: [Publish-Subscribe](https://xmpp.org/about/technology-overview/#pubsub), an extension for [XMPP](def:XMPP) defined in [XEP-0060](https://xmpp.org/extensions/xep-0060.html) for for generic publish-subscribe functionality.
59+
See [mod_pubsub](admin/configuration/modules.md#mod_pubsub).
60+
61+
def:roster
62+
: A list of contacts of an account, which is stored on the server, used to manage [presence](def:presence).
63+
64+
def:stanza
65+
: [XMPP](def:XMPP) packet of type `message`, `presence` or [IQ](def:IQ).
66+
67+
def:vCard
68+
: Virtual Card, an extension for [XMPP](def:XMPP) defined in [XEP-0054](https://xmpp.org/extensions/xep-0054.html) that allows to publish contact information like name, email, phone number, address, etc.
69+
See [mod_vcard](admin/configuration/modules.md#mod_vcard).
70+
71+
def:vhost
72+
: Virtual Host, a domain name served by ejabberd that corresponds to a [XMPP Domain](admin/configuration/basic.md#xmpp-domains).
73+
74+
def:xmpp
75+
: [Extensible Messaging and Presence Protocol](https://xmpp.org/about/technology-overview/): an open protocol based in XML for real-time communications.

0 commit comments

Comments
 (0)