Skip to content

Commit

Permalink
Update content from ejabberd by running "make clean extract"
Browse files Browse the repository at this point in the history
  • Loading branch information
badlop committed Dec 2, 2024
1 parent 5082cf9 commit 19e5f4d
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 32 deletions.
29 changes: 14 additions & 15 deletions content/README-GIT.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
<img src="https://img.shields.io/github/v/tag/processone/docs.ejabberd.im?sort=semver&logo=&label=docs&logoWidth=0" /></a>
</p>


[ejabberd][im] is an open-source,
robust, scalable and extensible realtime platform built using [Erlang/OTP][erlang],
that includes [XMPP][xmpp] Server, [MQTT][mqtt] Broker and [SIP][sip] Service.
Expand All @@ -41,12 +40,16 @@ Installation
There are several ways to install ejabberd:

- Source code: compile yourself, see [COMPILE](admin/install/source.md)
- Installers: [ProcessOne Download][p1download] and [GitHub Releases][releases] for releases, [GitHub Actions](https://github.com/processone/ejabberd/actions/workflows/installers.yml) for master branch (run/deb/rpm for x64 and arm64)
- `ecs` container image: [Docker Hub][hubecs] and [Github Packages][packagesecs], see [ecs README][docker-ecs-readme] (for x64)
- `ejabberd` container image: [Github Packages][packages] for releases and master branch, see [CONTAINER](CONTAINER.md) (for x64 and arm64)
- Installers:
- [ProcessOne Download Page][p1download] or [GitHub Releases][releases] for releases.
- [GitHub Actions](https://github.com/processone/ejabberd/actions/workflows/installers.yml) for master branch (`run`/`deb`/`rpm` for `x64` and `arm64`)
- Docker Containers:
- `ecs` container image: [Docker Hub][hubecs] and [Github Packages][packagesecs], see [ecs README][docker-ecs-readme] (for `x64`)
- `ejabberd` container image: [Github Packages][packages] for releases and master branch, see [CONTAINER](CONTAINER.md) (for `x64` and `arm64`)
- Using your [Operating System package][osp]
- Using the [Homebrew][homebrew] package manager

More info can be found in the `Installation` part of [ejabberd Docs](https://docs.ejabberd.im/admin/install/).

Documentation
-------------
Expand All @@ -63,7 +66,6 @@ Once ejabberd is installed, try:
ejabberdctl help
man ejabberd.yml


Development
-----------

Expand All @@ -76,6 +78,7 @@ or in your local machine as explained in [Localization][localization].
Documentation for developers is available in [ejabberd docs: Developers][docs-dev].

There are nightly builds of ejabberd, both for `master` branch and for Pull Requests:

- Installers: go to [GitHub Actions: Installers](https://github.com/processone/ejabberd/actions/workflows/installers.yml), open the most recent commit, on the bottom of that commit page, download the `ejabberd-packages.zip` artifact.
- `ejabberd` container image: go to [ejabberd Github Packages][packages]

Expand All @@ -86,7 +89,6 @@ or some other method from [ProcessOne Contact][p1contact].
For commercial offering and support, including [ejabberd Business Edition][p1home]
and [Fluux (ejabberd in the Cloud)][fluux], please check [ProcessOne ejabberd page][p1home].


Community
---------

Expand All @@ -96,13 +98,11 @@ There are several places to get in touch with other ejabberd developers and admi
- [GitHub Discussions][discussions]
- [Stack Overflow][stackoverflow]


License
-------

ejabberd is released under the GNU General Public License v2 (see [COPYING](COPYING.md)),
and [ejabberd translations](https://github.com/processone/ejabberd-po/) under MIT License.

- `ejabberd` is released under the __GNU General Public License v2__ (see [COPYING](COPYING.md))
- [ejabberd translations](https://github.com/processone/ejabberd-po/) under __MIT License__.

[discussions]: https://github.com/processone/ejabberd/discussions
[docker-ecs-readme]: https://github.com/processone/docker-ejabberd/tree/master/ecs#readme
Expand All @@ -119,16 +119,15 @@ and [ejabberd translations](https://github.com/processone/ejabberd-po/) under MI
[mqtt]: https://mqtt.org/
[muc]: xmpp:[email protected]
[osp]: https://docs.ejabberd.im/admin/install/os-package/
[p1contact]: https://www.process-one.net/en/company/contact/
[p1download]: https://www.process-one.net/en/ejabberd/downloads/
[p1home]: https://www.process-one.net/en/ejabberd/
[p1contact]: https://www.process-one.net/contact/
[p1download]: https://www.process-one.net/download/ejabberd/
[p1home]: https://www.process-one.net/ejabberd/
[packages]: https://github.com/processone/ejabberd/pkgs/container/ejabberd
[packagesecs]: https://github.com/processone/docker-ejabberd/pkgs/container/ecs
[releases]: https://github.com/processone/ejabberd/releases
[sip]: https://en.wikipedia.org/wiki/Session_Initiation_Protocol
[stackoverflow]: https://stackoverflow.com/questions/tagged/ejabberd?sort=newest
[weblate]: https://hosted.weblate.org/projects/ejabberd/ejabberd-po/
[xeps]: https://www.process-one.net/en/ejabberd/protocols/
[xeps]: https://www.process-one.net/ejabberd-features/
[xmpp]: https://xmpp.org/
[xmppej]: https://xmpp.org/software/servers/ejabberd/

10 changes: 7 additions & 3 deletions content/admin/configuration/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ search:

# Modules Options

> This section describes modules options of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). The modules
that changed in this version are marked with 🟤.
!!! info "Please note"

This section describes modules options of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md).

The modules that changed in this version are marked with 🟤.

mod\_adhoc
----------
Expand Down Expand Up @@ -1192,7 +1195,8 @@ mod\_matrix\_gw
<!-- md:version added in [24.02](../../archive/24.02/index.md) -->


[Matrix](https://matrix.org/) gateway.
[Matrix](https://matrix.org/) gateway. Erlang/OTP 25 or higher is
required to use this module.

__Available options:__

Expand Down
7 changes: 5 additions & 2 deletions content/admin/configuration/toplevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ search:

# Top-Level Options

> This section describes top level options of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). The options
that changed in this version are marked with 🟤.
!!! info "Please note"

This section describes top level options of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md).

The options that changed in this version are marked with 🟤.

## access\_rules

Expand Down
20 changes: 10 additions & 10 deletions content/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ support platforms, the best being [Stack Overflow][stackoverflow].

Stack Overflow is a much better place to ask questions since:

- there are thousands of people willing to help on Stack Overflow
- questions and answers stay available for public viewing so your question / answer might help
* there are thousands of people willing to help on Stack Overflow
* questions and answers stay available for public viewing so your question / answer might help
someone else
- Stack Overflow's voting system assures that the best answers are prominently visible.
* Stack Overflow's voting system assures that the best answers are prominently visible.

To save your and our time, we will systematically close all issues that are requests for general
support and redirect people to the section you are reading right now.

Other channels for support are:
- ejabberd XMPP room: [[email protected]][muc]
- [ejabberd XMPP room logs][logs]
- [ejabberd Mailing List][list]

* ejabberd XMPP room: [[email protected]][muc]
* [ejabberd Mailing List][list]

### Found an Issue or Bug?

Expand Down Expand Up @@ -80,6 +80,7 @@ Before you submit your pull request consider the following guidelines:
```shell
git checkout -b my-fix-branch master
```

* Test your changes and, if relevant, expand the automated test suite.
* Create your patch commit, including appropriate test cases.
* If the changes affect public APIs, change or add relevant [documentation][doc-repo].
Expand All @@ -88,6 +89,7 @@ Before you submit your pull request consider the following guidelines:
```shell
git commit -a
```

Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

* Push your branch to GitHub:
Expand Down Expand Up @@ -128,22 +130,20 @@ That's it! Thank you for your contribution!
Upon submitting a Pull Request, we will ask you to sign our CLA if you haven't done
so before. It's a quick process, we promise, and you will be able to do it all online
You can read [ProcessOne Contribution License Agreement][cla] in PDF.
Here's a link to the [ProcessOne Contribution License Agreement][cla].

This is part of the legal framework of the open-source ecosystem that adds some red tape,
but protects both the contributor and the company / foundation behind the project. It also
gives us the option to relicense the code with a more permissive license in the future.

[coc]: https://github.com/processone/ejabberd/blob/master/CODE_OF_CONDUCT.md
[stackoverflow]: https://stackoverflow.com/questions/tagged/ejabberd?sort=newest
[list]: https://lists.jabber.ru/mailman/listinfo/ejabberd
[muc]: xmpp:[email protected]
[logs]: https://process-one.net/logs/[email protected]/
[github]: https://github.com/processone/ejabberd
[github-issues]: https://github.com/processone/ejabberd/issues
[github-new-issue]: https://github.com/processone/ejabberd/issues/new
[github-pr]: https://github.com/processone/ejabberd/pulls
[doc-repo]: https://github.com/processone/docs.ejabberd.im
[developer-setup]: https://docs.ejabberd.im/developer/
[cla]: https://www.process-one.net/resources/ejabberd-cla.pdf
[cla]: https://cla.process-one.net/
6 changes: 5 additions & 1 deletion content/developer/ejabberd-api/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ search:

# API Reference

> This section describes API commands of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). The commands that changed in this version are marked with 🟤.
!!! info "Please note"

This section describes API commands of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md).

The commands that changed in this version are marked with 🟤



Expand Down
4 changes: 3 additions & 1 deletion content/developer/ejabberd-api/admin-tags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# API Tags

> This section enumerates the API tags of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md).
!!! info "Please note"

This section enumerates the API tags of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md).



Expand Down

0 comments on commit 19e5f4d

Please sign in to comment.