feat(doc) revamp README
This commit is contained in:
Saúl Ibarra Corretgé
Saúl Ibarra Corretgé
parent
9a16733950
commit
d21eb59f24
118
README.md
118
README.md
|
|
@ -1,82 +1,88 @@
|
||||||
# Jitsi Meet - Secure, Simple and Scalable Video Conferences
|
# <p align="center">Jitsi Meet</p>
|
||||||
|
|
||||||
Jitsi Meet is an open-source (Apache) WebRTC JavaScript application that uses [Jitsi Videobridge](https://jitsi.org/videobridge) to provide high quality, [secure](https://jitsi.org/security) and scalable video conferences. Jitsi Meet in action can be seen at [here at the session #482 of the VoIP Users Conference](http://youtu.be/7vFUVClsNh0).
|
Jitsi Meet is a set of Open Source projects which empower users to use and deploy
|
||||||
|
video conferencing platforms with state-of-the-art video quality and features.
|
||||||
|
|
||||||
The Jitsi Meet client runs in your browser, without installing anything on your computer. You can try it out at https://meet.jit.si.
|
<hr />
|
||||||
|
|
||||||
Jitsi Meet allows for very efficient collaboration. Users can stream their desktop or only some windows. It also supports shared document editing with Etherpad.
|
<p align="center">
|
||||||
|
<img src="https://raw.githubusercontent.com/jitsi/jitsi-meet/master/readme-img1.png" width="900" />
|
||||||
|
</p>
|
||||||
|
|
||||||
**NOTE:** If you are looking for Jitsi as a Service (JaaS) please start [here](https://jaas.8x8.vc).
|
<hr />
|
||||||
|
|
||||||
## Installation
|
Amongst others here are the main features Jitsi Meet offers:
|
||||||
|
|
||||||
On the client side, no installation is necessary. You just point your browser to the URL of your deployment. This section is about installing a Jitsi Meet suite on your server and hosting your own conferencing service.
|
* Support for all current browsers
|
||||||
|
* Mobile applications
|
||||||
|
* Web and native SDKs for integration
|
||||||
|
* HD audio and video
|
||||||
|
* Content sharing
|
||||||
|
* End-to-End Encryption
|
||||||
|
* Raise hand and reactions
|
||||||
|
* Chat with private conversations
|
||||||
|
* Polls
|
||||||
|
* Virtual backgrounds
|
||||||
|
|
||||||
Installing Jitsi Meet is a simple experience. For Debian-based system, following the [quick install](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart) document, which uses the package system. You can also see a demonstration of the process in [this tutorial video](https://jitsi.org/tutorial).
|
And many more!
|
||||||
|
|
||||||
For other systems, or if you wish to install all components manually, see the [detailed manual installation instructions](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-manual).
|
## Using Jitsi Meet
|
||||||
|
|
||||||
Installation with Docker is also available. Please see the [instruction](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker).
|
Using Jitsi Meet is straightforward, as it's browser based. Head over to [meet.jit.si](https://meet.jit.si) and give it a try. It's anonymous, scalable and free to use. All browsers are supported!
|
||||||
|
|
||||||
## Download
|
Using mobile? No problem, you can either use your mobile web browser or our fully-featured
|
||||||
|
mobile apps:
|
||||||
|
|
||||||
| Latest stable release | [](https://github.com/jitsi/jitsi-meet/releases/latest) |
|
| Android | Android (F-Droid) | iOS |
|
||||||
|---|---|
|
|:-:|:-:|:-:|
|
||||||
|
| [<img src="resources/img/google-play-badge.png" height="50">](https://play.google.com/store/apps/details?id=org.jitsi.meet) | [<img src="resources/img/f-droid-badge.png" height="50">](https://f-droid.org/en/packages/org.jitsi.meet/) | [<img src="resources/img/appstore-badge.png" height="50">](https://itunes.apple.com/us/app/jitsi-meet/id1165103905) |
|
||||||
|
|
||||||
You can download Debian/Ubuntu binaries:
|
If you are feeling adventurous and want to get an early scoop of the features as they are being
|
||||||
* [stable](https://download.jitsi.org/stable/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions/))
|
developed you can also sign up for our open beta testing here:
|
||||||
* [testing](https://download.jitsi.org/testing/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions-for-testing/))
|
|
||||||
* [nightly](https://download.jitsi.org/unstable/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions-nightly/))
|
|
||||||
|
|
||||||
You can download source archives (produced by ```make source-package```):
|
|
||||||
* [source builds](https://download.jitsi.org/jitsi-meet/src/)
|
|
||||||
|
|
||||||
### Mobile apps
|
|
||||||
|
|
||||||
* [Android](https://play.google.com/store/apps/details?id=org.jitsi.meet)
|
|
||||||
|
|
||||||
[<img src="resources/img/google-play-badge.png" height="50">](https://play.google.com/store/apps/details?id=org.jitsi.meet)
|
|
||||||
|
|
||||||
* [Android (F-Droid)](https://f-droid.org/en/packages/org.jitsi.meet/)
|
|
||||||
|
|
||||||
[<img src="resources/img/f-droid-badge.png" height="50">](https://f-droid.org/en/packages/org.jitsi.meet/)
|
|
||||||
|
|
||||||
* [iOS](https://itunes.apple.com/us/app/jitsi-meet/id1165103905)
|
|
||||||
|
|
||||||
[<img src="resources/img/appstore-badge.png" height="50">](https://itunes.apple.com/us/app/jitsi-meet/id1165103905)
|
|
||||||
|
|
||||||
You can also sign up for our open beta testing here:
|
|
||||||
|
|
||||||
* [Android](https://play.google.com/apps/testing/org.jitsi.meet)
|
* [Android](https://play.google.com/apps/testing/org.jitsi.meet)
|
||||||
* [iOS](https://testflight.apple.com/join/isy6ja7S)
|
* [iOS](https://testflight.apple.com/join/isy6ja7S)
|
||||||
|
|
||||||
## Release notes
|
## Running your own instance
|
||||||
|
|
||||||
Release notes for Jitsi Meet are maintained on [this repository](https://github.com/jitsi/jitsi-meet-release-notes).
|
If you'd like to run your own Jitsi Meet installation head over to the [handbook](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-start) to get started.
|
||||||
|
|
||||||
## Development
|
We provide Debian packages and a comprehensive Docker setup to make deployments as simple as possible.
|
||||||
|
Advanced users also have the possibility of building all the components from source.
|
||||||
|
|
||||||
For web development see [here](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-web), and for mobile see [here](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile).
|
You can check the latest releases [[here](https://jitsi.github.io/handbook/docs/releases).
|
||||||
|
|
||||||
|
## Jitsi as a Service
|
||||||
|
|
||||||
|
If you like the branding capabilities of running your own instance but you'd like
|
||||||
|
to avoid dealing with the complexity of monitoring, scaling and updates, JaaS might be
|
||||||
|
for you.
|
||||||
|
|
||||||
|
[8x8 Jitsi as a Service (JaaS)](https://jaas.8x8.vc) is an enterprise-ready video meeting platform that allows developers, organizations and businesses to easily build and deploy video solutions. With Jitsi as a Service we now give you all the power of Jitsi running on our global platform so you can focus on building secure and branded video experiences.
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
All the Jitsi Meet documentation is available in [the handbook](https://jitsi.github.io/handbook/).
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
For a comprehensive description of all Jitsi Meet's security aspects, please check [this link](https://jitsi.org/security).
|
||||||
|
|
||||||
|
For a detailed description of Jitsi Meet's End-to-End Encryption (E2EE) implementation,
|
||||||
|
please check [this link](https://jitsi.org/e2ee-whitepaper/).
|
||||||
|
|
||||||
|
For information on reporting security vulnerabilities in Jitsi Meet, see [SECURITY.md](./SECURITY.md).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
If you are looking to contribute to Jitsi Meet, first of all, thank you! Please
|
If you are looking to contribute to Jitsi Meet, first of all, thank you! Please
|
||||||
see our [guidelines for contributing](CONTRIBUTING.md).
|
see our [guidelines for contributing](CONTRIBUTING.md).
|
||||||
|
|
||||||
## Embedding in external applications
|
<br />
|
||||||
|
<br />
|
||||||
|
|
||||||
Jitsi Meet provides a very flexible way of embedding in external applications by using the [Jitsi Meet API](doc/api.md).
|
<footer>
|
||||||
|
<p align="center" style="font-size: smaller;">
|
||||||
## Security
|
Built with ❤️ by the Jitsi team at <a href="https://8x8.com" target="_blank">8x8</a> and our community.
|
||||||
|
</p>
|
||||||
The security section here was starting to feel a bit too succinct for the complexity of the topic, so we created a post that covers the topic much more broadly here: https://jitsi.org/security
|
</footer>
|
||||||
|
|
||||||
The section on end-to-end encryption in that document is likely going to be one of the key points of interest: https://jitsi.org/security/#e2ee
|
|
||||||
|
|
||||||
## Security issues
|
|
||||||
|
|
||||||
For information on reporting security vulnerabilities in Jitsi Meet, see [SECURITY.md](./SECURITY.md).
|
|
||||||
|
|
||||||
## Acknowledgements
|
|
||||||
|
|
||||||
Jitsi Meet started out as a sample conferencing application using Jitsi Videobridge. It was originally developed by ESTOS' developer Philipp Hancke who then contributed it to the community where development continues with joint forces!
|
|
||||||
|
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 3.7 MiB |
Loading…
Reference in New Issue