Installing S-Filer Portal

S-Filer Portal consists of three components:

The server
The gateway
The command line interface (CLI)

Server and Gateway can be installed in console mode or in graphic mode. Typically, the console mode is used in a UNIX environment, while the graphic mode is used in the Windows world. The installation procedures of these two components are very similar. The administrator simply needs to specify the basic configuration through a series of questions. Once completed the installation of components, it is always possible to reconfigure the installation settings. Each component once installed can uninstall just as easy. The installation of web applications (war file) are as simple and mainly involve copying the files in the right places on the target system.

System configurations

When running in a Linux environment, you need to make sure the fontconfig and libfontconfig.so.1 package are installed because they are required by java and not included in OpenJDK 11 and is required to display the Captcha and for all the reports. This applies for both the Server and the Gateway.

You can run the following commands with yum or rpm to verify if they are installed.

shell

yum list installed fontconfig

shell

rpm -qa \| grep fontconfig

For example, if your distribution supports yum, you could use the following commands to install them.

shell

yum install fontconfig
yum install libfontconfig.so.1

Package content

The customer receives in their S-Filer Support community the appropriate package for their environment.

The Server

This chapter introduces you to the S-Filer Portal Server installation as well as basic configuration. Before starting, it is recommended to print the Check List supplied in Annexe 1 at the end of this document and fill each field as you install.

Installing the Server

The S-Filer / Portal server is the main component. This is the first component to install.

Installing using the installer

You can launch the installer by clicking directly on the executable sfiler-server-installer.exe. For Windows Core versions you can use the -i console parameter on the command line: sfiler-server-installer.exe -i console.

After launching the installer, it prompts you to close all applications running to eliminate all sources of conflict. Once all applications are closed, you must click on the Next button to proceed to the next step.

You are then prompted to read and accept the license to use the product S-Filer Portal. To accept the license, you must press the Next button. If you would like more information about the license, please contact your technical support.

Once you have accepted the license, you must select the installation type. A "Complete Installation" will install all the required components and configuration files. If you are installing S-Filer for the first time, please select this option. An ''Update'' will upgrade your existing S-Filer installation with the new features and leave your configuration files intact.

Next, you must enter the destination directory. You can browse your file system using the Choose button. Once the directory is specified, press the Next button to proceed to the next step. In the event you wish to return to the default location, simply click the Restore Default Folder button.

Finally, you must choose a temporary folder that will be used the server. If the folder does not exist, it will be created during the installation. Make sure that you have write permission on the selected location.

One must now validate the parameters of the installer before it starts copying files to the target system. If the parameters are valid, click the Install button to continue the installation.

You can follow the progress of the installation via the progress bar at the bottom of the window. To avoid any potential problems, S-Filer / Portal installs its own JRE (Java Runtime Environment).

At the end of the installation, if everything went well, a message appears indicating that the installation is completed. If an error occurs during the installation, note the error and contact technical support.

The installation is complete.

Installing using the command line

To start the installation, run the sfiler-server-installer.bin. Make sure you have proper permissions on the executable file. If this is not the case, run the following command:

shell

chmod 755 sfiler-server-installer.bin

Once the rights to the file are appropriate, start the installation directly from the command line

shell

./sfiler-server-installer.bin

The first step of the installer prompts you to choose the language.

shell

[root@localhost tmp]# ./sfiler-server-installer.bin                 
                                                                      
Preparing to install                                                  
                                                                      
Extracting the JRE from the installer archive...                     
                                                                      
Unpacking the JRE...                                                 
                                                                      
Extracting the installation resources from the installer archive...  
                                                                      
Configuring the installer for this system's environment...          
                                                                      
Launching installer...                                               
                                                                      
===================================================================== 
                                                                      
Choose Locale\...                                                     
                                                                      
----------------                                       
                                                                      
->1- English                                                         
  2- Español                                                            
  3- Français                                                           
                                                                      
CHOOSE LOCALE BY NUMBER:

Then, the installation prompts you to close all applications running in order to eliminate any possible conflict. Press ENTER to move to the next step.

shell

=====================================================================
S-Filer Server (created with InstallAnywhere)                         
---------------------------------------------------------------------                                                                      
Preparing CONSOLE Mode Installation...                               
 
===================================================================== 
Introduction                                                          
------------                                               
                                                                      
InstallAnywhere will guide you through the installation of S-Filer    
Server.                                                               
                                                                      
It is strongly recommended that you quit all programs before          
continuing with this installation.                                                    
                                                                      
Respond to each prompt to proceed to the next step in the             
installation. If you want to change something on a previous step, type 'back'.       
                                                                      
You may cancel this installation at any time by typing 'quit'.      
                                                                      
PRESS <ENTER> TO CONTINUE:

The license text will be displayed. You must accept the terms of use of the solution to continue the installation. Press Y (for Yes) to proceed to the next step. If you would like more information on the license, please contact support.

After accepting the license, you are prompted for the installation type of the server. A "Complete Installation" will install all the required components and configuration files. If you are installing S-Filer for the first time, please select this option. An ''Update'' will upgrade your existing S-Filer installation with the new features and leave your configuration files intact.

shell

DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): Y
=========================================================================

Choose Install Set
------------------

Please choose the Install Set to be installed by this installer

->1- Complete Installation
->2- Update

ENTER THE NUMBER FOR THE INSTALL SET, OR PRESS <ENTER> TO ACCEPT THE DEFAULT
 :

Next, you are prompted for the installation directory of the server. To accept the default directory, press ENTER key in the target directory if desired.

shell

===============================================================================
Choose Install Folder
---------------------

If you are upgrading, please choose your existing install directory

Where would you like to install?

  Default Install Folder: /usr/local/sfiler-server

ENTER AN ABSOLUTE PATH, OR PRESS \<ENTER\> TO ACCEPT THE DEFAULT
  :

You must now choose a temporary folder that will be used by the server. If the folder does not exist, it will be created during the installation. Make sure that you have write permission on the selected location.

shell

===============================================================================
Temporary folder
----------------

Enter the location of the temporary folder that will be used by the
server. If

the folder doesn't exist, it will be created. Please confirm that you
have write permissions in the selected location.

Please Choose a temporary folder (Default: /tmp):

You will then be asked the name and where you would like to add the server start script. You have 2 options; one is to put it in the /etc/init.d directory or to create it in the installation directory.

shell

===============================================================================
Startup script name
-------------------

Enter the name of the startup script. If you are installing on a machine
that already has a server installed, be careful to choose a different file
name that was used in previous installations.

Startup script name (Default: sfiler):
===============================================================================
Choose the startup script path
------------------------------

Select the path where you would like to have the startup script. If you
have root access, select option 1, otherwise choose option 2 to install them
in the install folder.

->1- /etc/init.d
  2- Installed Folder (non root access)

ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS \<ENTER\> TO ACCEPT THE
DEFAULT:

The next step is simply to confirm the settings selected.

shell

===============================================================================
Pre-Installation Summary
------------------------

Please Review the Following Before Continuing:

Product Name:
    S-Filer Server

Install Folder:
    /usr/local/sfiler-server

Link Folder:
    /root

Disk Space Information (for Installation Target):
    Required: 514,210,874 Bytes
    Available: 32,034,263,040 Bytes

PRESS <ENTER> TO CONTINUE:

If the parameters are correct, simply press ENTER to complete installation of the S-Filer Portal Server.

shell

=========================================================================
Ready To Install
----------------

InstallAnywhere is now ready to install S-Filer Server onto your system
at the following location:

    /usr/local/sfiler-server

PRESS <ENTER> TO INSTALL:

One can then follow the installation progress.

shell

Installing...
-------------
[==================|==================|==================|==============
[------------------|------------------|------------------|------------

The last step confirms that the installation was successful. In case of problems, please contact support.

shell

=========================================================================
Installation Complete
---------------------

Congratulations. S-Filer Server has been successfully installed to:
    /usr/local/sfiler-server
PRESS <ENTER> TO EXIT THE INSTALLER:

Important: Remember to write down any changes to default values in the Check List supplied at the end of this manual.

Configuring the database

If your database supports UTF8, always use UTF8 character encoding.

We use Liquibase (a third-party library) to initially setup the tables and then for product updates. Liquibase simplifies the product updates because it knows what your current version is and will apply the changes automatically to the database to work with the version you are updating to.

We had DBA's who wanted to this themselves but eventually saw that Liquibase does a very good job of tracking and applying the modifications to the databases.

The first configuration step is to change some lines in the [Install folder]/server/conf/sfiler.conf file (create it by copying the sfiler.conf.template file in the same directory).

Here is an example of the lines to change in the file (see the sections below for the values to enter in those fields):

shell

cfg.server.local.config.user=[USER]
cfg.server.local.config.password=[PASSWORD]                         
cfg.server.local.config.hibernate.dialect=[DIALECT]                 
cfg.server.local.config.driver=[DRIVER]                             
cfg.server.local.config.url=[URL]

Configuration for MySQL

Manually download the JDBC drivers for MySQL and save the jar file provided in the [Install folder]/server/ext/lib folder. You can download this driver here: https://dev.mysql.com/downloads/connector/j/

The file will look like this: mysql-connector-java-8.0.19.jar.

Variable	Value
USER	The name of the database user to use
PASSWORD	The password for the database user (note that the application will hide this password automatically after it has started, so you may see a different value after it has started)
DIALECT	org.hibernate.dialect.MySQL5InnoDBDialect
DRIVER	com.mysql.cj.jdbc.Driver
URL	jdbc:mysql://[HOST]:[PORT]/[DATABASE] (Replace the variables in the URL) Use at the end of the URL to maintain utf8 encoding (otherwise the driver will use the default latin1) and setting the server time zone : ?useUnicode=true&characterEncoding=utf8&useJDBCCompliantTimezoneShift= true&useLegacyDatetimeCode=false&serverTimezone=UTC
HOST	The name of the MySQL server
PORT	The port on which MySQL is listening (default: 3306)
DATABASE	The name of the database to

Configuration for SQL Server

For SQL Server, there are five different deployment possibilities:

Server using the default instance running on a static port with SQL native authentication (not a Windows account)
Server using a named instance with SQL native authentication
Server using the default instance running on a static port with Windows authentication (a domain account is used)
Server using a specific instance running on a static port with Windows authentication (a domain account is used)
Server using a named instance with Windows authentication

Server using the default instance running on a static port with SQL native authentication (not a Windows account)

Manually download the JDBC drivers for SQL Server and save the jar file provided in the [Install folder]/server/ext/lib folder. You can download this driver here:

https://sourceforge.net/projects/jtds/files/

The file will look like this: jtds-1.3.1.jar.

Variable	Value
USER	The name of the database user to use
PASSWORD	The password for the database user (note that the application will hide this password automatically after it has started, so you may see a different value after it has started)
DIALECT	Depends on the version of SQL Server: org.hibernate.dialect.SQLServerDialect (SQL Server 2000 and higher)
DRIVER	net.sourceforge.jtds.jdbc.Driver
URL	jdbc:jtds:sqlserver://[HOST]:[PORT];DatabaseName=[DATABASE] (Replace the variables in the URL)
HOST	The name of the SQL Server
PORT	The static port of the instance (default: 1433
DATABASE	The name of the database to connect to.

Server using a named instance with SQL native authentication

In this case, the Microsoft driver needs to be used. It needs to be downloaded from the Microsoft web site:

https://docs.microsoft.com/en-us/sql/connect/jdbc/overview-of-the-jdbc-driver?view=sql-server-ver15

The Microsoft JDBC Driver 7.2 and above is required to work with java 11. Run the executable file to unpack files to a specific folder. Copy the following files to the [Install folder]/server/ext/lib

[unpack location]/sqljdbc_7,4/enu/mssql-jdbc-7.4.1.jre11.jar

[unpack location]/sqljdbc_7.4/enu/auth/x64/sqljdbc_auth.dll (For 64 bit Windows)

[unpack location]/sqljdbc_7.4/enu/auth/x86/sqljdbc_auth.dll (For 32 bit Windows)

Variable	Value
USER	The name of the database user to use
PASSWORD	The password for the database user (note that the application will hide this password automatically after it has started, so you may see a different value after it has started)
DIALECT	Depends on the version of SQL Server: org.hibernate.dialect.SQLServer2008Dialect (SQL Server 2008 and higher)
DRIVER	com.microsoft.sqlserver.jdbc.SQLServerDriver
URL	jdbc:sqlserver://[HOST];instanceName=[INSTANCE];databaseName=[DATABASE]; (Replace the variables in the URL)
HOST	The name of the SQL Server
INSTANCE	The name of the database instance
DATABASE	The name of the database to connect to.

Server using the default instance running on a static port with Windows authentication (a domain account is used)

In this case, the Microsoft driver needs to be used. It needs to be downloaded from the Microsoft web site:

https://docs.microsoft.com/en-us/sql/connect/jdbc/overview-of-the-jdbc-driver?view=sql-server-ver15

[unpack location]/sqljdbc_7,4/enu/mssql-jdbc-7.4.1.jre11.jar

[unpack location]/sqljdbc_7.4/enu/auth/x64/sqljdbc_auth.dll (For 64 bit Windows)

[unpack location]/sqljdbc_7.4/enu/auth/x86/sqljdbc_auth.dll (For 32 bit Windows)

Variable	Value
USER	Not used (in this configuration, this field is ignored)
PASSWORD	Not used (in this configuration, this field is ignored)
DIALECT	DIALECT Depends on the version of SQL Server: org.hibernate.dialect.SQLServer2008Dialect (SQL Server 2008 and higher)
DRIVER	com.microsoft.sqlserver.jdbc.SQLServerDriver
URL	jdbc:sqlserver://[HOST]:[PORT];databaseName=[DATABASE];integratedSecurity=true (Replace the variables in the URL)
HOST	The name of the SQL Server
PORT	The static port of the instance (default: 1433)
DATABASE	The name of the database to connect to.

Note: With this configuration, the Windows service for the S-Filer Server must run using the domain account configured for database access.

Server using a specific instance running on a static port with Windows authentication (a domain account is used)

Manually download the JDBC drivers for SQL Server and save the jar file provided in the *[Install folder]/server/ext/lib folder. You can download this driver here:

https://sourceforge.net/projects/jtds/files/

The file will look like this: jtds-1.3.1.jar.

Variable	Value
USER	The name of the database Windows user to use
PASSWORD	The password for the database Windows user (note that the application will hide this password automatically after it has started, so you may see a different value after it has started)
DIALECT	Depends on the version of SQL Server: org.hibernate.dialect.SQLServerDialect (SQL Server 2000 and higher)
DRIVER	net.sourceforge.jtds.jdbc.Driver
URL	jdbc:jtds:sqlserver://[HOST]:[PORT];databaseName=[DATABASE]; InstanceName=[INSTANCE];useNTLMv2=[FLAG];domain=[WINDOWS DOMAIN] (Replace the variables in the URL)
HOST	The name of the SQL Server
PORT	The static port of the instance (default: 1433)
DATABASE	The name of the database to connect to.
INSTANCE	This is the name of the MSSQL instance you want to use
FLAG	Must be set to true to use Windows Authentication
WINDOWS DOMAIN	The name of the windows users domain

Note: With this configuration, the Windows service for the S-Filer Server must run using the domain account configured for database access.

Server using a named instance with Windows authentication

In this case, the Microsoft driver needs to be used. It needs to be downloaded from the Microsoft web site:

https://docs.microsoft.com/en-us/sql/connect/jdbc/overview-of-the-jdbc-driver?view=sql-server-ver15

[unpack location]/sqljdbc_7,4/enu/mssql-jdbc-7.4.1.jre11.jar

[unpack location]/sqljdbc_7.4/enu/auth/x64/sqljdbc_auth.dll (For 64 bit Windows)

[unpack location]/sqljdbc_7.4/enu/auth/x86/sqljdbc_auth.dll (For 32 bit Windows)

Variable	Value
USER	Not used (in this configuration, this field is ignored)
PASSWORD	Not used (in this configuration, this field is ignored)
DIALECT	Depends on the version of SQL Server: org.hibernate.dialect.SQLServer2008Dialect (SQL Server 2008 and newer)
DRIVER	com.microsoft.sqlserver.jdbc.SQLServerDriver
URL	URL jdbc:sqlserver://[HOST];instanceName=[INSTANCE];databaseName=[DATABASE];integratedSecurity=true (Replace the variables in the URL)
HOST	The name of the SQL Server
INSTANCE	The name of the database instance
DATABASE	The name of the database to connect to.

Note: With this configuration, the Windows service for the S-Filer Server must run using the domain account configured for database access.

Configuration for Oracle

Manually download the JDBC drivers for Oracle and save it in the [Install folder]/server/ext/lib folder. You can download this driver here:

https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html

The file will look like this: ojdbc8-12.2.0.1.jar.

Variable	Value
USER	The name of the database user to use
PASSWORD	The password for the database user (note that the application will hide this password automatically after it has started, so you may see a different value after it has started)
DIALECT	Depends on the version of Oracle database: org.hibernate.dialect.OracleDialect (Oracle prior to version 8) org.hibernate.dialect.Oracle8Dialect (Oracle 8) org.hibernate.dialect.Oracle9Dialect (Oracle 9) org.hibernate.dialect.Oracle9iDialect (Oracle 9i) org.hibernate.dialect.Oracle10gDialect (Oracle 10 and newer)
DRIVER	oracle.jdbc.driver.OracleDriver
URL	jdbc:oracle:thin:@[HOST]:[PORT]:[XE](Replace the variables in the URL)
HOST	The name of the Oracle Server
PORT	The port on which Oracle is listening (default: 1521)
XE	The XID of the configuration database instance

Initializing the database

The tool used to initialize the database is the sfiler-config-cli, which is automatically installed with the server. There is a script called sfiler-config-cli (.bat for Windows and .sh for Linux) located in the [Install folder]/server folder.

Note

Before issuing the command to initialize the database, make sure you have installed the JDBC driver for your database in the [Install folder]/server/ext/lib directory.

You need to run the following command:

shell

sfiler-config-cli.[bat/sh] -l db_user_name -p *db_password* update-db-schema

The parameters db_user_name and db_password represents the credentials that will be used to connect to the database and perform the modifications. This will require alter, create, drop and other type of access so make sure the database user specified in the command has an admin role.

If you want to be prompted for the password instead of putting it on the command-line do not use the -p option, do not put any option for the password.

Creating a systemd service file

Create a unit file in the /etc/systemd/system/ directory and make sure it has correct file permissions. Execute as root or for non-root user acquire permission for these system folders.

For S-Filer server

shell

touch /etc/systemd/system/sfiler.service
chmod 664 /etc/systemd/system/sfiler.service

Open the sfiler.service file created in the previous step, and add the service configuration options

shell

[Unit]
Description=S-Filer-Server
Wants=network-online.target
After=network.target network-online.target

[Service]
Type=forking
WorkingDirectory=/home/sfiler/sfiler-server/script/
ExecStart=/bin/sh -x sfiler start
ExecReload=/bin/sh -x sfiler restart
ExecStop=/bin/sh -x sfiler stop
User=sfiler
Group=sfiler
PIDFile=/home/sfiler/sfiler-server/server/sfiler-server.pid

[Install]
WantedBy=multi-user.target

Notify systemd that a new file exists by executing the following command as root or for non-root user acquire permission to run these commands.

shell

systemctl daemon-reload
systemctl start sfiler.service

Always run the systemctl daemon-reload command after creating new unit files or modifying existing unit files. Otherwise, the systemctl start or systemctl enable commands could fail due to a mismatch between states of systemd and actual service unit files on disk.

Enable sfiler.service, so that it starts automatically at boot:

shell

systemctl enable sfiler.service

For S-Filer gateway

shell

touch /etc/systemd/system/sfiler-gateway.service
chmod 664 /etc/systemd/system/sfiler-gateway.service

Open the sfiler-gateway.service file created in the previous step, and add the service configuration options

shell

[Unit]
Description=S-Filer-Gateway
Wants=network-online.target
After=network.target network-online.target

[Service]
Type=forking
WorkingDirectory=/home/sfiler/sfiler-gateway/script/
ExecStart=/bin/sh -x sfiler-gateway start
ExecReload=/bin/sh -x sfiler-gateway restart
ExecStop=/bin/sh -x sfiler-gateway stop
User=sfiler
Group=sfiler
PIDFile=/home/sfiler/sfiler-gateway/gateway/sfiler-gateway.pid

[Install]
WantedBy=multi-user.target

Notify systemd that a new file exists by executing the following command as root or for non-root user acquire permission to run these commands.

shell

systemctl daemon-reload
systemctl start sfiler-gateway.service

Enable sfiler-gateway.service, so that it starts automatically at boot:

shell

systemctl enable sfiler-gateway.service

Administrative Console Configuration

By default, the S-Filer Administrative console is not configured to use SSL. If you want to activate SSL, you can do it before starting the S-Filer Server by using the sfiler-config-cli tool. There is a script called sfiler-config-cli (.bat for Windows and .sh for Linux) located in the [Install folder]/server folder.

Importing an existing private key prior to starting the Server

You can import an existing private key prior to starting the Server by using the sfiler-config-cli tool. There is a script called sfiler-config-cli (.bat for Windows and .sh for Linux) located in the [Install folder]/server folder.

You need to run the following command:

shell

sfiler-config-cli.[bat/sh] -l *db_user_name* -p *db_password* import-certificate-file -a *alias* -pw *keystore_password* -f *path/to/key_pair* -apply-configurator

The parameters db_user_name and db_password represents the credentials that will be used to connect to the database and perform the modifications. The alias is a unique name that will be stored in the database to identify this key. The keystore_password is the password protecting the keystore file that will be imported. The '-f' argument is the path to the keystore containing the private key to import.

Generating a private key prior to starting the Server

You generate a private key prior to starting the Server by using the sfiler-config-cli tool. There is a script called sfiler-config-cli (.bat for Windows and .sh for Linux) located in the [Install folder]/server folder.

You need to run the following command:

shell

sfiler-config-cli.[bat/sh] -l *db_user_name* -p *db_password* generate-key-pair -a *alias* -ks *key_size* -h *host* -d *duration* -apply-configurator

The parameters db_user_name and db_password represents the credentials that will be used to connect to the database and perform the modifications. The alias is a unique name that will be stored in the database to identify this key. The keysize is the size of the key that will be generated (supported values are 2048 and 4096). The host will become the CN attribute of the generated key. The duration is the validity period (in years) of the key that will be generated (value must be between 1 and 10).

Configuring the private key in the Administrative Console

If you prefer, you could use the Administrative Console to configure its own SSL private key. You will need to start the S-Filer Server first and access the Administrative Console with an unsecured URL:

http://server-host:8090/Login.action

In the left tree, you can access the 'Administrative Console' option.

You are then presented the Administrative Console configuration panel where you can modify some information.

Port: The port used to access the Administrative Console.
SSL: Determines if communications with the Administrative Console will be using SSL.
SSL/TLS private key: If SSL is activated, you need to choose the private key that will be used for the SSL communications. You need to add this key in the Certificate Manager (use the Certificate Management link in the left tree) prior to selecting it in the dropdown.

The Allow weak SSL/TLS ciphers can be set to Yes to enable the weak ciphers that were removed in S-Filer 4.5.3. The default is set to No.

Click on "Save" once you are done configuring the Administrative Console.

You need to restart the S-Filer Server after modifying any one of these properties.

Start your S-Filer Server

Windows

Go in the services manager and start the server. Locate the service called S-Filer Server and start it.

Linux

On the command line execute:

shell

service sfiler start

Depending on your version of UNIX (Linux, Solaris, BSD or other) it is possible that some adjustments are necessary in the start-up script. The version distributed has been validated for Red Hat-like environments.

Server Configuration

The server configuration will be done using the administrative console, which can be accessed at this address: (Replace server-host with the address or host name of the server's installation location.)

https://server-host:8090/Login.action

The login in the Administrative Console is done using the database credentials. The user specified to login will be the user performing the database modifications. Since the Administrative Console is only using data manipulation queries (insert, update, delete), it is advised not using a user with an admin role here.

User Name: The database user
Password: The database password

S-Filer Portal Initial Setup

You are then presented the initial configuration panel where you need to enter some information.

Server Name: Enter a name for your server instance. This name must match the one defined in the parameter cfg.sfiler.instance.name of the [Installfolder]/server/conf/sfiler.conf file. The default value in the configuration file is Server1 so make sure to update it if you choose another name. In this example we will use "mycompany_server".
IP Address: Enter the address or host name of your S-Filer Portal server's machine.
Port: This is the port that the S-Filer Portal server will listen to for communication with other components. The default value is "8088".
SSL: Determines if communications with the server will be using SSL.
SSL/TLS private key: If SSL is activated, you need to choose the private key that will be used for the SSL communications. You need to add this key in the Certificate Manager (use the Certificate Management link in the left tree) prior to selecting it in the dropdown.
Administrator Email: Enter the email address of the person that will administer S-Filer Portal.
License: Enter the license provided to you by Okiok. It is represented by a long string of characters including numbers and letters.
Default Language: Enter the language you want to use in the S-Filer Administrative Console.
Internal Authentication: Enter a name for the internal database authentication mechanism. The default value is "Business Partners".

Important

After creating the server instance in the Administrative Console, the property cfg.sfiler.instance.name in the [Installfolder]/server/conf/sfiler.conf file needs to be updated to match the selected server name. A server restart is required after this modification.

Setting Proxy rules

It is possible to relay transfer requests to the gateway or configure a web server (Apache or IIS) for performing this task. The main reason for using the web server application is if this one already has corporate certificates and cryptographic material. By delegating the relay requests to the S-Filer Portal Gateway, it is required to correctly configure all the certificates and cryptographic hardware needed to set up the proxy rules that are located in the Proxy in the installation package. A subdirectory contains sample configuration for Apache IIS.

Proxy rules for Apache

To set up the proxy rules for Apache, you must ensure that the modules mod_proxy and mod_proxy_http is installed and active. By default, Apache is distributed with two modules. However, they may not be activated. To activate them, open the main configuration file of Apache httpd.conf or apache.conf according to your operating system and make sure the following modules are activated (remove the # comment symbol).

mod_proxy
mod_proxy_http

One must then deploy the sfiler.conf under the Apache configuration tree. In most cases, copying the file in the directory conf.d sfiler.conf is sufficient. If this directory does not exist, you must insert the contents of sfiler.conf directly in the Apache configuration.

shell

<IfDefine SSL>
  SSLProxyEngine on
</IfDefine>

ProxyRequests off

#server
ProxyPass /sfiler/server/ http://domainName:8088/
ProxyPassReverse /sfiler/server/ http://domainName:8088/

#web interface
ProxyPass /sfiler/ http://domainName:8081/sfiler/
ProxyPassReverse /sfiler/ http://domainName:8081/sfiler/

<Location /domainName/>
  Order allow,deny
  Allow from all
</Location>

You must replace domainName with the proper URL and change the ports if not using the default port 8088 for the server and 8081 for the gateway.

Proxy for IIS

Proxying through IIS is done using Microsoft's Application Request Routing.

You will need to download Microsoft Application Request Routing.

File requestRouter_amd64.msi version 3 and rewrite_amd64_en-US.msi version 2.

To install Application Request Routing

Open a command prompt with administrator user rights.
Stop the WAS and WMSVC processes by entering the following:

shell

net stop was /y
net stop w3svc /y

Run requestRouter_amd64.msi:
Accept the End User License Agreement (EULA).
Finish the installation
Install the IIS URL Rewrite Module.
Run rewrite_amd64_en-US.msi
Accept the End User License Agreement (EULA) and Install
Complete the installation.
Start the WAS and W3SVC processes by entering the following:

shell

net start was
net start w3svc

Once installed you will see the Application Request Routing Cache, open this feature.

Go to the server proxy settings

Enable Proxy and leave all other fields with the defaults and apply the change. The warning is ok.

In your Web Site there will be a URL Rewrite Icon click on this icon to add a rule.

Click on add rule

Add the rule Pattern is sfiler/(.\*)

The rewrite URL for S-Filer make sure in the Action Properties that all options are active.

In my example the rewrite rule is https://host114.winsupp.com:8081/{R:0} if you chose another port for the HTTP protocol in the Gateway then use that one instead.

Test the rule using the application URL in my case https:/w2k8-vm-test01/sfiler/

Testing the rule shows the back references to rule 0 which matches the pattern and will pass the value sfiler/ which is what we want for the S-Filer Portal application.

Apply and restart IIS

Now we are ready to test the S-Filer Portal application.

The S-Filer gateway service must be restarted using Windows service.

IIS- Changing the MaxAllowedContentLength

You will need to change the maxAllowedContentLength setting in IIS to be able to transfer large files. The default value is 30000000 bytes, which is approximately 28.6MB, so with this value you will not be able to transfer files larger than 29 MB. The following shows how to change this value in IIS to be able to transfer lager files.

To change this, open IIS Admin, click on the Sites and Your Web Site.

Double click Configuration Editor scroll down to system.webServer -- security -- requestFiltering

Expand "requestLimits" and edit the maxAllowedContentLength setting to the desired level. The default value is 30000000 bytes, which is approximately 28.6MB. Change the setting to your desired amount. IIS 7.5 has a max size of 2GB (2147483648 bytes) and IIS 8.5 and 10.0 has a max size of 4GB (4294967295 bytes).

Restart IIS to apply the changes.

Updating the Server

It's possible to update an existing instance of S-Filer Server. This can be useful to add the newest features of S-Filer to your existing product while keeping your current configuration intact.

Updating using the installer

First, launch the installer. After you have read and accepted the license, you must select the installation type. Please select "Update".

Then, you are prompted to enter your existing installation directory. The Updater validates that the installation path provided contains an S-Filer instance and prevents the user from proceeding if a wrong path is specified.

After selecting your existing installation, you must choose a new temporary folder that will be used by the server. If the folder does not exist, it will be created during the installation. Make sure that you have write permission on the selected location.

Before the update begins, you will be prompted to stop your existing S-Filer service before proceeding with the installation. Although the Updater will try to stop it by itself, it is safer if the user does it himself. Updating over a running service may cause the installation to fail.

Finally, you must validate the parameters of the install before it starts copying files to the target system. If the parameters are valid, click the Install button to continue the installation. Make sure you have write access to your install directory and all its content. If the Updater is unable to install files to your install folder because of denied permission, the installation will abort.

After every update run the following command before starting the S-Filer server to be sure if there are schema updates, they will be done. If you forget to run the following command and there are schema updates when you login to the admin console you will get a message that the database schema needs to be updated.

shell

sfiler-config-cli.bat -l db_user_name -p *db_password* update-db-schema

Once the update is done, restart your service via the service manager. If you are using customized mail template, your pre-installation template will be backed-up in your install directory under /server/etc/mail.backup.

Updating using the command line

To launch the update, run the sfiler-server-installer.bin. Make sure you have proper permissions on the executable file. If this is not the case, run the following command:

shell

chmod 755 sfiler-server-installer.bin

Once the rights to the file are appropriate, start the installation directly from the command line:

shell

./sfiler-server-installer.bin

The first step of the installer prompts you to choose the language.

shell

[root@localhost tmp]# ./sfiler-server-installer.bin

Preparing to install
Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...

Launching installer...

===============================================================================

Choose Locale...
----------------


->1- English
  2- Español
  3- Français

CHOOSE LOCALE BY NUMBER:

After accepting the license, you are prompted for the installation type of the server. Please select "Update".

shell

DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): Y

===============================================================================
Choose Install Set
------------------

Please choose the Install Set to be installed by this installer.

->1- Complete Installation
  2- Update

ENTER THE NUMBER FOR THE INSTALL SET, OR PRESS \<ENTER\> TO ACCEPT THE
DEFAULT

  : 2

Next, you are prompted for the installation directory of the server. Please enter your existing S-Filer product directory. If the directory specified is wrong, the Updater won't be able to proceed with the update.

shell

===============================================================================
Choose Install Folder
---------------------

If you are upgrading, please choose your existing install directory
Where would you like to install?

  Default Install Folder: /usr/local/sfiler-server

ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT

  :

You must now choose a new temporary folder that will be used the server. If the folder does not exist, it will be created during the installation. Make sure that you have write permission on the selected location.

shell

===============================================================================
Temporary folder
----------------


Enter the location of the temporary folder that will be used by the
server. If the folder doesn't exist, it will be created. Please confirm that you
have write permissions in the selected location.

Please Choose a temporary folder (Default: /tmp):

Next, please stop your existing S-Filer Server if it is running. Although the Updater will try to stop it by itself in the install process, it is safer if the user does it himself. Updating over a running service may cause the installation to fail. Also, make sure that you have write access to your install directory and all its content. If the Updater is unable to install files to your install folder because of denied permission, the installation will abort.

shell

===============================================================================
Warning
-------

Make sure to stop the existing S-Filer Server service before starting
the nstallation

PRESS <ENTER> TO CONTINUE:
===============================================================================
Pre-Installation Summary
------------------------


Please Review the Following Before Continuing:

Product Name:
    S-Filer Server

Install Folder:
    /usr/local/sfiler-server

Link Folder:
    /root

Disk Space Information (for Installation Target):
    Required: 514,199,965 Bytes
    Available: 29,649,932,288 Bytes

PRESS <ENTER> TO CONTINUE:

Finally, if the install parameters are correct, press ENTER to complete the update of the S-Filer Portal Server.

shell

===============================================================================
Ready To Install
----------------

InstallAnywhere is now ready to install S-Filer Server onto your system
at the following location:

/usr/local/sfiler-server

PRESS <ENTER> TO INSTALL:

One can then follow the installation progress.

shell

Installing...
-------------

[==================|==================|==================|==============
[------------------|------------------|------------------|------------

The last step confirms that the installation was successful. In case of problems, please contact support. If you are using customize mail template, your pre-installation template will be backed-up in your install directory under /server/etc/mail.backup.

shell

===============================================================================
Installation Complete
---------------------

Congratulations. S-Filer Server has been successfully installed to:

    /usr/local/sfiler-server

PRESS <ENTER> TO EXIT THE INSTALLER:

shell

sfiler-config-cli.sh -l db_user_name -p *db_password* update-db-schema

All S-Filer Portal Configurations can be modified through the configuration CLI.

See the Gateway Configuration CLI Options manual.

Uninstalling the Server

Uninstalling the server is done by running the executable from the command line console or from the appropriate menu in the Windows graphics facilities. In both cases, the uninstaller will remove the server component but may not destroy all files (such as temporary files and log files). You may have to manually remove these files.

Uninstalling in Windows

On Windows, use the utility to add or remove programs. This utility is accessible from the Control Panel. It is very important to stop the S-Filer Portal server before starting the uninstall process.

Select S-Filer Server click the Uninstall/Change button.

You will then be prompted to confirm the uninstallation.

At the end of the Server uninstall process, it is possible some files were not deleted. It will be necessary to manually delete these files.

Once removed, you may be requested to reboot.

Uninstalling using the command line

Uninstalling the S-Filer Portal server on UNIX requires launching the uninstall utility in the command line. Make sure you have the needed access rights on:

shell

./Uninstall S-Filer Server

You will be prompted to confirm uninstall. Press ENTER to confirm. You may get an error message showing that not all files were removed simply use the following command to remove these:

shell

rm --rf sfiler-server

The Gateway

S-Filer Portal Gateway allows you to extend transfer protocols. Without this component, file transfers are reserved only to the HTTP protocol. With this gateway, it becomes possible to extend the S-Filer / Portal to use with FTP, FTPS and SFTP protocols. The gateway is a component that is usually installed in a Demilitarize Zone (DMZ).

This chapter introduces you to the S-Filer Portal Gateway installation as well as basic configuration.

Gateway Configuration

Create the Gateway

Return to the administrative console and click on the instance of the server in the left-hand tree view. In this case we click on mycompany_server.

In the right-hand panel, click on "Add a Gateway Client to the server". In the next panel, you need to configure the name and host of your gateway.

Name: Enter a name for your gateway instance. In this example we will use "mycompany_gateway".
IP Address/Hostname: Enter the address or host name of your s-filer gateway's machine.

Once you are satisfied with the configuration, click on "Add this Gateway Client". This will add the gateway instance.

In the left-hand tree view, if you expand "mycompany_server", you can see that "mycompany_gateway" is now present as the last option.

Enable web gui

Expand "mycompany_server / mycompany_gateway" and click on Configuration. In the right-hand panel, click on the top tab called Advanced Configurations.

In the right-hand panel, the single line of configuration called "Deploy Web Gui" has to be set to "Yes". Click on "Save".

Other configuration

Web user interface Configuration

Add Web GUI

Click on the left-hand tree view option "SFiler Portal". Click on the instance of the server. In this case we click on mycompany_server.

In the right-hand panel, click on Add a Web Client to the server. In the next panel, you can enter information about your instance of web user interface.

Name: mycompany_gui (this is an example for this scenario)

Click on "Add this Web Interface".

Additional configuration

Installing the Gateway

Basic configurations

Before being able to start the Gateway, you are required to import the Basic Configuration into the Gateway configuration files (the sfiler.conf and gui.conf). The Basic Configuration file regroups the configuration parameters that will make it possible to communicate securely with the S-Filer Server. It is required that you obtained those Basic Configuration for all the components that need to be installed. To have valid Basic Configuration, the Trusted Certificates must have been previously imported in the Administrative Console certificate Manager. When everything is in place, expand "mycompany_server / mycompany_gateway" in the right panel and click on the "download basic configurations" link. You will ask to use the sfiler-config-cli to import the basic configurations latter on in the installation procedure.

Repeat that operation for all the components that exist in your S-Filer infrastructure. As for the Gateway, you will be ask to use the sfiler-config-cli to import the basic configurations for the Web Interface.

Installing using the installer

The customer receives in their S-Filer Support community the appropriate package for their environment.

You can launch the installer by clicking directly on the executable sfiler-gateway-installer.exe. For Windows Core versions you can use the -i console parameter on the command line: sfiler-gateway-installer.exe -i console

Once you have accepted the license, you must select the installation type. A "Complete Installation" will install all the required components and configuration files. If you are installing S-Filer for the first time, please select this option. An ''Update'' will upgrade your existing S-Filer installation with new features and leave your configuration files intact.

Finally, you must choose a temporary folder that will be used the gateway. If the folder does not exist, it will be created during the installation.

The next step is simply to validate the installation. If all parameters are valid, click the Install button to start the installation of the Gateway.

You can follow the progress of the installation via the progress bar at the bottom of the window. To avoid any potential problems, S-Filer / Portal installs its own JRE (Java Runtime Environment).

At the end of the installation, if everything went well, a message appears indicating that the installation is complete. If an error occurs during installation, note the error, and contact technical support.

Once the installation process has completed, it is time to process with the Basic Configuration importation. These are the files that you should recover from the Administrative Console. It is now required to move those files in the "gateway" folder of the S-Filer Gateway installation. To proceed with the importation, you need to open a DOS Prompt in the S-Filer Gateway installation folder. In this folder, you now have a new command line utility called the sfiler-config-cli. Run the command with the arguments that matches your installation specificities:

shell

sfiler-config-cli.bat set-basic-config -bcdf [instance-name]-conf-gateway.txt -scf conf/sfiler.conf.template

Repeat the same operation for the Web Interface:

shell

sfiler-config-cli.bat set-basic-config -bcdf [instance-name]-conf-gateway.txt -scf conf/gui.conf.template

That last operation completes the installation procedure for the S-Filer Gateway. You can take some time to validate that the properties of the conf/sfiler.conf.template and conf/gui.conf.template files are filled. If that is not the case, consider looking at the sfiler-config-cli logs located in the /logs folder.

Installing Gateway using the command line

To start the installation, run the sfiler-gateway-installer.bin. Make sure you have proper permissions on the executable file. If this is not the case, run the following command:

shell

chmod 755 sfiler-gateway-installer.bin

Once the rights to the file are appropriate, start the installation directly from the command line:

shell

./sfiler-gateway-installer.bin

The first step of the installer prompts you to choose the language.

shell

[root@localhost tmp]# ./sfiler-gateway-installer.bin

Preparing to install

Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...
Launching installer...

===============================================================================

Choose Locale...
----------------

->1- English
  2- Español
  3- Français

CHOOSE LOCALE BY NUMBER:

The installation then prompts you to close all applications running in order to eliminate any possible conflict. Press ENTER to move to the next step.

shell

===============================================================================
S-Filer Gateway                                  (created with InstallAnywhere)
-------------------------------------------------------------------------------

Preparing CONSOLE Mode Installation...

===============================================================================
Introduction
------------

InstallAnywhere will guide you through the installation of S-Filer Gateway.

It is strongly recommended that you quit all programs before continuing
with this installation.

Respond to each prompt to proceed to the next step in the installation.
If you want to change something on a previous step, type 'back'.

You may cancel this installation at any time by typing 'quit'.

PRESS <ENTER> TO CONTINUE:

The license text will be displayed; you must accept the terms of use of the solution to continue the installation. Press Y (for Yes) to proceed to the next step. If you would like more information on the license, please contact support.

After accepting the license, you are prompted for the installation type of the gateway. A "Complete Installation" will install all the required components and configuration files. If you are installing S-Filer for the first time, please select this option. An ''Update'' will upgrade your existing S-Filer installation with new features and leave your configuration files intact.

shell

DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): Y

===============================================================================
Choose Install Set
------------------

Please choose the Install Set to be installed by this installer.

->1- Complete Installation
  2- Update

ENTER THE NUMBER FOR THE INSTALL SET, OR PRESS <ENTER> TO ACCEPT THE
DEFAULT

:

Next, you are prompted for the installation directory of the server. To accept the default directory, press ENTER key in the target directory if desired.

shell

===============================================================================
Choose Install Folder
---------------------

If you are upgrading, select the existing install directory.

Where would you like to install?

    Default Install Folder: /usr/local/sfiler-gateway

ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT

 :

You must now choose a temporary folder that will be used the gateway. If the folder does not exist, it will be created during the installation. Make sure that you have write permission on the selected location.

shell

===============================================================================
Temporary folder
----------------

Enter the location of the temporary folder that will be used by the
Gateway. If the folder doesn't exist, it will be created. Please confirm that you
have written permissions in the selected location.

Please Choose a temporary folder (DEFAULT: /tmp):

shell

===============================================================================
Startup script name
-------------------

Enter the name of the startup script. If you are installing on a machine
that already has a Gateway installed, be careful to choose a different file
name than the one used in previous installations.

Startup script name (DEFAULT: sfiler-gateway):

===============================================================================
Choose the startup script path
------------------------------

Select the path where you would like to have the startup script. If you
have root access, select option 1, otherwise choose option 2 to install them
in the install folder.

->1- /etc/init.d
  2- Installed Folder (non root access)

ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE
DEFAULT:

The next step is simply to confirm the settings selected.

shell

===============================================================================
Pre-Installation Summary
------------------------

Please Review the Following Before Continuing:

Product Name:
    S-Filer Gateway

Install Folder:
    /usr/local/sfiler-gateway

Link Folder:
    /root

Disk Space Information (for Installation Target):
    Required: 447,100,864 Bytes
    Available: 31,342,125,056 Bytes

PRESS <ENTER> TO CONTINUE:

If the parameters are correct, press ENTER to continue installing S-Filer Gateway / Portal.

shell

===============================================================================
Ready To Install
----------------

InstallAnywhere is now ready to install S-Filer Gateway onto your system
at the following location:
    /usr/local/sfiler-gateway

PRESS <ENTER> TO INSTALL:

One can then follow the installation progress.

A final step confirms that the installation was successful. In case of problems, please contact support.

shell

===============================================================================
Installation Complete
---------------------

Congratulations. S-Filer Gateway has been successfully installed to:
    /usr/local/sfiler-gateway

Your old themes has been saved at:
    /usr/local/sfiler-gateway/gateway/

PRESS <ENTER> TO EXIT THE INSTALLER:

Once the installation process has completed, it is time to process with the Basic Configuration importation. These are the files that you should recover from the Administrative Console. It is now required to move those files in the "gateway" folder of the S-Filer Gateway installation. To proceed with the importation, you need to open a shell in the S-Filer Gateway "gateway" folder. In this folder, you now have a new command line utility called the sfiler-config-cli. Run the command with the arguments that matches your installation specificities:

shell

sfiler-config-cli.sh set-basic-config -bcdf [instance-name]-conf-gateway.txt -scf conf/sfiler.conf.template

Repeat the same operation for the Web Interface:

shell

sfiler-config-cli.sh set-basic-config -bcdf [instance-name]-conf-gateway.txt -scf conf/gui.conf.template

At this point, you can now launch the S-Filer Gateway by running the following start-up script:

shell

service sfiler-gateway start

Updating the Gateway

It is possible to update an existing instance of S-Filer Gateway. This can be used to add the newest feature of S-Filer to your existing product while keeping your current configuration intact.

Updating the Gateway using the installer

First, launch the installer. After you have read and accepted the license, you must select the installation type. Please select "Update".

After selecting your existing installation, you must choose a new temporary folder that will be used by the gateway. If the folder does not exist, it will be created during the installation. Make sure that you have write permission on the selected location.

Before the update begins, you will be prompted to stop you existing S-Filer service before proceeding with the installation. Although the Updater will try to stop it by itself, it is safer if the user does it himself. Updating over a running service may cause the installation to fail.

Finally, you must validate the parameters of the installer before it starts copying files to the target system. If the parameters are valid, click the Install button to continue the installation. Make sure that you have write access to your install directory and all its content. If the Updater is unable to install files to your install folder because of denied permission, the installation will abort.

Once the update is done, restart your service via the service manager. If you are using a customize theme, it has been saved under /sfiler-gateway/gateway/webapps.backup

Updating the Gateway using the command line

To launch the update, run the sfiler-gateway-installer.bin. Make sure you have proper permissions on the executable file. If this is not the case, run the following command:

shell

chmod 755 sfiler-gateway-installer.bin

Once the rights to the file are appropriate, start the installation directly from the command line:

shell

./sfiler-gateway-installer.bin

The first step of the installer prompts you to choose the language.

shell

[root@localhost tmp]# ./sfiler-gateway-installer.bin

Preparing to install
Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...

Launching installer...

===============================================================================
Choose Locale...
----------------

->1- English
  2- Español
  3- Français

CHOOSE LOCALE BY NUMBER:

After accepting the license, you are prompted for the installation type of the server. Please select "Update".

shell

DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): Y

===============================================================================

Choose Install Set
------------------

Please choose the Install Set to be installed by this installer.

->1- Complete Installation
  2- Update

ENTER THE NUMBER FOR THE INSTALL SET, OR PRESS <ENTER> TO ACCEPT THE
DEFAULT

  : 2

Next, you are prompted for the installation directory of the gateway. Please enter your existing S-Filer product directory. If the directory specified is wrong, the Updater won't be able to proceed with the update.

shell

===============================================================================
Choose Install Folder
---------------------

If you are upgrading, select the existing install directory.

Where would you like to install?

    Default Install Folder: /usr/local/sfiler-gateway

ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT

    :

You must now choose a new temporary folder that will be used by the gateway. If the folder does not exist, it will be created during the installation. Make sure that you have write permission on the selected location.

shell

===============================================================================
Temporary folder
----------------

Enter the location of the temporary folder that will be used by the
Gateway. If the folder doesn't exist, it will be created. Please confirm that you
have written permissions in the selected location.

Please Choose a temporary folder (DEFAULT: /tmp):

Next, please stop your existing S-Filer Gateway if it is running. Although the Updater will try to stop it by itself in the install process, it is safer if the user does it himself. Updating over a running service may cause the installation to fail. Also, make sure that you write access to your install directory and all its content. If the Updater is unable to install files to your install folder because of denied permission, the installation will abort.

shell

===============================================================================
Warning
-------

Make sure to stop the existing S-Filer Gateway service before starting
the installation.

PRESS <ENTER> TO CONTINUE:

===============================================================================

Pre-Installation Summary
------------------------

Please Review the Following Before Continuing:

Product Name:
    S-Filer Gateway

Install Folder:
    /usr/local/sfiler-gateway

Link Folder:
    /root

Disk Space Information (for Installation Target):
    Required: 447,080,253 Bytes
    Available: 30,207,270,912 Bytes

PRESS <ENTER> TO CONTINUE:

Finally, if the install parameters are correct, press ENTER to complete the update of the S-Filer Portal Gateway.

shell

===============================================================================

Ready To Install
----------------

InstallAnywhere is now ready to install S-Filer Gateway onto your system
at the following location:

    /usr/local/sfiler-gateway

PRESS <ENTER> TO INSTALL:

One can then follow the installation progress.

shell

Installing...
-------------

[==================|==================|==================|==============
[------------------|------------------|------------------|------------

The last step confirms that the installation was successful. In case of problems, please contact support. If you are using a customize theme, it has been saved under /sfiler-gateway/gateway/webapps.backup

shell

===============================================================================
Installation Complete
----------------

Congratulations. S-Filer Gateway has been successfully installed to:
    /usr/local/sfiler-gateway

Your old themes has been saved at:
    /usr/local/sfiler-gateway/gateway/

PRESS <ENTER> TO EXIT THE INSTALLER:

Uninstalling the Gateway

Uninstalling the Gateway in Windows

For the Windows environment, use the utility to add or remove programs. This utility is accessible from the Control Panel. It is very important to stop the S-Filer Portal Gateway before starting the uninstall process or else it is possible that the uninstall process fails because some files in use cannot be removed successfully.

Select the S-Filer Gateway program and click the Uninstall/Change button.

You will then be prompted to confirm the uninstalling process of the Gateway.

At the end of the Gateway uninstall process, it is possible some files were not deleted. It will be necessary to manually delete these files.

Uninstalling the Gateway using the command line

Uninstalling the S-Filer Portal server on Unix requires launching the uninstall utility in the command line. Make sure you have the needed access rights on:

shell

./Uninstall_S-Filer Gateway

You will be prompted to confirm uninstall. Press ENTER to confirm. You may get an error message showing that not all files were removed simply use the following command to remove these.

shell

rm --rf sfiler-gateway

Once this step is completed, all components of the S-Filer Portal Gateway will be deleted.

Performance tuning configuration

The following parameters can be changed to tune the performance characteristics of S-Filer.

Configuration key	Location	Description	Default value
wrapper.java.initmemory	File: conf/wrapper.conf	Defines the amount of memory used by Java when starting. The value is in MB.	256
wrapper.java.maxmemory	File: conf/wrapper.conf	Defines the maximum amount of memory used by the java application. This value should be increased to handle more requests concurrently. The server will use from 512 Mb to 1 Gb of memory for its basic processes. Most requests will require 1 to 2 MB of memory to be handled. A value of 4 Gb should be able to handle close to 1000 concurrent requests. Reports require a lot more memory, when generating large reports, it may be necessary to increase the memory.	512
Receive Timeout	Administrative Console > [Server Name] > Configuration > Tab: Advanced Configurations	The number of milliseconds that the server will wait on a socket before receiving a response when it connects to any system.	30000 (30 seconds)
Inactivity timeout	Administrative Console > [Server Name] > Configuration > Tab: Advanced Configurations	Number of seconds before a user session times out. If a user does not make a request within this time, its authentication token will be invalidated. Note that ideally, this should be at least as long as the session timeout in the web interface to ensure a pleasant user experience.	1800(30 minutes)
Timeout	Administrative Console > [Server Name] > Configuration > Tab: Administrative Console	Not currently used	30000

Accessing the S-Filer portal

If you are working locally, you can access the user interface at this address: https://gateway-host:8081/sfiler/

username: sfiler-master
password: sfiler

Configuration manager

Does not require extra file system modification to function.

S-Filer Portal Web Interface

For S-Filer Portal's web interface to function, it is mandatory to prepare a location for its configuration file and to set an environment variable configured with the path to reach this file.

The environment variable to set is called: SFILER_WEB_CONFIG_PATH

Its content must be the path to the configuration file, ex: C:\MyPath\conf\gui.conf

The file to use will be created and managed by the configuration manager in the instance of the S-Filer Portal's Web Interface. A web interface instance creation will generate this file. If you make modifications to the instance in the configuration manager, this file may be updated depending on what you have changed.

The command line interface (CLI)

The CLI (Command Line Interface) is an S-Filer Portal component that allows file transfers in a command line mode. The CLI is usually used through scripts to automate recurring transfers.

This chapter introduces you to the S-Filer Portal Command Line Interface installation.

Installing the CLI

The customer receives in their S-Filer Support community the appropriate package for their environment.

Installing using the installer

You can launch the installer by clicking directly on the executable sfiler-cli-installer.exe. For Windows Core versions you can use the -i console parameter on the command line: sfiler-cli-installer.exe -i console

You are then prompted to read and accept the license to use the product S-Filer CLI. To accept the license, you must press the Next button. If you would like more information about the license, please contact your technical support.

Once you have accepted the license, you must enter the destination directory. You can browse your file system using the Choose button. Once the directory is specified, press the Next button to proceed to the next step. In the event you wish to return to the default location, simply click the Restore Default Folder button.

The next step prompts you to confirm your selection and proceed with installation.

You can follow the progress of the installation via the progress bar at the bottom of the window. To avoid any potential problems, the CLI installs its own JRE (Java Runtime Environment).

At the end of the installation, if everything went well, a message appears indicating that the installation is completed. If an error occurs during installation, note the error, and contact technical support.

Installing using the command line

To start the installation, run the sfiler-cli-installer.bin. Make sure you have proper permissions on the executable file. If this is not the case, run the following command:

shell

chmod 755 sfiler-cli-installer.bin

Once the rights to the file are appropriate, start the installation directly from the command line

shell

./sfiler-cli-installer.bin

The first step of the installer prompts you to choose the language.

shell

[root@localhost tmp]# ./sfiler-cli-installer.bin

Preparing to install

Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...
Launching installer...

===============================================================================
Choose Locale...
-------------

->1- English
  2- Español
  3- Français

CHOOSE LOCALE BY NUMBER:

Then, the installation prompts you to close all applications running in order to eliminate any possible conflict. Press ENTER to move to the next step.

shell

===============================================================================
SFiler-CLI (created with InstallAnywhere)
------------------------------------------------------------

Preparing CONSOLE Mode Installation...

===============================================================================
Introduction
----------

InstallAnywhere will guide you through the installation of SFiler-CLI.
Version : 4.19.0.0

It is strongly recommended that you quit all programs before continuing
with this installation.

Respond to each prompt to proceed to the next step in the installation.
If you want to change something on a previous step, type 'back'.

You may cancel this installation at any time by typing 'quit'.

PRESS <ENTER> TO CONTINUE:

After accepting the license, you are prompted for the installation directory of the CLI. To accept the default directory, press ENTER key in the target directory if desired.

shell

DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): y

===============================================================================
Choose Install Folder
---------------------

Where would you like to install?
    Default Install Folder: /usr/local/SFiler-CLI

ENTER AN ABSOLUTE PATH, OR PRESS \<ENTER\> TO ACCEPT THE DEFAULT
    :

The next step is simply to confirm the settings selected.

shell

===============================================================================
Pre-Installation Summary
-------------------------

Please Review the Following Before Continuing:

Product Name:
    SFiler-CLI

Install Folder:
    /usr/local/SFiler-CLI

Java VM Installation Folder:
    /usr/local/SFiler-CLI/jre

Disk Space Information (for Installation Target):
    Required: 332,369,003 Bytes
    Available: 30,528,475,136 Bytes

PRESS <ENTER> TO CONTINUE:

If the parameters are correct, simply press ENTER to complete installation of the CLI.

shell

===============================================================================

Ready To Install

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

InstallAnywhere is now ready to install SFiler-CLI onto your system at
the following location:

    /usr/local/SFiler-CLI

PRESS <ENTER> TO INSTALL:

One can then follow the installation progress.

shell

Installing...
-------------

[==================|==================|==================|==============
[------------------|------------------|------------------|----------

The last step confirms that the installation was successful. In case of problems, please contact support.

shell

===============================================================================
Installation Complete
---------------------

Congratulations. SFiler-CLI has been successfully installed to:
    /usr/local/SFiler-CLI

PRESS <ENTER> TO EXIT THE INSTALLER:

Uninstalling the CLI

Uninstalling the CLI is done by running the executable from the command line console or from the appropriate menu in the Windows graphics facilities. In both cases, the uninstaller will remove the CLI component but may not destroy all files (such as temporary files and log files). You may have to manually remove these files.

Uninstalling in Windows

On Windows, use the utility to add or remove programs. This utility is accessible from the Control Panel.

Select SFiler-CLI click the Uninstall/Change button.

You will then be prompted to confirm the uninstallation.

At the end of the CLI uninstall process, it is possible some files were not deleted. It will be necessary to manually delete these files.

Uninstalling using the command line

Uninstalling the CLI on UNIX requires launching the uninstall utility in the command line. Make sure you have the needed access rights on:

shell

./Uninstall SFiler-CLI

You will be prompted to confirm uninstall. Press ENTER to confirm. You may get an error message showing that not all files were removed simply use the following command to remove these:

rm --rf SFiler-CLI

Command line interface arguments

shell

Usage: sfiler [options] [command] [command options]
    Options:
        -h, --help
            Display this help screen
            Default: false
        -N
            No SSL Warning. Do not warn if the server address does not use SSL.
            Default: false
        -l
            The username to use to perform the action (ex: user@domain)
        -np
            Do not prompt. Never prompt for information.
            Default: false
        -op
            The obfuscated (hidden) password to authenticate
        -p
            The password to authenticate
        -q
            Be quiet (less output on screen)
            Default: false
        -s
            The URL of the server to use. (Ex: https://[PUBLIC ADDRESS]/sfiler/server/ 
            or https://[internal address]:8088/)
        -sso
            Authenticate using a Kerberos token. This is a transparent
            authentication.
            Default: false
        -ui
            User impersonation. When listing, erasing or downloading files, this
            options allows the path to resolve as if the impersonated user was
            logged in.
        -v
            Verbose (more output on screen)
            Default: false
    Commands:
        delete  Delete a file or folder
            Usage: delete [options] The path of the file or folder to delete. (ex:
            /Inbox/folder1/test.txt)
        download Download a file
            Usage: download [options] The path of the file to download. (ex:
            /Inbox/folder1/test.txt)
                Options:
                    -V
                        (Optional) The version number of the file to retrieve, if omitted,
                        retrieves the latest version.
                    -a
                        Save As. The name to use when saving the file on disk. Default:
                        Original filename from server.
                    -o
                        Overwrite the file on disk without asking.
                        Default: false
        hide-password Obfuscate (encode) a password so that it can be written in
        a file and not be easily recovered.
            Usage: hide-password [options]
        list List files and folders
            Usage: list [options] The path of the folder to list. (ex:
            /Inbox/folder1)
        list-versions List versions of a file
            Usage: list-versions [options] The path of the file to list. (ex:
            /Inbox/folder1/test.txt)
        mkdir Create folders
            Usage: mkdir [options] <folder_to_create>
        move Move/rename a remote file or folder
            Usage: move [options] <source_path> <destination_path>. If the
            destination path starts with a '/', it is absolute, otherwise it is
            considered relative to the source path.
        send-email Send a file securely to an email address
            Usage: send-email [options] Files to upload
                Options:
                    * -r
                        Comma separated list of email addresses to which the files will be
                        sent.
                    -t
                        Specify a theme to override the default notification theme.
                    -tc
                        Default: 0
                    -td
                        Set an absolute expiration date. After this date, the file cannot
                        be downloaded, it will be deleted. (ex: 2011-12-31)
                    -th
                        Set a relative expiration date. The file will expire in X hours
                        from now. (ex: 2)
                        Default: 0
                    -wp
                        Password to protect the files. You must communicate this password
                        to recipients so they can download the files.
                    -x
                        Message to send to recipients
        send-recipients Send a file only to some recipients of a community
            Usage: send-recipients [options] Files to upload
                Options:
                    * -c
                        The community from which the recipients are selected. You can get
                        the community names by listing the root.
                    -f
                        Wait for all post-processing tasks to be completed before the
                        command ends.
                        Default: false
                    -m
                        The default domain name for recipients. Recipients can use the
                        @domain notation to override this setting.
                    * -r
                        Comma separated list of usernames which will receive the file.
                        These users must be members of the community.
                    -t
                        Override the notification theme to use.
                    -tc
                        Default: 0
                    -td
                        Set an absolute expiration date. After this date, the file cannot
                        be downloaded, it will be deleted. (ex: 2011-12-31)
                    -th
                        Set a relative expiration date. The file will expire in X hours
                        from now. (ex: 2)
                        Default: 0
                    -x
                        Message to send to recipients
        upload Upload a file
            Usage: upload [options] Files to upload
                Options:
                    * -d
                        Upload destination. This is the path where we should upload the
                        file. (ex: /Inbox/folder1)
                    -f
                        Wait for all post-processing tasks to be completed before the
                        command ends.
                        Default: false
                    -t
                        Override the notification theme to use.
                    -tc
                        Default: 0
                    -td
                        Set an absolute expiration date. After this date, the file cannot
                        be downloaded, it will be deleted. (ex: 2011-12-31)
                    -th
                        Set a relative expiration date. The file will expire in X hours
                        from now. (ex: 2)
                        Default: 0
                    -x  
                        Message to send to recipients

Annexe 1 - Installation and Integration CheckList

S-Filer Installation Reference Card

Configuration	Default Value	Actual Value (Instance 1)	Actual Value (Instance 2)
SERVER
Address	localhost
Administrative Console port	8080
Administrative Console URL	`http(s)://localhost:8090/`
Web services port	8088
Web services URL	`http(s)://localhost:8088/`
Email server	localhost
Email port	25

GATEWAY
Address	localhost
Web server port	8081
FTP port	21
FTPS (explicit) port	990
FTP data port	60000-60020
SFTP port	22

GUI
Address	localhost
Port	8081
Context	/sfiler
GUI URL	`http(s)://localhost:8081/sfiler`
Server Proxy	`http(s)://localhost:8081/sfiler/server`	/server	/server

APACHE REVERSE PROXY
Address	localhost
Port	443

IIS REVERSE PROXY
Address	localhost
Port	443

Installing S-Filer Portal ​

System configurations ​

Package content ​

The Server ​

Installing the Server ​

Installing using the installer ​

Installing using the command line ​

Configuring the database ​

Configuration for MySQL ​

Configuration for SQL Server ​

Server using the default instance running on a static port with SQL native authentication (not a Windows account) ​

Server using a named instance with SQL native authentication ​

Server using the default instance running on a static port with Windows authentication (a domain account is used) ​

Server using a specific instance running on a static port with Windows authentication (a domain account is used) ​

Server using a named instance with Windows authentication ​

Configuration for Oracle ​

Initializing the database ​

Creating a systemd service file ​

For S-Filer server ​

For S-Filer gateway ​

Administrative Console Configuration ​

Importing an existing private key prior to starting the Server ​

Generating a private key prior to starting the Server ​

Configuring the private key in the Administrative Console ​

Start your S-Filer Server ​

Server Configuration ​

S-Filer Portal Initial Setup ​

Setting Proxy rules ​

Proxy rules for Apache ​

Proxy for IIS ​

To install Application Request Routing ​

IIS- Changing the MaxAllowedContentLength ​

Updating the Server ​

Updating using the installer ​

Updating using the command line ​

Uninstalling the Server ​

Uninstalling in Windows ​

Uninstalling using the command line ​

The Gateway ​

Gateway Configuration ​

Create the Gateway ​

Enable web gui ​

Other configuration ​

Web user interface Configuration ​

Add Web GUI ​

Additional configuration ​

Installing the Gateway ​

Basic configurations ​

Installing using the installer ​

Installing Gateway using the command line ​

Updating the Gateway ​

Updating the Gateway using the installer ​

Updating the Gateway using the command line ​

Uninstalling the Gateway ​

Uninstalling the Gateway in Windows ​

Uninstalling the Gateway using the command line ​

Performance tuning configuration ​

Accessing the S-Filer portal ​

Configuration manager ​

S-Filer Portal Web Interface ​

The command line interface (CLI) ​

Installing the CLI ​

Installing using the installer ​

Installing using the command line ​

Uninstalling the CLI ​

Uninstalling in Windows ​

Uninstalling using the command line ​

Command line interface arguments ​

Annexe 1 - Installation and Integration CheckList ​

Installing S-Filer Portal

System configurations

Package content

The Server

Installing the Server

Installing using the installer

Installing using the command line

Configuring the database

Configuration for MySQL

Configuration for SQL Server

Server using the default instance running on a static port with SQL native authentication (not a Windows account)

Server using a named instance with SQL native authentication

Server using the default instance running on a static port with Windows authentication (a domain account is used)

Server using a specific instance running on a static port with Windows authentication (a domain account is used)

Server using a named instance with Windows authentication

Configuration for Oracle

Initializing the database

Creating a systemd service file

For S-Filer server

For S-Filer gateway

Administrative Console Configuration

Importing an existing private key prior to starting the Server

Generating a private key prior to starting the Server

Configuring the private key in the Administrative Console

Start your S-Filer Server

Server Configuration

S-Filer Portal Initial Setup

Setting Proxy rules

Proxy rules for Apache

Proxy for IIS

To install Application Request Routing

IIS- Changing the MaxAllowedContentLength

Updating the Server

Updating using the installer

Updating using the command line

Uninstalling the Server

Uninstalling in Windows

Uninstalling using the command line

The Gateway

Gateway Configuration

Create the Gateway

Enable web gui

Other configuration

Web user interface Configuration

Add Web GUI

Additional configuration

Installing the Gateway

Basic configurations

Installing using the installer

Installing Gateway using the command line

Updating the Gateway

Updating the Gateway using the installer

Updating the Gateway using the command line

Uninstalling the Gateway

Uninstalling the Gateway in Windows

Uninstalling the Gateway using the command line

Performance tuning configuration

Accessing the S-Filer portal

Configuration manager

S-Filer Portal Web Interface

The command line interface (CLI)

Installing the CLI

Installing using the installer

Installing using the command line

Uninstalling the CLI

Uninstalling in Windows

Uninstalling using the command line

Command line interface arguments

Annexe 1 - Installation and Integration CheckList