Update documentation and changelog
This commit is contained in:
parent
be00452782
commit
8ff55bcd14
|
@ -1,3 +1,12 @@
|
|||
# 2020-03-24
|
||||
|
||||
## Jitsi support
|
||||
|
||||
The playbook can now (optionally) install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with [Riot](docs/configuring-playbook-riot-web.md).
|
||||
|
||||
See our [Jitsi documentation page](docs/configuring-playbook-jitsi.md) to get started.
|
||||
|
||||
|
||||
# 2020-03-15
|
||||
|
||||
## Raspberry Pi support
|
||||
|
|
10
README.md
10
README.md
|
@ -56,6 +56,8 @@ Using this playbook, you can get the following services configured on your serve
|
|||
|
||||
- (optional) [Dimension](https://github.com/turt2live/matrix-dimension), an open source integrations manager for matrix clients
|
||||
|
||||
- (optional) [Jitsi](https://jitsi.org/), an open source video-conferencing platform
|
||||
|
||||
Basically, this playbook aims to get you up-and-running with all the basic necessities around Matrix, without you having to do anything else.
|
||||
|
||||
**Note**: the list above is exhaustive. It includes optional or even some advanced components that you will most likely not need.
|
||||
|
@ -144,6 +146,14 @@ This playbook sets up your server using the following Docker images:
|
|||
|
||||
- [turt2live/matrix-dimension](https://hub.docker.com/r/turt2live/matrix-dimension) - the [Dimension](https://dimension.t2bot.io/) integrations manager (optional)
|
||||
|
||||
- [jitsi/web](https://hub.docker.com/r/jitsi/web) - the [Jitsi](https://jitsi.org/) web UI (optional)
|
||||
|
||||
- [jitsi/jicofo](https://hub.docker.com/r/jitsi/jicofo) - the [Jitsi](https://jitsi.org/) Focus component (optional)
|
||||
|
||||
- [jitsi/prosody](https://hub.docker.com/r/jitsi/prosody) - the [Jitsi](https://jitsi.org/) Prosody XMPP server component (optional)
|
||||
|
||||
- [jitsi/jvb](https://hub.docker.com/r/jitsi/jvb) - the [Jitsi](https://jitsi.org/) Video Bridge component (optional)
|
||||
|
||||
|
||||
## Deficiencies
|
||||
|
||||
|
|
|
@ -31,6 +31,9 @@ matrix_riot_web_docker_image: "vectorim/riot-web:develop"
|
|||
|
||||
Then re-run the playbook: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`
|
||||
|
||||
.. and fully reload your riot-web page (at `riot.DOMAIN`).
|
||||
|
||||
Starting a video-conference in a room with more than 2 members should then create a Jitsi widget which utilizes your self-hosted Jitsi server.
|
||||
## Usage
|
||||
|
||||
You can use the self-hosted Jitsi server through Riot, through an Integration Manager like [Dimension](docs/configuring-playbook-dimension.md) or directly at `https://jitsi.DOMAIN`.
|
||||
|
||||
To use it via riot-web, make sure you've installed the `develop` version and fully reloaded your riot-web page (at `riot.DOMAIN`). Starting a video-conference in a room containing more than 2 members should then create a Jitsi widget which utilizes your self-hosted Jitsi server.
|
||||
|
|
Loading…
Reference in a new issue