Contact Support

Installing and Licensing Flix Server

Flix Server System Requirements

Mac

Yosemite (10.10) or higher

4GB of RAM

Linux

CentOS/RHEL 6.10 or higher, Ubuntu 18.04 LTS

A 64 bit processor @ 2GHz or higher

4GB of RAM

Note:  Flix Server is currently not available on Windows.
Other operating systems may work with Flix Server, but have not been fully tested.

 

Flix Server is the server application for Flix. Before running the Flix server binary, you need to setup the config.yml file.

To use Flix 6.0.1 you need to install Flix Server running MySQL 5.7.

Installing and Running MySQL

Install MySQL and check that your MySQL server is running.

Configuration

You will need to setup a config.yml file, located in the same directory as the Flix Server binary before you can run the server.

Here is a basic example of how config.yml should look:

hostname: flix001.mycompany.com http_port: 8080 mysql_hostname: db1.mycompany.com mysql_username: root mysql_password: password

Options

Below is the full list of options for config.yml.

hostname - [required] (IP address or fqdn for the Flix Server to run on, e.g. flix001.mycompany.com)

http_port - [required] (Port number for the Flix Server to run on, e.g. 8080)

mysql_hostname - [required] (Address of the db server, IP or fqdn. Default: localhost)

mysql_username - [required] (MySQL username with access to the Flix schema)

mysql_password - [required] (MySQL password)

mysql_port - [optional] (Port number for the MySQL database. Default: 3306)

mysql_database - [optional] (Name of the database for Flix. Default: flix)

asset_directory - [optional] (Path to where assets should be stored,defaults to the Flix Server install directory)

transcoder_jobs - [optional] (Number of jobs the transcoders will do at the same time)

max_thumbnail_height - [optional] (Max height for generated thumbnails, in pixels. Default: 1000)

max_thumbnail_width - [optional] (Max width for generated thumbnails, in pixels. Default: 1000)

licence-directory - [optional] (location path of the license)

The Flix Server does not have to run from the same server as the MySQL database, as long as it can access it over the network.

Note:  You will need to make sure that the hostname option is set to a publicly available hostname or IP address. We recommend a fully qualified domain name and unique hostname for each server.

Installing the Database Schema

Before running Flix for the first time, you will need to install the database schema. This can be done by running the Flix Server in database install mode. It will connect to your database, and create all the necessary tables for Flix to run. Flix will prompt you to make a backup of your database, to ensure there is no data loss if the process was to fail. Once complete, Flix will exit, and you can then start it in the normal operating mode:

Note:  You must ensure the database name you have specified in your config file (or 'flix', by default) already exists in your MySQL server.

./flix_server --db-install

Updating the Database Schema

If you are upgrading Flix to a new version you can use the upgrade mode to mutate the database schema to the latest version:

./flix_server --db-upgrade

Running the Server

To run Flix server, simply run the binary like this:

./flix_server

Tip:  Use the `--verbose` flag to display more detailed log output in the console.

Note:  The first time the Flix Server is run, it automatically creates an admin user with the username and password both set to admin, which you can use to log in to Flix for the first time. It is recommended that you change the default password after the first log in.

CLI arguments

Here is an exhaustive list of CLI arguments, if you would like to override the options set in the config.yml file, when starting the server through the command line:

--verbose - (show verbose logging) --http-port - (port number to run the server on) --rep-port - (the replication port number) --db-name - (the name of the database) --db-username - (the database username) --db-password - (the database password) --db-host - (ip address of the mysql database) --transcoder-jobs - (the number of jobs the transcoders will do at the same time) --hostname - (an ip address where the server will run)

Licensing

Each Flix server requires a license which specifies how many clients can use the server at any one time. The license is a node locked license specific to each server.

Node Locked Licenses - these can be used to license an application on a single machine. They do not work on different machines and if you need them to, you’ll have to transfer your license. Node locked licenses, sometimes called uncounted licenses, do not require additional licensing software to be installed.

If you are using multiple Flix servers, you need one license per Flix server.

Foundry requires the System ID of each Flix server before creating each license.

Obtaining a System ID

To obtain a license, you first need to provide Foundry with your server's System ID (sometimes called Host ID or rlmhostid). Just so you know what a System ID number looks like, here’s an example: 000ea641d7a1.

To find out your server's System ID:

Download the Foundry License Utility (FLU) from https://www.foundry.com/licensing and run it. Your server's System ID is displayed.

Article:  For more details, have a look at this Knowledge Base article: What is the System ID and how do I find it?

When you know your server's System ID, you can request a license for Foundry products from Foundry's Sales Department at sales@foundry.com.

Licensing a Server

Once Foundry has issued you the required licenses, typically foundry.lic, you need to place the license file in your Flix server directory or enter the location path of the license in the config.yml file using the licence-directory parameter.

Note:  Once you've installed and licensed Flix Server, you can move on to Installing and Launching Flix Client.