quick start guidesupport.olfeo.com/sites/olfeo/files/support/v596/en/installation_guid… ·...

Quick Start Guide

Olfeo BoxCopyright © Olfeo

Version:1.0.8

Legal Information

Copyrights

© Copyright 2014 Olfeo. All rights reserved. This document may only be used under an Olfeo Company SoftwareLicense Agreement.

No part of this document may be reproduced, published, stored in an electronic file system, or converted into any machinelanguage, in any form or by any means whatsoever, without Olfeo’s prior written consent. Olfeo grants you limitedpermission to make hard copies or other reproductions of any computer documentation for your own use, providedthat all such reproductions shall carry the Olfeo copyright notice. No other rights under copyright are granted withoutOlfeo’s prior written consent.

The content of this documentation are subject to change without prior notice.

Trademarks

Olfeo is a registered international trademark of the Olfeo Company.

This document refers to software components or materials which are owned by third-party publishers or manufacturers :

• Linux is a registered trademark of Linus Torvalds.• Microsoft, Windows, Internet Explorer and their respective logos are registered trademarks of Microsoft Corporation• PuTTY is open source software developed by Simon Tatham and distributed under terms of the MIT license.• Debian is a registered trademark of Software In The Public Interest Inc.• ClamAV is a registered trademark of Sourcefire Inc.• Minicom is open source software originally developed by Miquel van Smoorenburg and is distributed under the

terms of the GPL (GNU General Public License.)• HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, the World Wide Web

Consortium or the Massachusetts Institute of Technology.

All other product names products mentioned in this manual or in any other documents provided with Olfeo productsare commercial trademarks or registered trademarks of their respective owners.

Contacts

Olfeo15, boulevard Poissonnière75002 ParisFrance

Customer Account Management Service

Whether you are a partner or an end user of the Olfeo solution, Customer Account Management Service is availablefor any comments and requests.

E-mail: [email protected] Tel: +33 (0)1.78.09.68.07

Olfeo Technical Support

Access to support is available to customers with a 'ISV Direct Support' support contract. Olfeo Technical Support isavailable Monday through Friday, 9 a.m. to 6 p.m. (GMT+1) except on French national holidays.. If you would liketo take advantage of a 'ISV Direct Support' contract please contact your Customer Account Management Representative.

E-mail: [email protected] Tel: +33 (0)1.78.09.68.01

Referrals

Are you an existing customer of Olfeo and wish to refer someone who is interested in our solution? Contact us andtake advantage of our referral program.

e-mail: [email protected]

URL reclassification

The following email address is available to request reclassification of one or more URLs.

e-Mail: [email protected]

Documentation Department

Please use the following email address to send Olfeo documentation comments or change requests.

e-Mail: [email protected]

mailto:[email protected]





Quick Start Guide / Olfeo Box / 7

Contents

Chapter 1: Due diligence......................................................................................... 91.1 Notes regarding the warranty.......................................................................................................................101.2 Package contents.......................................................................................................................................... 101.3 Getting started and requirements check.......................................................................................................10

Chapter 2: Installing your Olfeo Box...................................................................132.1 Rack-mounting your Olfeo Box...................................................................................................................142.2 Connecting to your Olfeo Box.....................................................................................................................16

2.2.1 Console connection....................................................................................................................... 172.2.2 Network connection.......................................................................................................................18

Chapter 3: Configuring your Olfeo Box.............................................................. 213.1 Renaming an Olfeo machine........................................................................................................................223.2 Accessing Olfeo Administration Console....................................................................................................223.3 Configuring a network interface.................................................................................................................. 233.4 Adding the necessary firewall rules for your Olfeo Box............................................................................ 233.5 DNS configuration........................................................................................................................................233.6 Configuring the SMTP server......................................................................................................................243.7 Configuring an HTTP proxy........................................................................................................................243.8 Testing connectivity to your network.......................................................................................................... 24

Chapter 4: Registering and updating the license................................................ 274.1 Registering the license................................................................................................................................. 284.2 Updating the software.................................................................................................................................. 284.3 Manually updating the Olfeo URL database............................................................................................... 28

Chapter 5: What are the next steps?................................................................... 295.1 Next steps..................................................................................................................................................... 30

Glossaire......................................................................................................................................... 31

Table of contents


Chapter

1Due diligence

Topics:

• Notes regarding the warranty• Package contents• Getting started and requirements check

1 Due diligence


Notes regarding the warranty

Upon notification and diagnosis of a hardware problem, we will deliver a new Olfeo Box of the same model inmetropolitan France within 2 business days.

For all confirmed warranty claims before 3:00pm Paris time and for all deliveries in metropolitan France, the warrantyis extended with an OlfeoBox replacement within 1 business day. After 3:00pm, the delivery will be done within thestandard 2 business days.

To request a replacement under the warranty agreement, customers must contact Olfeo technical support and followthe procedure provided for diagnosing a software or hardware problem. Technical support is available to customersMonday through Friday, 9 a.m. to 6 p.m. (GMT+1) except on French national holidays. Technical Support under thiswarranty agreement will only be limited to diagnosing hardware problems.

If a hardware failure diagnosis is confirmed, Olfeo will immediately and free of charge send a new pre-installed applianceto the customer.

Transfer of data and backup recovery are the customer’s responsibility. The Olfeo customer portal provides all thenecessary information regarding back up operations.

The customer agrees to return, at his own expenses, the defective OlfeoBox and all accompanying items within 1 monthof receiving the replacement equipment. Olfeo reserves the right to charge customer 100 € HT for any missing itemsor any late OlfeoBox return. Should the warranty seal be broken without Olfeo prior approval, Olfeo reserves the rightto decline any warranty claim.

For any claim made without warranty or if the warranty has expired without renewal, customer can return the OlfeoBoxfor repair to Olfeo and all repairs, shipping and handling costs will be chargeable.

Please note that the Olfeo Box warranty does not include 'ISV Direct Support'. As a hardware warranty only, it doesnot cover software support.

Package contents

Before you begin, verify that you have received the following hardware:

• 1 Olfeo Box.• 1 standard electric power cable.• 3 RJ45-type network cables.• 1 console cable.• 2 mounting rails.• 2 mounting lugs.• 16 screws, black.• 4 screws, metallic.

Getting started and requirements check

Verify that you have the following available. These items are absolutely required for configuring your Olfeo Box.

• IP addresses for your Olfeo Box .• Subnet masks.• IP address for the DNS server.• Gateway IP address

http://www.olfeo.com

1 Due diligence


• License keys provided by your Olfeo sales representative.

Chapter

2Installing your Olfeo Box

Topics:

• Rack-mounting your Olfeo Box.• Connecting to your Olfeo Box

2 Installing your Olfeo Box


Rack-mounting your Olfeo Box.

1. Align and assemble the two rails as follows, depending on the rack’s size.

• Large racks:

Figure 1: Aligning a large rail..

Figure 2: Assembling a large rail.

• Small racks:



Figure 3: Aligning a small rack.

Figure 4: Assembling a small rack.

2. Use the mounting supports shown below to mount the rails in your rack.

Figure 5: Mounting supports (Large racks.)

Figure 6: Mounting supports (small racks).

3. Screw in the lugs on your Olfeo Box as follows:



Figure 7: Lug mounted on Olfeo Box (Side view).

Figure 8: Lug mounted on Olfeo Box (Front view).

4. Position your Olfeo Box on the rails you previously mounted on the rack.

5. Screw the two lugs of your Olfeo Box to the rack.

Figure 9: Lug fixed to the rack.

Connecting to your Olfeo Box

After you have installed your Olfeo Box in a rack, you have the option of making one of two types of connections,network or console. Choose the option best adapted to your needs.



Console connection

1. Use the provided console cable to connect your computer to the Olfeo Box.

Figure 10: Console link

Note: Olfeo’s console port is marked is marked with this symbol: .

2. Depending on your current system, launch one of the following utilities to access the console:

• Windows: putty or hyperterminal.

• Linux: minicom or screen.

3. Input the following values to create your console connection:

Table 1: Console connection parameters

Parameters to be configured Value

Baud rate 38400

Data bits 8

Stop bits 1

Parity None

Result: After you make the connection a shell appears.

Note: The parameter "baud rate" can be modified in BIOS. In case of difficulties, verify that the valueyou are trying to use corresponds to the value entered in BIOS.

4. Log in using the default login.



Table 2: Default login credentials

Parameters to be configured Default value

Login root

Default password olfeoolfeo

Danger: In order to assure a high security level, the administrator must change this password beforegoing into production mode.

5. Change the IP address of the Olfeo Box interface chosen by admin.

Enter the following command:

ifconfig ethx xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy up

where:

• "ethx" represents the desired interface (Example:eth0).• "xxx.xxx.xxx.xxx" represents the desired IP Address (Example:192.168.1.3).• "xxx.xxx.xxx.xxx" represents the desired network mask (Example: 255.255.25 5.0).

Warning: The address change is not permanent. On restarting the machine, the address will bereinitialized. To achieve a permanent configuration, you will need to take the steps described in chapterConfiguring a network interface on page 23.

6. Connect the Olfeo Box interfaces to the final network.

7. Using the browser access the Olfeo admin console located at the "xxx.xxx.xxx.xxx" address http://xxx.xxx.xxx.xxx:8081 that represents the address configured for ethx.

Warning: If you always use the same client computer, do not forget to place its IP address on a networkwhere the "xxx.xxx.xxx.xxx" address can be contacted.

Result: The admin console appears on your screen.

Network connection

1. Use a crossover network cable or a switch to link your computer to the Olfeo Box .

http://xxx.xxx.xxx.xxx:8081




Figure 11: Liaison switch

2. Set up your computer on the same network as the eth0 of the Olfeo Box.

Table 3: Default IP address

Default IP address of the Olfeo Box

192.168.17.64

3. Log in using the default login.

Table 4: Default login credentials

Parameters to be configured Default value

Login root

Default password olfeoolfeo

Danger: In order to assure a high security level, the administrator must change this password beforegoing into production mode.

4. Change the IP address of the Olfeo Box interface chosen by admin.

Enter the following command:

ifconfig ethx xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy up

where:

• "ethx" represents the desired interface (Example:eth0).• "xxx.xxx.xxx.xxx" represents the desired IP Address (Example:192.168.1.3).• "xxx.xxx.xxx.xxx" represents the desired network mask (Example: 255.255.25 5.0).

Warning: The address change is not permanent. On restarting the machine, the address will bereinitialized. To achieve a permanent configuration, you will need to take the steps described in chapterConfiguring a network interface on page 23.

5. Connect the Olfeo Box interfaces to the final network.



6. Using the browser access the Olfeo admin console located at the "xxx.xxx.xxx.xxx" address http://xxx.xxx.xxx.xxx:8081 that represents the address configured for ethx.

Warning: If you always use the same client computer, do not forget to place its IP address on a networkwhere the "xxx.xxx.xxx.xxx" address can be contacted.




Chapter

3Configuring your Olfeo Box

Topics:

• Renaming an Olfeo machine• Accessing Olfeo Administration Console• Configuring a network interface• Adding the necessary firewall rules for your Olfeo Box• DNS configuration• Configuring the SMTP server• Configuring an HTTP proxy• Testing connectivity to your network.

3 Configuring your Olfeo Box


Renaming an Olfeo machine

If installing several Olfeo machines, it may become necessary to give your Olfeo machines different names.

Danger: Two machines with the same name cannot be connected simultaneously to the domain. Indeed,the last machine joined to the domain will erase the configuration of any machine previously connected withthe same name.

Please use the following procedure to rename your Olfeo machines.

1. Connect to the command line on your Olfeo machine via SSH or from the console.

2. Edit the following configuration files and replace all occurrences of the previous name of the Olfeo machine withits new name.

• /etc/hostname

• /etc/hosts

• /etc/motd

3. Run the following command to change the machine’s name dynamically:

hostname new_name_of_the_machine

Accessing Olfeo Administration Console

1. Using your browser, access the Olfeo admin console located at the "xxx.xxx.xxx.xxx" address http://xxx.xxx.xxx.xxx:8081 that represents the IP address chosen by the administrator.


2. Login to the console using the admin username.

Table 5: Default Login

Login Password

admin admin

Danger: The admin account must never be deleted! However, it is possible to modify its passwordand eventually its login before being going into production mode.





Configuring a network interface

1. Go to page [Parameters] > [Network] > [Interfaces].

2. Select the desired interface.

Example:eth0

Result: The configuration page opens.

3. If the interface is not activated, activate it by clicking the button [Enabled].

4. In the [Mode] field, choose how your interface must be configured. Choose:

• [DHCP], if your interface is configured by DHCP.

• [Static], if you wish to configure your interface manually. In this case, the fields [IP Address], [Netmask] and[Gateway] must be completed with values that apply to your network.

5. Click on the button [Ok].

Adding the necessary firewall rules for your Olfeo Box

In order to stay up to date, your Olfeo Box needs to communicate with the outside world. Hence, you must add thefollowing rules to your firewall:

Source address Destination address Service Description

IP Address of Olfeo Box v5.olfeo.com http (80), https (443) For updating your Olfeo Box,URL updates and licensedownloads.

IP Address ofOlfeo Box debian.olfeo.com http (80) System update.

IP Address ofOlfeo Box client.olfeo.com http (80) Information about Olfeo.

IP Address ofOlfeo Box database.clamav.net http (80) Antivirus update.

DNS configuration

1. Go to page [Parameters] > [Network] > [DNS].

2. Enter the DNS server’s IP address.

Note: To input several DNS servers separate them with commas.

3. Enter the DNS domain.

For example: myorganization.com




Configuring the SMTP server

1. Go to page [Parameters] > [Network] > [SMTP].

2. In the [Port] field enter the server port.

3. In the field [Port] enter the server port.

For example: 25

4. In [Mail from] field enter the email address which will be used by Olfeo solution.

For example:[email protected]


Configuring an HTTP proxy

1. Go to page [Parameters] > [Network] > [HTTP].

2. If your Olfeo Box must interface with a proxy server, activate the checkbox [Use proxy].

a) Re-enter the proxy server name or IP address in the [Server] field.

b) Re-enter the server port in the [Port] field.

3. If your proxy requires authentication, tick the checkbox [Use authentication].

a) Enter your username in the [Login]field.

b) Enter your password in the [Password] field.


Testing connectivity to your network.This is to make sure that your Olfeo communicates correctly with the network. The test will fail if your Olfeo interfaceswere not configured as specified in chapter: Configuring a network interface on page 23.

1. Go to page [Parameters] > [Network] > [Network Tests].

2. Choose one of the following fields and enter a test value:

• Ping - (if you use DNS names and not the IP addresses, make sure you have completed the configuration perchapter: DNS configuration on page 23.

• DNS - (make sure you have completed the configuration per chapter:DNS configuration on page 23).

• HTTP - (if you use DNS names and not IP addresses,) make sure you have completed the configuration perchapter: DNS configuration on page 23).

• EMAIL - make sure you have completed the configuration per chapters: DNS configuration on page 23 andConfiguring the SMTP server on page 24).

Example of values:



• Ping: www.olfeo.com• DNS: www.olfeo.com• HTTP: http://www.olfeo.com• Email: [email protected]

3. Click on [Run Test] corresponding to the field to be tested.

Result: The column [Test Result] must display Success.

Chapter

4Registering and updating the license

Topics:

• Registering the license• Updating the software• Manually updating the Olfeo URL database.

4 Registering and updating the license


Registering the license

1. Go to page [Parameters] > [Update] > [Credentials].

2. In the fields [Login] and [Password] enter the information that Olfeo supplied to you.

Note: This information was provided to you as part of the delivery documentation. You will find it inthe "Code for downloads and updates" section of the document.


4. Verify that the license is activated. For this, go to page [Parameters] > [Update] > [Subscription] and click on[Update license].

Updating the software

1. Go to page [Parameters] > [Update] > [Software].

2. Click on the [Install updates] button.

3. Wait for the update to finish.

4. After the update, log in again to the interface when the login page opens.

Manually updating the Olfeo URL database.

The URL database is automatically updated every 15 minutes by Olfeo Box. However, you can update Olfeo’s URLdatabase manually using the following procedure.

1. Go to page [Parameters] > [Update] > [Database].

2. Select the [Olfeo] URL database appearing in the column headed [Label].

3. Click the [Complete Update] button.The update will run in the background..


Chapter

5What are the next steps?

Topics:

• Next steps

5 What are the next steps?


Next steps

You have completed all the steps in the Olfeo "Quick Start Guide" , You now have the necessary skills for integratingyour product with your infrastructure.

To help you in this process, we make two more guides available for your use:

• The "Integration Guide" lets you configure Olfeo Box your desired architecture.• The "User Guide to the Olfeo Admin Console" precisely describes to you the Olfeo admin console’s ensemble

of functionalities.


Glossaire

Physical applianceA physical appliance is an electronic machine dedicated to a specific function. In Olfeo’s case it consists of a dedicatednetwork box for running the Olfeo solution.

Olfeo’s URL databaseThe Olfeo URL database contains the list of URLs categorized by Olfeo. This database, using categories, allows forfiltering URLs accessed by users.

Olfeo admin consoleOlfeo admin console is a web portal through which the configuration functions of the Olfeo solution can be carried out.

Domain Name System (DNS)The DNS service provides a translation between an IP address and a domain name, and, more generally, it provides forfinding information based on the domain name.

Dynamic Host Configuration Protocol (DHCP)DHCP is a network protocol whose role is to assure the automatic configuration of a station’s IP parameters, notablyby assigning it an IP address and a subnet mask automatically. DHCP can also configure the default gateway and DNSserver addresses.

Olfeo BoxAn Olfeo Box is a physical appliance created by Olfeo.

Simple Mail Transport Protocol (SMTP)SMTP is a standard communication protocol used for sending or receiving electronic mail. It interfaces between a clientand a mail server.

quick start guidesupport.olfeo.com/sites/olfeo/files/support/v596/en/installation_guid… ·...

Documents