Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken or remove outdated links in docs #2183

Merged
merged 4 commits into from
Jan 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ When developing new features/modules, please make sure you add basic documentati
* [Set up MongooseICE](doc/user-guide/ICE_tutorial.md)
* [Build an iOS messaging app](doc/user-guide/iOS_tutorial.md)
* [User Guide](https://mongooseim.readthedocs.io/en/latest/user-guide/Get-to-know-MongooseIM/). Learn all about how to use MongooseIM in your project. Explore its features, supported XEPs, RFCs and database backends, as well as its architecture and deployment strategies.
* [Platform](https://mongooseim.readthedocs.io/en/latest/Roadmap/). Get to know our roadmap, MongooseIM history and see how we contribute to third-party opensource projects.
* [Configuration](https://mongooseim.readthedocs.io/en/latest/Basic-configuration/). Explore some of the available options including database backend configuration, access control lists, listener and extension modules.
* [REST API](https://mongooseim.readthedocs.io/en/latest/rest-api/Client-frontend/). Explore MongooseIM features using our REST API and [Swagger documentation](https://mongooseim.readthedocs.io/en/latest/swagger/index.html).
* [Operation and maintenance](https://mongooseim.readthedocs.io/en/latest/operation-and-maintenance/Cluster-management-considerations/). See what to consider when building, monitoring, testing and distributing MongooseIM clusters.
Expand Down
2 changes: 1 addition & 1 deletion doc/Basic-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ There are 2 types of options: params and features. Unlike params, features can b
* **Description:** Allows enabling the StartTLS feature in client-to-server XMPP connections. Just remove '%%' prefix and set path to the PEM file containing certificate and (not protected by password) private key in X.509 format.

* **zlib** - feature
* **Description:** Controls the zlib compression feature for client-to-server XMPP connections. To enable it, remove '%%' prefix. You can define a limit for output data size to prevent killing the server with [zlib bomb](http://xmpp.org/resources/security-notices/uncontrolled-resource-consumption-with-highly-compressed-xmpp-stanzas/). Set it to `unlimited` to bypass the check (**not recommended**).
* **Description:** Controls the zlib compression feature for client-to-server XMPP connections. To enable it, remove '%%' prefix. You can define a limit for output data size to prevent killing the server with [zlib bomb](https://xmpp.org/community/security-notices/uncontrolled-resource-consumption-with-highly-compressed-xmpp-stanzas.html). Set it to `unlimited` to bypass the check (**not recommended**).
101 changes: 0 additions & 101 deletions doc/Roadmap.md

This file was deleted.

2 changes: 1 addition & 1 deletion doc/advanced-configuration/Listener-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You only need to declare running `ejabberd_c2s`, to have the other 2 modules sta
* `starttls_required` (default: disabled) - enforces StartTLS usage.
* `tls` (default: disabled) - When this option is set, clients must initiate a TLS session immediately after connecting, before beginning the normal XML stream.
* `tls_module` (atom, default: `fast_tls`) - Provides a TLS library to use. `fast_tls` uses OpenSSL-based NIFs, while `just_tls` uses Erlang TLS implementation provided by OTP. They are fully interchangeable, with some exceptions (`ejabberd_c2s` options supported by only one of them are explicitly described, e.g. `crlfiles`).
* `zlib` (atom or a positive integer, default: disabled) - Enables ZLIB support, the integer value is a limit for a decompressed output size (to prevent successful [ZLIB bomb attack](http://xmpp.org/resources/security-notices/uncontrolled-resource-consumption-with-highly-compressed-xmpp-stanzas/)); the limit can be disabled with an atom 'unlimited'.
* `zlib` (atom or a positive integer, default: disabled) - Enables ZLIB support, the integer value is a limit for a decompressed output size (to prevent successful [ZLIB bomb attack](https://xmpp.org/community/security-notices/uncontrolled-resource-consumption-with-highly-compressed-xmpp-stanzas.html)); the limit can be disabled with an atom 'unlimited'.
* `ciphers` (string, default: as of OpenSSL 1.0.2 it's `ALL:!EXPORT:!LOW:!aNULL:!eNULL:!SSLv2` [(source)](https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER_STRINGS)) - cipher suites to use with StartTLS.
Please refer to the [OpenSSL documentation](http://www.openssl.org/docs/man1.0.2/apps/ciphers.html) for the cipher string format.
* `access` (atom, default: `c2s`) - Access Rule to use for C2S connections.
Expand Down
2 changes: 1 addition & 1 deletion doc/advanced-configuration/Modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Serves as a storage for crypto keys for `mod_auth_token`.
Implements [XEP-0012: Last Activity)](http://xmpp.org/extensions/xep-0012.html) for communicating information about the last activity associated with an XMPP entity (most recent presence information from an offline contact).

### [mod_mam](../modules/mod_mam.md)
Implements [XEP-0313: Message Archive Management](http://xmpp.org/extensions/attic/xep-0313.html) ([current version](http://xmpp.org/extensions/xep-0313.html)), that defines a protocol to query and control an archive of messages stored on a server.
Implements [XEP-0313: Message Archive Management](http://xmpp.org/extensions/xep-0313.html), that defines a protocol to query and control an archive of messages stored on a server.

### [mod_muc](../modules/mod_muc.md)
Implements [XEP-0045: Multi-User Chat)](http://xmpp.org/extensions/xep-0045.html), for a featureful multi-user text chat (group chat), whereby multiple XMPP users can exchange messages in the context of a chat room.
Expand Down
2 changes: 1 addition & 1 deletion doc/developers-guide/xep_tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ You can copy-paste the content of this file to your main README file.
[XEP-0138: Stream Compression](http://www.xmpp.org/extensions/xep-0138.html) | [XEP-0157: Contact Addresses for XMPP Services](http://www.xmpp.org/extensions/xep-0157.html) | [XEP-0160: Best Practices for Handling Offline Messages](http://www.xmpp.org/extensions/xep-0160.html) | [XEP-0170: Recommended Order of Stream Feature Negotiation](http://www.xmpp.org/extensions/xep-0170.html) |
[XEP-0175: Best Practices for Use of SASL ANONYMOUS](http://www.xmpp.org/extensions/xep-0175.html) | [XEP-0198: Stream Management](http://www.xmpp.org/extensions/xep-0198.html) | [XEP-0199: XMPP Ping](http://www.xmpp.org/extensions/xep-0199.html) | [XEP-0202: Entity Time](http://www.xmpp.org/extensions/xep-0202.html) |
[XEP-0206: XMPP Over BOSH](http://www.xmpp.org/extensions/xep-0206.html) | [XEP-0212: XMPP Basic Server 2008](http://www.xmpp.org/extensions/xep-0212.html) | [XEP-0237: Roster Versioning](http://www.xmpp.org/extensions/xep-0237.html) | [XEP-0279: Server IP Check](http://www.xmpp.org/extensions/xep-0279.html) |
[XEP-0280: Message Carbons](http://www.xmpp.org/extensions/xep-0280.html) | [XEP-0313: Message Archive Management](http://xmpp.org/extensions/attic/xep-0313-0.2.html) |
[XEP-0280: Message Carbons](http://www.xmpp.org/extensions/xep-0280.html) | [XEP-0313: Message Archive Management](http://xmpp.org/extensions/xep-0313.html) |
2 changes: 1 addition & 1 deletion doc/modules/mod_bosh.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Module Description
This module implements [XEP-0206: XMPP Over BOSH](http://xmpp.org/extensions/xep-0206.html) (using [XEP-0124: Bidirectional-streams Over Synchronous HTTP (BOSH)](http://xmpp.org/extensions/xep-0124.html)), allowing clients to connect to MongooseIM over regular HTTP long-lived connections.

If you want to use BOSH, you must enable it both in the `listen` section of `mongooseim.cfg` ([Listener-Modules](wiki/Listener-Modules)) and as a module.
If you want to use BOSH, you must enable it both in the `listen` section of `mongooseim.cfg` ([Listener Modules](../advanced-configuration/Listener-modules.md)) and as a module.

### Options

Expand Down
2 changes: 1 addition & 1 deletion doc/open-extensions/token-reconnection.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This extension requires the client application to authenticate to the XMPP serve

After that, the following authentications may be done using X-OAUTH SASL mechanism with a token obtained from the server.

To enable the feature, modules `mod_auth_token` and `mod_keystore` have to be enabled on the server. For more details regarding the configuration see [mod_auth_token documentation](../modules/mod_auth_token) and [mod_keystore](module/mod_keystore).
To enable the feature, modules `mod_auth_token` and `mod_keystore` have to be enabled on the server. For more details regarding the configuration see [mod_auth_token documentation](../modules/mod_auth_token.md) and [mod_keystore](../modules/mod_keystore.md).

# Token types

Expand Down
2 changes: 1 addition & 1 deletion doc/user-guide/Features-and-supported-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
|0270|[XMPP Advanced Server 2010](http://xmpp.org/extensions/xep-0270.html)||
|0279|[Server IP Check](http://xmpp.org/extensions/xep-0279.html)|`mod_sic`|
|0280|[Message Carbons](http://xmpp.org/extensions/xep-0280.html)|`mod_carboncopy`|
|0313|[Message Archive Management](http://xmpp.org/extensions/attic/xep-0313.html)|`mod_mam`|
|0313|[Message Archive Management](http://xmpp.org/extensions/xep-0313.html)|`mod_mam`|
|0352|[Client State Indication](http://www.xmpp.org/extensions/xep-0352.html)|`mod_csi`|
|0357|[Push Notifications](http://www.xmpp.org/extensions/xep-0357.html)|`mod_event_pusher_push`|
|0363|[HTTP File Upload](https://xmpp.org/extensions/xep-0363.html)|`mod_http_upload`|
Expand Down
19 changes: 10 additions & 9 deletions doc/user-guide/ICE_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ docker run -it --net=host -e "MONGOOSEICE_UDP_RELAY_IP=1.1.1.1" -e "MONGOOSEICE_

This command starts the [MongooseICE](https://github.com/esl/MongooseICE) server in the Docker container, attaching its virtual network interface to the network interface of the host machine the Docker deamon is running on.
There are three important configuration options we have to set via environment variables:
* **MONGOOSEICE\_UDP\_RELAY\_IP** - This is the IP address that [MongooseICE](https://github.com/esl/MongooseICE) provides data relay on.
This should be set to public IPv4 address.

* **MONGOOSEICE\_UDP\_RELAY\_IP** - This is the IP address that [MongooseICE](https://github.com/esl/MongooseICE) provides data relay on. This should be set to public IPv4 address.
* **MONGOOSEICE\_STUN\_SECRET** - This is a secret password that TURN clients need to provide to connect to this server.
* **MONGOOSEICE\_UDP\_REALM** - This is just a name for your TURN relay.

Expand All @@ -122,16 +122,15 @@ If you don't want to compile this application from source, you can just install
Right after you start [Mangosta-Android] for the first time, you will need to login to your XMPP server.
In order to do that, just enter the JID you have created for the phone (*[email protected]*), the password (*xmpp_password*) and the server address (*2.2.2.2* or *myxmpp.com* if you've set up the domain to actually point to this IP address), and then confirm by clicking "Enter".

<img src="ICE_tutorial/mangosta_login.png" width="25%">
![Mangosta login][mangosta_login]

After we log in, we can start setting up the connection to the [MongooseICE](https://github.com/esl/MongooseICE) server we set up before.
The process is shown on the screenshots below.

<img src="mangosta_ice_settings_1.png" width="30%">
<img alt="Mangosta test ICE connection" src="mangosta_ice_settings_2.png" width="30%">
<img alt="Mangosta save ICE settings" src="mangosta_ice_settings_3.png" width="30%">
![Mangosta ICE settings][mangosta_ice_settings]

On the "*Configure ICE*" screen we have to set 5 fields up:

* **TURN server address** - IPv4 address of our [MongooseICE](https://github.com/esl/MongooseICE)
* **TURN Server port** - since we did not set the port while configuring [MongooseICE](https://github.com/esl/MongooseICE) it uses a default one - **3478**
* **TURN Realm** - Realm name we have set via *MONGOOSEICE\_UDP\_REALM* variable. In our case it's "*myrelay*".
Expand Down Expand Up @@ -194,9 +193,7 @@ Now we finally can get out phone and start streaming the video!
In order to do that, we have to click the "*New video stream*" button as shown on the screenshots below, enter the JID of the RaspberryPi and confirm with the "*Stream!*" button.


<img alt="Mangosta start streaming" src="mangosta_start_stream_1.png" width="30%">
<img alt="Mangosta start streaming" src="mangosta_start_stream_2.png" width="30%">
<img alt="Mangosta start streaming" src="mangosta_start_stream_3.png" width="30%">
![Mangosta start streaming][mangosta_streaming]

Hopefully, now you can see the video on your own mobile device.

Expand All @@ -210,3 +207,7 @@ Hopefully, now you can see the video on your own mobile device.
[ffmpeg]: https://ffmpeg.org
[ice_demo_client]: https://github.com/esl/ice_demo
[h264_sample_video]: https://drive.google.com/file/d/0B48g-HBQ5xpxeVlUSks2bVRlLTQ/view?usp=sharing
[mangosta_login]: ICE_tutorial/mangosta_login.png
[mangosta_ice_settings]: ICE_tutorial/mangosta_ice_settings.png
[mangosta_streaming]: ICE_tutorial/mangosta_start_stream.png

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified doc/user-guide/ICE_tutorial/mangosta_login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
6 changes: 2 additions & 4 deletions doc/user-guide/release_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@

It's now possible to install MongooseIM from source in two modes:

* `system` - it's internally used to generate RPM packages
* `system` - it's used internally to generate Linux packages (.deb, .rpm)
* `user` - which is the default mode and used for testing on travis and
in development

An environment for building (as of now just RPM) packages is accessible by
cloning ESL-internal
[command line interface](https://gitlab.erlang-solutions.com/current-projects/necromancer-cli).
You can also build OS specific packages by using the tools in `[MongooseIM repo root]/tools/pkg` - refer to `README.md` therein.

### Configure script

Expand Down
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ pages:
- Migration Guide:
- '3.1.1 to 3.2.0': 'migrations/3.1.1_3.2.0.md'
- Platform:
- 'Roadmap': 'Roadmap.md'
- 'Contributions to ecosystem': 'Contributions.md'
- 'Differentiators': 'Differentiators.md'
- 'History': 'History.md'
Expand Down