Skip to content

Commit

Permalink
Focal doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Jess Portnoy committed Jul 8, 2020
1 parent 76cb8f6 commit e538010
Showing 1 changed file with 201 additions and 0 deletions.
201 changes: 201 additions & 0 deletions doc/install-kaltura-focal.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
# Ubuntu Focal [20.04] all-in-one Kaltura server installation


**Kaltura CE was just ported to Ubuntu Focal. Please note that this is a beta version and one must exercise judgement before deploying it to Prod ENVs.**

[Kaltura Inc.](http://corp.kaltura.com) also provides commercial solutions and services including pro-active platform monitoring, applications, SLA, 24/7 support and professional services. If you're looking for a commercially supported video platform with integrations to commercial encoders, streaming servers, eCDN, DRM and more - Start a [Free Trial of the Kaltura.com Hosted Platform](http://corp.kaltura.com/free-trial) or learn more about [Kaltura' Commercial OnPrem Edition™](http://corp.kaltura.com/Deployment-Options/Kaltura-On-Prem-Edition). Please note that this service in only offered for RHEL based distros.

#### Table of Contents
[Prerequites](pre-requisites.md)

[Step-by-step Installation](install-kaltura-deb-based.md#step-by-step-installation)

[Unattended Installation](install-kaltura-deb-based.md#unattended-installation)

[Nginx SSL Configuration](nginx-ssl-config.md)

[Live Streaming with Nginx and the RTMP module](install-kaltura-redhat-based.md#live-streaming-with-nginx-and-the-rtmp-module)

[Upgrade Kaltura](install-kaltura-deb-based.md#upgrade-kaltura)

[Remove Kaltura](install-kaltura-deb-based.md#remove-kaltura)

[Troubleshooting](install-kaltura-deb-based.md#troubleshooting)

[Additional Information](install-kaltura-redhat-based.md#additional-information)

[How to contribute](CONTRIBUTERS.md)

## Step-by-step Installation

### Pre-Install notes
* This install guides assumes that you did a clean, basic install of Ubuntu Focal [20.04] on a 64bit machine.
* When installing, you will be prompted for each server's resolvable hostname. Note that it is crucial that all host names will be resolvable by other servers in the cluster (and outside the cluster for front machines). Before installing, verify that your /etc/hosts file is properly configured and that all Kaltura server hostnames are resolvable in your network.
* Before you begin, make sure you're logged in as super user [root]. Root access is required to install Kaltura, and you should execute ```sudo -i``` or ```su -```to make sure that you are indeed root.

#### Firewall requirements
Kaltura requires certain ports to be open for proper operation. [See the list of required open ports](kaltura-required-ports.md).
If you're just testing and don't mind an open system, you can use the below to disbale iptables altogether:
```bash
# iptables -F
```
#### Disable SELinux - REQUIRED
**Currently Kaltura doesn't properly support running with SELinux, things will break if you don't set it to permissive**.
If your instance has it enabled [by default Debian and Ubuntu do not enable SELinux], run:
```bash
# setenforce permissive
```

To verify SELinux will not revert to enabled next restart:

- Edit the file `/etc/selinux/config`
- Verify or change the value of SELINUX to permissive: `SELINUX=permissive`
- Save the file `/etc/selinux/config`

### Start of Kaltura installation
This section is a step-by-step guide of a Kaltura installation.

#### Setup the Kaltura deb repository

```bash
# wget -O - http://installrepo.kaltura.org/repo/aptn/focal/kaltura-deb-curr-256.gpg.key|apt-key add -
# echo "deb [arch=amd64] http://installrepo.kaltura.org/repo/aptn/focal propus main" > /etc/apt/sources.list.d/kaltura.list
```

##### IMPORTANT NOTE:

If you had a pre-installed Apache on the machine, depending on your current Apache setup, you may need to disable your default site configuration.

Use:
```
# apachectl -t -DDUMP_VHOSTS
```
to check your current configuration and:
```
# a2dissite $SITENAME
```
to disable any site that might be set in a way by which $YOUR_SERVICE_URL/api_v3 will reach it instead of the Kaltura vhost config.

In such case, the postinst script for kaltrua-db will fail, if so, adjust it and run:
```
# dpkg-reconfigure kaltura-db
```

#### MySQL Install and Configuration
The Ubuntu Focal repos include MySQL of version 5.7 which the Kaltura Server does not currently support.
Therefore, it is essential to install MySQL 5.5 instead.
We recommend the use of the percona-server-server-5.5 package, available from this repo.

When installing an all in one instance, for security reasons, it is best to bind the MySQL daemon to 127.0.0.1 [loopback].
When prompted for the MySQL host/IP, please use ```127.0.0.1``` rather than ```localhost``` since the server code uses the PHP PDO MySQL extension and setting the host to localhost will cause it to attempt to connect via a UNIX socket, as opposed to over TCP, which may fail, depending on where the UNIX socket is placed and the value set for the pdo_mysql.default_socket directive.


#### Install Kaltura Server
You can use this process to auto install an all in 1 server.
In order to perform a manual step by step install, simply copy the commands and run them one by one.

*NOTE: the script calls aptitude with -y which means you will not be prompted to confirm the packages about to be installed.*

```bash
# wget http://installrepo.origin.kaltura.org/repo/aptn/focal/install_kaltura_all_in_1.sh
# chmod +x install_kaltura_all_in_1.sh
# ./install_kaltura_all_in_1.sh
```

### Nginx SSL configuration
Please see [nginx-ssl-config.md](nginx-ssl-config.md)


## Live Streaming with Nginx and the RTMP module
Kaltura CE includes the kaltura-nginx package, which is compiled with the [Nginx RTMP module](https://github.com/arut/nginx-rtmp-module).

Please see documentation here [nginx-rtmp-live-streaming.md](nginx-rtmp-live-streaming.md)

A longer post about it can be found at https://blog.kaltura.com/free-and-open-live-video-streaming


## Unattended Installation
Edit the debconf [response file template](https://github.com/kaltura/platform-install-packages/blob/Jupiter-10.16.0/deb/kaltura_debconf_response.sh) by replacing all tokens with relevant values.
and run it as root:
```
# ./kaltura_debconf_response.sh
```
the set the DEBIAN_FRONTEND ENV var:
```
# export DEBIAN_FRONTEND=noninteractive
```

And install as described above.

## Upgrade Kaltura
*This will only work if the initial install was using this packages based install, it will not work for old Kaltura deployments using the PHP installers*

Make sure /etc/apt/sources.list.d/kaltura.list has:
```
deb [arch=amd64] http://installrepo.kaltura.org/repo/aptn/focal propus main
```
And import the GPG key with:
```
# wget -O - http://installrepo.kaltura.org/repo/aptn/focal/kaltura-deb-curr-256.gpg.key|apt-key add -
```

Then run:

```bash
# aptitude update
# aptitude dist-upgrade
# dpkg-reconfigure kaltura-base
# dpkg-reconfigure kaltura-front
# dpkg-reconfigure kaltura-batch
```


## Remove Kaltura
Use this in cases where you want to clear the database and start from fresh.
```bash
# /opt/kaltura/bin/kaltura-drop-db.sh
# apt purge "kaltura-.*"
# rm -rf /opt/kaltura
# rm -rf /etc/kaltura.d
```

## Troubleshooting
Once the configuration phase is done, you may wish to run the sanity tests, for that, run:
```base
# /opt/kaltura/bin/kaltura-sanity.sh
```

If you experience unknown, unwanted or erroneous behaviour, the logs are a greta place to start, to get a quick view into errors and warning run:
```bash
# . /etc/profile.d/kaltura-base.sh
# kaltlog
```

If this does not give enough information, increase logging verbosity:
```bash
# sed -i 's@^writers.\(.*\).filters.priority.priority\s*=\s*7@writers.\1.filters.priority.priority=4@g' /opt/kaltura/app/configurations/logger.ini
```

To revert this logging verbosity run:
```bash
# sed -i 's@^writers.\(.*\).filters.priority.priority\s*=\s*4@writers.\1.filters.priority.priority=7@g' /opt/kaltura/app/configurations/logger.ini
```

Or output all logged information to a file for analysis:
```bash
# allkaltlog > /path/to/mylogfile.log
```

For posting questions, please go to:
(http://forum.kaltura.org)

## Additional Information
* Please review the [frequently answered questions](kaltura-packages-faq.md) document for general help before posting to the forums or issue queue.
* This guide describes the installation and upgrade of an all-in-one machine where all the Kaltura components are installed on the same server. For cluster deployments, please refer to [cluster deployment document](http://bit.ly/kipp-cluster-yum), or [Deploying Kaltura using Opscode Chef](rpm-chef-cluster-deployment.md).
* To learn about monitoring, please refer to [configuring platform monitors](http://bit.ly/kipp-monitoring).
* Testers using virtualization: [@DBezemer](https://github.com/kaltura) created a basic CentOS 6.4 template virtual server vailable here in OVF format: https://www.dropbox.com/s/luai7sk8nmihrkx/20140306_CentOS-base.zip
* Alternatively you can find VMWare images at - https://www.osboxes.org/vmware-images/ --> Make sure to only use compatible OS images; either RedHat or CentOS 5.n, 6.n or FedoraCore 18+.
* Two working solutions to the AWS EC2 email limitations are:
* Using SendGrid as your mail service ([setting up ec2 with Sendgrid and postfix](http://www.zoharbabin.com/configure-ssmtp-or-postfix-to-send-email-via-sendgrid-on-centos-6-3-ec2)).
* Using [Amazon's Simple Email Service](http://aws.amazon.com/ses/).
* [Kaltura Inc.](http://corp.kaltura.com) also provides commercial solutions and services including pro-active platform monitoring, applications, SLA, 24/7 support and professional services. If you're looking for a commercially supported video platform with integrations to commercial encoders, streaming servers, eCDN, DRM and more - Start a [Free Trial of the Kaltura.com Hosted Platform](http://corp.kaltura.com/free-trial) or learn more about [Kaltura' Commercial OnPrem Edition™](http://corp.kaltura.com/Deployment-Options/Kaltura-On-Prem-Edition). For existing deb based users, Kaltura offers commercial upgrade options.

0 comments on commit e538010

Please sign in to comment.