filecap installation manual - contronex

FileCap Kopersteden 24-4 7547 TK Enschede Netherlands T +31 (0)53 428 56 16 E [email protected]

Date: Version:

18-10-2012 1.3

FileCap Installation Manual

2 / 36

Table of contents

1. Preparing your environment .............................................................................................................. 3

1.1 Pre-requirements .......................................................................................................................... 3 1.2 Creating the Virtual Machine ......................................................................................................... 3 1.3 Uploading the FileCap ISO ......................................................................................................... 11

2. FileCap installation and configuration ............................................................................................. 13

2.1 Installing FileCap ......................................................................................................................... 13 2.2 Configuring FileCap .................................................................................................................... 16 2.3 Changing settings ....................................................................................................................... 17

3. FileCap WebAdmin ......................................................................................................................... 19

3.1 WebAdmin login .......................................................................................................................... 19 3.2 General Settings ......................................................................................................................... 20 3.3 Network Settings ......................................................................................................................... 23 3.4 Plugins ......................................................................................................................................... 24 3.5 Security settings .......................................................................................................................... 25 3.6 Reporting ..................................................................................................................................... 31 3.7 Extra ............................................................................................................................................ 33

4. Installing FileCap Outlook Plugins .................................................................................................. 34

4.1 Pre-requirements ........................................................................................................................ 34 4.2 Installation ................................................................................................................................... 34


3 / 36

1. Preparing your environment

This manual will explain in detail how to install FileCap as a Virtual Machine. The installation used as an example in this manual, was performed on VMware ESXi 5.0. The minimum VMware version to install FileCap on, is VMware ESX(i) 3.x and higher, VMware Play or VMware Workstation.

1.1 Pre-requirements

It is recommended to install the FileCap server in the DMZ of your IT network. The following ports need to be configured on your firewall to allow communication between the FileCap server and the internet.

Port 80 (TCP) from the internet to the FileCap server (inbound)

Port 443 (TCP) from the internet to the FileCap server (inbound)

Port 53 (UDP) from the DMZ to a DNS server

Port 25 (TCP) from the DMZ to your mail server

If you configure FileCap to use Directory Services (LDAP/LDAPS), please make sure you allow the FileCap server to communicate on following ports:

Port 389 (TCP) from the DMZ to the LDAP server within the LAN (when using standard LDAP)

Port 636 (TCP) from the DMZ to the LDAP server within the LAN (when using LDAP over SSL)

Note: In some cases it may be required to configure mail relaying on the mail server for the FileCap server.

1.2 Creating the Virtual Machine

Create a New Virtual Machine, choose Custom installation and click Next.


4 / 36

Provide a name for your FileCap server and click Next.

Select the resource pool in which the FileCap server will run.


5 / 36

Select a data storage in which FileCap will be installed.

Select the Virtual Machine Version this FileCap installation should use.


6 / 36

Specify that this Virtual Machine should use Debian GNU/Linux 6 (64-bit) as its Guest Operating System.

Specify that FileCap will use 1 virtual socket and 1 core per virtual socket.


7 / 36

Configure the amount of virtual memory this Virtual Machine may use. We recommend using a minimum of 2048MB of virtual memory. The amount of virtual memory depends on the amount of users that will make use of the FileCap service.

Configure the network connection that will be used for FileCap.


8 / 36

You can specify the type of SCSI controller the FileCap server will use. Leave these default settings as they are and click Next.

Use the default disk settings and click Next.


9 / 36

In this window you can specify the virtual disk size and provisioning policy. The specified disk size

depends on the amount of users that will make use of the FileCap service. We recommend using a

minimum disk size of 80 Gigabytes for a FileCap server.

Keep the default settings and click Next.


10 / 36

Make sure the Virtual Machine settings are correct, click Finish to end the Virtual Machine configuration.


11 / 36

1.3 Uploading the FileCap ISO

You will need to upload your FileCap ISO to the ESX data storage in order to install FileCap.

Start the vSphere client and select the ESX server on which you will install FileCap.

Browse the data storage on which you will upload the FileCap ISO.

The datastore browser will now open. Specify the folder in which the FileCap ISO will be uploaded and

click on the upload icon. Click Upload File.

Select the FileCap ISO that you wish to upload and press OK. The specified file will now be uploaded.


12 / 36

You will need to configure the Virtual Machine to boot from the FileCap ISO file. Right click on the Virtual Machine which was created in the previous step and click Edit Settings

In the left column click on CD/DVD drive 1 and select Datastore ISO File on the right side. Click Browse

to open a navigation window from where you can select the ISO file.

Specify the FileCap ISO that will be used for the installation and click OK.

Make sure the ISO will be loaded by selecting Connect at power on.

If configured correctly, you will notice that the CD/DVD drive will be linked to the data storage on which

the ISO was uploaded.

The configuration of the FileCap Virtual Machine is now finished.


13 / 36

2. FileCap installation and configuration

This chapter describes the actual installation of FileCap.

2.1 Installing FileCap

Power on the FileCap Virtual Machine. It will boot from the specified ISO file and the FileCap installation screen will be displayed in the console.

Press Enter to start the FileCap installation Select the keyboard layout you wish to use and press Enter


14 / 36

Additional components will now be loaded.

Configure a password for the user and press Continue

Re-enter the password for verification purposes and press Continue. The installation will now load

additional components and create a partition configuration. Review the partition table and choose Yes if

you wish to continue.


15 / 36

The FileCap installation will now format the partitions and install the base system.

After the installation has finished, the machine will reboot and start FileCap.

The FileCap installation is now finished.


16 / 36

2.2 Configuring FileCap

When the installation has finished you will be prompted to login. Username: filecap Password: the password you specified during the installation process.

When logged in, the FileCap Console Menu and WebAdmin URL will be displayed. In this menu you can configure your FileCap server.

Your FileCap web interface will be available on: https://IPaddress/FileCap/

https://ipaddress/FileCap/


17 / 36

2.3 Changing settings

This section describes the required the changes for FileCap to be fully operational in your environment.

2.3.1 Change IP Address

In this menu you can edit the network configuration of the FileCap server. We recommend doing this through the WebAdmin after the initial installation. You can also edit the network settings through the WebAdmin interface. IP Address: Enter a valid IP Address for the FileCap server. Network Mask: Enter a valid Network Mask. Default Gateway: Enter the Default Gateway which will be used by the FileCap server. Primary DNS: Enter a primary DNS Secondary DNS: Enter a secondary DNS Press “Y” if you want to save the new configuration.


18 / 36

2.3.2 Change Hostname

In this menu you can change the hostname and domain name. The FQDN will be automatically set based on the hostname and domain name. New hostname: Enter a new hostname for the FileCap server. Current domain name: Enter the domain name

2.3.3 Admin Prompt

If you select the “Admin Prompt” option in the main menu, you will get a bash shell. Press CTRL + D to return to the main menu.

Other options

2.3.4 Other options

The three remaining options in the main menu are self-explanatory and will not be covered in this manual.


19 / 36

3. FileCap WebAdmin

This chapter describes all settings and options available in the FileCap WebAdmin interface.

3.1 WebAdmin login

The URL of your FileCap WebAdmin page will be displayed in the console menu on the FileCap machine.

Browse to the displayed URL and you will be prompted to log in. The default WebAdmin login is: Username: filecap Password: FileCap123


20 / 36

3.2 General Settings

3.2.1 Owner Settings

Company name: Enter your company name here. This will be used in the emails sent by FileCap. Your company image: Select an image to upload. This image will be displayed on your FileCap

portal. Your background image: Select a background image to be uploaded. This image will be used as a

background image on your FileCap portal. Click Save to apply the settings.


21 / 36

3.2.2 Language settings

On this page you can configure the language that will be used on the FileCap website. Select the language you want to use from the drop-down menu and press Save.

3.2.3 System settings

You can specify the general system settings of your FileCap server on this page. Domains to allow: Specify the domains you wish to allow, divided by a space, for example: domain1.com domain2.com

The domains specified here are the domains external users (outside the local network, somewhere on the internet) can send files to. If you specify external domains other than your local domain, external users can send files to those domains also.

Networks to allow: Specify the networks you wish to allow, divided by a space, for example: 10.0.0.1/255.255.255.0 172.16.100.0/255.255.255.0 All local networks specified here will have access to the FileCap-portal and will be allowed to transfer files to any recipient (internal or external).

Update Package: You can upload an update package for FileCap here when there is one available. License file: Upload your license file to activate the FileCap server. SSL Certificate: Specify an SSL certificate to use for HTTPS connection.

The password of the certificate must be “filecap”.

Maximum days to store files: Enter the maximum amount of days the uploaded file will be available before it gets deleted. When user editable is enabled, the user can specify the amount of days before deletion (To the maximum amount of days you specified).

Max. number of downloads: Enter the maximum amount of times the uploaded file can be

downloaded. When user editable is enabled, the user can specify the maximum amount of downloads (Up to the maximum amount of downloads specified in the admin-panel).

Use antivirus: Specify if FileCap should scan the uploaded files with the ClamAV antivirus engine. Show first page: When set to “Yes”, a welcome-screen will be displayed when opening

the FileCap-portal. When set to “No”, users can login immediately to upload a file.


22 / 36

License expires: Shows when your license expires.


23 / 36

3.3 Network Settings

3.3.1 Network settings

Full Hostname: Enter the FQDN of the FileCap server. Server: Enter a valid IP Address for the FileCap server. Subnet: Enter a valid subnet (e.g. 255.255.0.0). Default Gateway: Enter the Default Gateway which will be used by the FileCap server. Primary DNS: Enter a primary DNS Secondary DNS: Enter a secondary DNS (Optional) NTP Server: Enter an NTP Server (optional) Click Save when finished.


24 / 36

3.3.2 Mail settings

You will need to provide mail server settings in order for FileCap to send emails. Mail server: Enter the hostname of the mail server that will be used. Mail server port: Specify the port that will be used for the mail server. Email from: Enter a valid email address that FileCap will send emails from (e.g. [email protected]). Make sure mail relaying on your mail server is allowed from the FileCap server.

3.4 Plugins

3.4.1 Mail plugin settings

You can edit the mail plugin settings on this page. Attachment size in MB: Enter the threshold in megabytes from which FileCap will strip the

attachments and place them on the FileCap-server. For example: 3 means that any total attachment size exceeding 3 MB will be stripped and placed on the FileCap-server.

Mail Text: Enter the email text that will be sent to users.

mailto:[email protected]


25 / 36

3.5 Security settings

You can edit the security settings of FileCap on this page.

3.5.1 Security settings

External sender needs invite: Specify if external senders need an invite to send files

through FileCap. Sender needs approval: The sent file will need to be approved by a manager or other

specified person before being allowed to be sent Give option not to send ID: Specify whether or not to include a FileCap ID in an email. When

set to “Yes”, a sender will need to provide the receiving party with the ID by email.

Blocked MIME Types: Specify the MIME-types that may not be sent with FileCap

(separated by a space) Blocked Extensions : Option to block specific File-Extensions, Extensions are the

standard way of classifying file types on the system like EXE or ZIP.

Make sure you don’t put the “.” in front of the extension Approvers: Specify an email address of a user who is allowed to approve

sent files. Allow IP addresses for admin panel: Enter an IP or network block that will be allowed to access the

FileCap admin panel.


26 / 36

3.5.2 User Settings

On the user settings page it is possible to:

- Add exceptions for users to send specific file or MIME types

- Add exceptions for users to send or receive files the global security configuration prevents them

from having.

In the user settings you need to add the LDAP server settings first.


27 / 36

Creating the LDAP settings:

LDAP Server Hostname: Enter the hostname or IP address of your LDAP server

LDAP Username: Enter the username of the LDAP Server. The user must have

sufficient privileges to obtain all relevant user object information from

the AD server in order to authenticate.

LDAP Password: Enter the Password corresponding with the specified user.

LDAP Domain: Enter the Domain name the FileCap server is part of.

Search DN: Bind the full Distinguished Name (DN) of the LDAP Server.

This is needed when anonymous queries to the LDAP server are not

allowed.

Use SSL: Specify the usage of SSL

Connection Status: When the settings are correct, it will be shown here.


28 / 36

To create an exception for an LDAP group, you need to specify the LDAP server settings first, as

described on the previous page. After the LDAP Server Settings are configured, you will see the LDAP

tree populating on the right side of the screen.

To set exceptions for specified LDAP groups, you need to select the group from the tree on the right and

drag and drop it in the left panel. After you added the group to the left panel, you can assign specific roles

using the “Assign roles” button at the top of the screen.


29 / 36

On the “Assign roles“ panel, you are able to set specific roles for LDAP groups.

Roles: If you want to allow a user group to send files to ANY mail address, you

can check the sending files role. If you want a specific user group to be

able to receive files from any sender (for example when you have

multiple suppliers that need to send to this user) you can check the

“Receive files” option.

Approvers (optional): Setup an email address of the person that should approve the file

transfers for the users in the LDAP group.

Mime Types (optional): To exclude MIME types from the general filter (for example: if you only want one specific user group to send PDF files) you can add the MIME types here.

Extensions (optional): To exclude file extensions from the filter (for example: If you only want

one user group to send PDF files) you can add the extension here

(space-separated, do not use a dot, just the characters of the extension).


30 / 36

When the settings are applied correctly, you will see the exceptions you created in the list. If you want to edit an exception for a specific user, just click on the ID and press “Assign roles”.

If you want to delete an exception for a specific user, just click on the ID and remove all exceptions. When a user group has no exceptions it will automatically be deleted from the exceptions screen.


31 / 36

3.6 Reporting

3.6.1 Reporting uploads

On this page you will see the reporting and statistics for uploads to the FileCap server. You will see two pie charts. One with the Top 5 approvers and one with the Top 5 amount of files uploaded. On the right side there is a column with upload statistics.

At the bottom of the page you will find all the information about the uploaded files such as the sender, sender IP address, upload date and more. You can filter the information by typing in your search query in the search box. You can also export the information to Excel.


32 / 36

3.6.2 Reporting downloads

On this page you can see the reporting and statistics for downloads from the FileCap server. You will see two pie-charts. One with the Top 5 approvers and one with the Top 5 amount of files downloaded. On the right side there is a column with download statistics.

At the bottom of the page you will find all the information about the downloaded files such as the downloader’s email, downloader IP address, download date and more. You can filter the information by typing in your search query in the search box. You can also export the information to Excel.


33 / 36

3.7 Extra

3.7.1 Password reset

You can reset the password of the FileCap WebAdmin account on this page. We recommend doing this immediately after the installation has finished as after that it will be impossible to login using the default credentials.

3.7.2 Logout

Click this link to log out of the FileCap WebAdmin interface.


34 / 36

4. Installing FileCap Outlook Plugins

4.1 Pre-requirements

Port 8443 must be open to the FileCap server (this is the plugin communication port)

You will need a DNS entry “FileCap” pointing to the FileCap server.

4.2 Installation

To install the FileCap plugin you need to run the installer.

Accept the “License Agreement” to continue the installation. Press the “Install” button to start the installation of the FileCap plugin.


35 / 36

The FileCap plugin installer will unpack the installation files automatically.

The FileCap Plugin installation is successful. Click Finish to close the wizard.


36 / 36

You can check if the installation of the FileCap Plugin was successful by checking your Outlook add-ins for the add-in “FileCap”

4.2.1 User experience

When a user sends files that exceed the file size limit, the following screen will pop up automatically. When sending is complete, a link is added to the top of the email pointing to the files on the FileCap server.

filecap installation manual - contronex

Documents