Basic Installation on Linux¶
Partitioning¶
Portal will support most common partitioning schemas. But in order to increase reliability we recommend to separate different components from each other on different partitions.
Here is a example of a partition scheme. Sizes of partitions below are intended for test and development systems. It is recommended that you at LEAST make separate partitions for /var and /srv/media1
In order to be able to change this configuration later on while the system is in use you should always make use of Linux LVM ( Logical Volume Manager )
The SQL DB size will typically be 0,4-0,9 MB / item. So for 100.000 items that means a /var/lib/pgsql/ of at least 90 GB
Sizing a Portal system¶
This guide will not cover a complete configuration, but will provide some basic pointers to think of when sizing a system.
Cores of the servers
Memory in each server
I/O to Storage and Network
Encoding and Decoding formats
Note
The Concurrent jobs should be configured based on the values of the above, and each system is unique.
Steps for installation¶
Note
substitute x.y below for your version of the software
Note
for VidiNet setup, follow VidiNet instead.
Login with an SSH Prompt to your server.
First download the Portal installer. You will receive a file named like this:
Portal_1.x.y.tar
Extract the package supplied to you:
tar xvf Portal_1.x.y.tar
Copy the keyfile supplied to you to the correct directory:
cp key_* Portal_1.x.y/key
For a fresh install you must run “setup”:
cd Portal_1.x.y
sudo ./setup
It will set up the following components on your server:
Cantemo
Vidispine Middleware
Vidispine Transcoder
Solr
Postgresql
nginx
Elastic Search
rabbitmq
redis
rsyslogd
ActiveMQ
Celery
During first setup you need to answer two questions. The first is the password for the admin user the second one is what hostname should answer/serve as your portal server.
Note
The hostname or IP from Vidispine must be included in that list. In a one server system localhost (127.0.0.1) must be included.
Installing only a specific component¶
To install a specfici component run sudo ./setup --components=COMPONENTS`. See ``./setup --help for a list of components
Portal Setup Wizard¶
After running the setup you can access http://yourserver.example.com/ using a web browser to log into Portal and complete the installation. For the first time you will need to log in with an administrator account (default username admin, password admin) and run the setup wizard.
The wizard will ask a couple of questions
Default Upload storage
A system needs a default upload storage, this must be set
Access control
When having simple access control set to true the index ACLs will be based on the groups this means that the system will keep the amount of reindexes based on acl and group changes to a minimum. However this those not support certain cases e.g case is User 1 owns a collection that User 2 has access to and then User 2 adds an item to the collection that User 1 does not have access for. Note that this will not grant any unwanted access for the item in Vidispine but rather that the search can incorrectly return assets that a user does not have access to.
With simple access control set to False the index ACLs will be both group and user based this means that it will correctly cover all the different access cases but it will have perform a lot more reindexes especially when the Group membership changes to keep the users up to date in the index.
Management command¶
You can run /opt/cantemo/portal/manage.py setupvs from the command line. Remember to specify the correct options.
Steps for upgrading¶
Note
Upgrade from Portal 4.3.7 or earlier to Portal 5 is not allowed. Please upgrade to Portal 4.3.8 first.
Note
During upgrades migrations take place and that could cause the database to grow. Make sure utilization on database partition is no more than 50%
It is possible to upgrade a previous installation of portal with the following procedure, please follow this upgrade path:
Portal 1.x -> 1.6 -> 2.4 -> 3.4 -> 4.1 -> 4.3 -> 5.1
Note
substitute x.y below for your version of the software
Login with an SSH Prompt to your server.
First download the Portal installer. You will receive a file named like this:
Portal_5.x.y.tar
Extract the package supplied to you:
tar xvf Portal_5.x.y.tar
You only need to supply a key if your key is outdated:
cp key_* Portal_5.x.y/key
For a fresh install you must run “setup”:
cd Portal_5.x.y
sudo ./setup --upgrade
It will upgrade the following components on your server if needed:
Cantemo
Vidispine Middleware
Vidispine Transcoder
Solr
Postgresql
nginx
Elastic Search
rabbitmq
redis
rsyslogd
ActiveMQ
Celery
After running the setup you should logout from the www-interface and login into Portal again, the setup wizard will be displayed in case your system needs to be reconfigured. Please respond “yes” if the wizard asks you to initialize vidispine.
Note
After a upgrade don’t forget to log out and login again! All users will be logged out automatically.
You should now be able to use a web browser to navigate to the server that you installed Portal on. If you wish, please consider to setup extra configuration options for Portal such as you email server settings, timezone and locale.
If you want to upgrade the system to run external ActiveMQ. Follow this steps:
Install the ActiveMQ component
Configure
server.yamland remove theembeddedBrokerand point to the installed component configuration
Note
Default port for ActiveMQ is 61616 so make sure the embedded broker is shut off before trying to run the external one
Steps for updating your license key¶
The license key needs to be installed into multiple place in order for it to be available both to Portal and Vidispine. You can perform this update using the setup script from the installer.
Login with an SSH Prompt to your server.
Copy the keyfile supplied to you to the same directory as the setup script:
cp key_* Portal_5.x.y/key
Run the following command do update the key:
./setup --update-key
This will update the license keys for both Portal and Vidispine.
Note
If you manually put the license in the correct directory, remember to split the key between Portal and Vidispine.
