FFAStrans wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Installation =====


You can download FFAStrans from the FFAStrans home page [[http://www.ffastrans.com|FFAStrans Home Page]]

<note>
If you have to upgrade, and want to keep all your settings (workflows status, host settings, jobs history,etc) from previous FFAStrans versions (0.6 -> 0.9) to 1.0.0+, please follow the right procedure describe [[gui:upgrade_procedure|here]]. NOTE: XML workflow files from 0.9 are accepted by the 1.0.0+ FFAStrans versions. 
</note>

**Installation steps: **

Unzip to C:\FFAStrans this location is not mandatory but highly recommended currently\\
Although FFAStrans is a portable software, it is recommended to place installation folder directly on "C:\FFAStrans". The reason for this is that FFAStrans writes files into it's /db directory and windows UAC would keep it from doing so if you extract it into %programfiles%. We are working on that.


Double click FFAStrans.exe to launch it. A message is displayed during the first launch.

{{:install.first.launch.jpg?nolink&400|}}


==== Configuration for Local use:==== 
(See [[architecture|Deployment Options]] for professional use).

**Configure Media Cache:**

The Cache location corresponds to a folder in which FFAStrans will temporarily store the working files (encodings in progress, files being demuxed, etc.) before delivering them to the destination folder. It is recommanded to choose a different drive from the installation location and to make sure there is enough space available. The encoding jobs you run in paralell, the more space you will need.

Go to the 'host' tab and under 'local host media cache' click to define your cache folder.
<note>
At first startup, FFAStrans will automatically scan your harddrives and configure the cache location to be on the biggest drive with most space available automatically.
</note>

{{:install_config.png?nolink400|}}

Leave 'use local media cache' checked if you plan to work locally.\\
'Use global media cache' is only for use with multiple machines/hosts in a farming environment.\\
\\
Make sure windows firewall allows the "exe_manager.exe"(Windows security->Firewall->allow an app through the firewall : FFAStrans processor manager), otherwise FTP watch folders may not work properly.

{{:gui:firewall.png?nolink&500|}}
==== Hosts groups: ====


With FFAStrans you can group hosts into different named groups and assign nodes or/and workflows to them.\\
{{:hosts_groups.png?nolink&400|}}\\
\\
Hosts groups principle :\\
{{:farm_grouping_configuration.png?nolink&800|}}
\\
\\
\\
Understand hosts groups configuration:\\
{{:tutorials:hosts_groups.mp4?link&700|}}
==== Passive Mode: ====
If you execute the FFAStrans.exe binary with the "-passive" argument, the FFAStrans manager will start as normal 
but the computer from which you started it will NOT act as a working host. This is ideal if you just want to 
manage a FFAStrans environment from another computer on the network.|
In passive mode the the "Workflow" title pane will have a pear-ish color and the title will display "FFAStrans   Workflow Manager (-PASSIVE MODE-)".


- __Resources__: You can tick 'enable local workflow processing as application' and set the maximum CPU utilization and the number of jobs processed at the same time (depends on the power of the cpu). To understand how FFAStrans manages priorities, see [[system:processes#Priority flow chart and example]].\\
It is recommended not to exceed 85% or risk freezing the application or the system.
Click 'ok' to save your settings.

{{:install_local_ressources.png?nolink400|}}


==== Web REST Service ====


A REST API Service in general is needed in order to allow other external programs like the [[webinterface:Webinterface]] to interact with FFAStrans. 

** Run as local application ** : 
  * The "Web REST Service" Button is only of interest when you do NOT run FFASTRANS as Service but as application instead. When installed as service, the API Server is automatically enabled

{{:install_rest.png?nolink400|}}


===== Install Windows Service (Highly recommended) =====

When running as windows service, the Windows Service named "FFAStrans REST API Service" is actually not only serving the REST API but **also driving Watchfolders and Workflows.**

Running as Windows Service means that the workflows work in the background without need to launch the application and you do not even need to log on as a user after rebooting the server.

<note warning>
From this point, you MUST use full UNC paths instead of mapped drive letter for literraly everything around FFAStrans. This also includes starting the FFAStrans GUI and sumbitting Files. 
The Reason for that is that background Services cannot access mapped drive letters, mapped drives is something that only a user can use AFTER he logged in and created his own windows session. A Service instead has it's "own" windows session which you cannot influence even by logging on as the same usernamen as the service is configured to use.
</note>

To install the windows service, in first place make sure that you **started the application using the full UNC path** instead of using a mapped drive letter.

Click on "Install as windows service". 'Install as windows service' changes to 'Remove windows service' and 'Run as application' is now greyed.

{{:install_rest.png?nolink400|}}{{gui:fleche.jpg?nolink&50|}}
{{:install_rest_on.png?nolink400|}}


Reboot computer to automatically start service or start it manually by typing "services" in the windows start menu and search FFAStrans REST-API.

{{::install_service_setting.jpg?direct&900|}}


Right click and 'start' the service manually.


** __Important Note about credentials for windows service__ ** :

If you install the windows service, it will be installed with standard Local System User. To be sure to access to all your shared folders, you should log on with administrator account or an account which belongs to administrator group.

Right click on FFAStrans REST-API service, select properties, log on tab. 

{{:install_service_setting_prop2_circle.jpg?direct&200|}}{{:gui:fleche.jpg?nolink&50|}}{{:install_service_setting_prop_log_circle.jpg?direct&200|}}

Enter your account name (e.g: administrator@domain.com) and your password. When using NAS Shares, the chosen account must be able to read/write on all Shares. \\
After saving, you need to restart the Service in order to apply the changes.


-----------------------------------

<html>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</html>[[gui:installation|Back to top]]