jiti-meet/doc/quick-install.md

132 lines
6.2 KiB
Markdown
Raw Normal View History

2014-08-01 13:54:26 +00:00
# Jitsi Meet quick install
2014-08-01 13:53:22 +00:00
2015-11-05 17:58:13 +00:00
This document describes the required steps for a quick Jitsi Meet installation on a Debian based GNU/Linux system. Debian 8 (Jessie) or later, and Ubuntu 14.04 or later are supported out-of-the-box.
2014-08-01 13:53:22 +00:00
2015-11-05 17:58:13 +00:00
Debian Wheezy and other older systems may require additional things to be done. Specifically for Wheezy, [libc needs to be updated](http://lists.jitsi.org/pipermail/users/2015-September/010064.html).
Also note that a recent default Ubuntu installation has only the `main` repository enabled, and Jitsi Meet needs packages from `universe`. Check your `/etc/apt/sources.list` file, and if `universe` is not present refer to [Ubuntu's documentation](https://help.ubuntu.com/community/Repositories/Ubuntu) on how to enable it. (Usually it amounts to copying the `main` lines and changing to `universe`.)
N.B.:
a.) All commands are supposed to be run by root. If you are logged in as a regular user with sudo rights, please prepend ___sudo___ to each of the commands.
b.) You only need to do this if you want to ___host your own Jitsi server___. If you just want to have a video conference with someone, use https://meet.jit.si instead.
2014-08-05 10:53:38 +00:00
2014-08-01 14:02:53 +00:00
## Basic Jitsi Meet install
### Add the repository
2014-08-01 13:53:22 +00:00
```sh
echo 'deb https://download.jitsi.org stable/' >> /etc/apt/sources.list.d/jitsi-stable.list
wget -qO - https://download.jitsi.org/jitsi-key.gpg.key | apt-key add -
2014-08-01 13:53:22 +00:00
```
2014-08-01 14:02:53 +00:00
### Update the package lists
2014-08-01 13:53:22 +00:00
```sh
apt-get update
```
(If you get an error:
E: The method driver /usr/lib/apt/methods/https could not be found.
run:
```sh
apt-get install apt-transport-https
```
)
2014-08-01 14:02:53 +00:00
### Install Jitsi Meet
2014-08-01 13:53:22 +00:00
2017-07-15 13:36:06 +00:00
Note : Something to consider before installation is how you're planning to serve Jitsi Meet. The installer will check if Nginx or Apache is present (with this order) and configure a virtualhost within the web server it finds to serve Jitsi Meet. If none of the above is found it then configures itself to be served via jetty. So if for example you are planning on deploying Jitsi Meet with a web server, you have to make sure to install the server **before** installing jitsi-meet.
2014-08-01 13:53:22 +00:00
```sh
apt-get -y install jitsi-meet
```
During the installation, you will be asked to enter the hostname of the Jitsi Meet instance. If you have a FQDN hostname for the instance already set up in DNS, enter it there. If you don't have a resolvable hostname, you can enter the IP address of the machine (if it is static or doesn't change).
2014-08-01 13:53:22 +00:00
This hostname (or IP address) will be used for virtualhost configuration inside the Jitsi Meet and also, you and your correspondents will be using it to access the web conferences.
2014-08-01 13:53:22 +00:00
2017-09-21 05:36:38 +00:00
### Generate a Let's Encrypt certificate
Simply run the following in your shell
```sh
/usr/share/jitsi-meet/scripts/install-letsencrypt-cert.sh
```
#### Advanced configuration
If installation is on a machine [behind NAT](https://github.com/jitsi/jitsi-meet/blob/master/doc/faq.md) further configuration of jitsi-videobridge is needed in order for it to be accessible.
Provided that all required ports are routed (forwarded) to the machine that it runs on. By default these ports are (TCP/443 or TCP/4443 and UDP 10000).
The following extra lines need to be added the file `/etc/jitsi/videobridge/sip-communicator.properties`:
```
org.ice4j.ice.harvest.NAT_HARVESTER_LOCAL_ADDRESS=<Local.IP.Address>
org.ice4j.ice.harvest.NAT_HARVESTER_PUBLIC_ADDRESS=<Public.IP.Address>
```
See [the documenation of ice4j](https://github.com/jitsi/ice4j/blob/master/doc/configuration.md)
for details.
Default deployments on systems using systemd will have low default values for maximum processes and open files. If the used bridge will expect higher number of participants the default values need to be adjusted (the default values are good for less than 100 participants).
To update the values edit `/etc/systemd/system.conf` and make sure you have the following values:
```
DefaultLimitNOFILE=65000
DefaultLimitNPROC=65000
DefaultTasksMax=65000
```
To load the values and check them look [here](#systemd-details) for details.
By default, anyone who has access to your jitsi instance will be able to start a conferencee: if your server is open to the world, anyone can have a chat with anyone else. If you want to limit the ability to start a conference to registered users, set up a "secure domain". Follow the instructions at https://github.com/jitsi/jicofo#secure-domain.
2014-08-01 14:02:53 +00:00
### Open a conference
2014-08-01 13:53:22 +00:00
Launch a web browser (Chrome, Chromium or latest Opera) and enter in the URL bar the hostname (or IP address) you used in the previous step.
2014-08-01 13:53:22 +00:00
Confirm that you trust the self-signed certificate of the newly installed Jitsi Meet.
Enjoy!
2014-08-01 14:01:08 +00:00
2014-08-01 14:02:53 +00:00
## Adding sip-gateway to Jitsi Meet
2014-08-01 14:01:08 +00:00
2014-08-05 10:53:38 +00:00
### Install Jigasi
2014-08-06 09:11:32 +00:00
```sh
apt-get -y install jigasi
2014-08-06 09:11:32 +00:00
```
or
2014-08-05 10:53:38 +00:00
```sh
wget https://download.jitsi.org/unstable/jigasi_1.0-107_amd64.deb
dpkg -i jigasi_1.0-107_amd64.deb
2014-08-05 10:53:38 +00:00
```
During the installation, you will be asked to enter your SIP account and password. This account will be used to invite the other SIP participants.
2014-08-05 10:53:38 +00:00
### Reload Jitsi Meet
2014-08-05 11:02:30 +00:00
Launch again a browser with the Jitsi Meet URL and you'll see a telephone icon on the right end of the toolbar. Use it to invite SIP accounts to join the current conference.
2014-08-05 10:53:38 +00:00
Enjoy!
2014-08-05 12:55:14 +00:00
## Uninstall
2014-08-05 12:55:14 +00:00
2014-08-05 12:56:40 +00:00
```sh
apt-get purge jigasi jitsi-meet jitsi-meet-web-config jitsi-meet-prosody jitsi-meet-web jicofo jitsi-videobridge
2014-08-05 12:56:40 +00:00
```
Sometimes the following packages will fail to uninstall properly:
2014-08-05 12:55:14 +00:00
- jigasi
- jitsi-videobridge
When this happens, just run the uninstall command a second time and it should be ok.
2014-08-05 12:55:48 +00:00
The reason for failure is that sometimes, the uninstall script is faster than the process that stops the daemons. The second run of the uninstall command fixes this, as by then the jigasi or jvb daemons are already stopped.
#### Systemd details
To reload the systemd changes on a running system execute `systemctl daemon-reload` and `service jitsi-videobridge restart`.
To check the tasks part execute `service jitsi-videobridge status` and you should see `Tasks: XX (limit: 65000)`.
To check the files and process part execute ```cat /proc/`cat /var/run/jitsi-videobridge.pid`/limits``` and you should see:
```
Max processes 65000 65000 processes
Max open files 65000 65000 files
```