system administration training -...

10
System Administration Training www.intranetdashboard.com

Upload: others

Post on 06-Aug-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

System Administration Training

www.intranetdashboard.com

Page 2: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

System Administration Training

www.intranetdashboard.com

Table of Contents

Key

Components: Web Server1

2 Components: SQL Server

3 Components: File System

4 Components: Other Components

Server Configuration: Pre-Requisites5

6 Server Configuration: Running the Installer

7 Server Configuration: Licensing

8 Server Configuration: Upgrading

Security: Security Models9

10

11

Backup and Restore Process

12

System Admin Tools

Emails in config Settings.xml

13 Other Tools

Glossary Webliography

Page 3: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

Each installation of Intranet DASHBOARD contains twoseparate websites.

There is one website for your iD installation and anotherwebsite for iD Search.

Running search in a separate website helps makemanagement of both systems easier and separatefrom each other – allowing you to assign only specificpeople to manage search if you wish.

iD installation contains two separate websitesin IIS.

System Administration Training

www.intranetdashboard.com 1|

1Components: Web Server

3Components: File System

A typical Intranet DASHBOARD installation comprises of four main directories inside the root level directory. These are:

1

1

Intranet DASHBOARD will create three databases onyour SQL Server. The first database (in this exampleit’s called iD) is the main iD database and contains alot of the settings and information related to the corefunctionality and operation of iD.

The second database (iD-FileStore) is the Filestoredatabase. It contains any documents and all other filesuploaded to Intranet DASHBOARD. This database willonly be used if you have selected “Database Filestore” atthe time of installation.

The third database (iD-Search) is the Search Database.This database contains all the configuration settings,indexes and timers required for search to operate.

2Components: SQL Server

2

2

2

Three databases are created in iD.2

DataThe location which binary data isinstalled in the case where iD isinstalled using a Local Filestorerather than the DatabaseFilestore. If a Local Filestore isselected, it can be migrated to aDatabase Filestore at a laterstage. The Data folder willremain empty if the DatabaseFilestore is selected.

wwwrootThe directory which IntranetDASHBOARD’s website files areall located (with the exceptionof Search).

Note: Below the wwwroot folderare where the folders that storeyour themes, license file, logfiles and web.config are stored,which you may need to accessfrom time to time.

APIWhere the folders and files for yourAPI applications are stored.

SearchAll the files relating to Search arelocated in this directory. TheSearch Indexer Service alsooperates from this directory.

Each image in this handout is numbered.Each number relates to the itemindicated in the left column.

Page 4: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

System Administration Training

www.intranetdashboard.com 2|

4Components: Other Components

IIS and SQL are the two core components that are required to run Intranet DASHBOARD. Along with these, there are several othercomponents that can be used in conjunction with iD to enhance the user’s experience of their Intranet.

Load BalancingWhen an Intranet is beingaccessed by many users atonce it may require to besetup in a load balancedenvironment to increaseperformance of the Intranet.

iD can be configured to havemultiple Front Ends pointingto a database server toseparate the workload.

We have more informationon load balancing availableon the support site.

FirewallMost networks and serversare configured to sit behindsome sort of Firewall. Thismay cause some issues ifthe Firewall has not beenconfigured correctly.

Commonly use ports thatshould be unblocked foran Intranet DASHBOARDserver should be:

HTTP: 80

HTTPs: 443

SMTP: 25

Virtual EnvironmentsWith Virtual Environments andCloud Computing becoming moreand more popular, this is aquestion that often gets asked.

Intranet DASHBOARD will quitecomfortably run in a virtualenvironment as long as enoughresources are assigned to thatvirtual machine.

Another issue that canoccasionally occur when usinga cloud/virtual environment isif the hardware or MACaddress of the virtual machinechanges from time to time asthis can invalidate the iDlicense file.

Active DirectoryActive Directory can be integratedinto Intranet DASHBOARD toallow credentials from yourDomain(s) to be passed into iDto allow your users to login.

Active Directory mode is seteither during installation ofIntranet DASHBOARD orthrough the Administrationunder Config Settings.

SMTP Mail ServerTo send mail and notificationsfrom Intranet DASHBOARD, anSMTP Mail Server is requiredto be configured. The mailserver can be configuredlocally, on your exchangemail server or any othermail server software thatuses the SMTP protocol.

Proxy ServerSome networks are configuredso all internet access is routedthrough a proxy server whichcould potentially causeproblems when using iFrames,external images or otherfeatures that require access tothe internet in IntranetDASHBOARD.

iD allows you toconfigure the network proxyserver in Config Settings toovercome most proxy serverrelated issues.

Page 5: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

The process of running the Intranet DASHBOARD installer will take you through several steps.

The installer will:

Checking and configuring pre-requisites.

Configure the iD instance and install location.

Configure the databases and SQL server.

Configure the Filestore type.

iD and Search websites.

Security Mode.

Site Details.

If during the installation process it fails, you will be notified of the error and given the option to send the error log through to oursupport team as to why it failed. Along with this a copy of the iD install log is copied to the directory %temp%/iD/.

Some common problems that can occur during the installation process that may cause it to fail are:

Missing one or more required pre-requisites.

SQL Administrator details do not have the required privileges to complete the installation.

Selected SQL User password does not meet the required password security policy.

Generally these problems can be resolved by re-running the installer with the required changes, for the installation to completesuccessfully. In the case there is a more serious issue (the install log displays a programming error or exception) and won’tcomplete, you will need to contact us to gain assistance from our support team to resolve the issue.

After the installer has completed successfully you’ll be presented with a summary of information which will allow you to access*the Intranet.

*Please Note: DNS details or host headers may need to be configured first before you can access the Intranet.

Intranet DASHBOARD requires Windows Server 2012, Windows Server 2008 R2, 2008 or 2003, MS SQL 2005+ and .NET.A full guide to Intranet DASHBOARD pre-requisites and requirements is available on the iD Help Site.http://help.intranetdashboard.com

System Administration Training

www.intranetdashboard.com 3|

5Server Configuration: Pre-Requisites

6Server Configuration: Running the Installer

Technical Specifications: Technical guidelines provided to enable your organization to accommodate iD:

http://help.intranetdashboard.com/guides/Tech_Specs/TechnicalSpecifications.html

Page 6: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

Once Intranet DASHBOARD has been installed it will need to be licensed. The licensing process is an easy to follow process.

To license Intranet DASHBOARD, follow the steps below:

Navigate to your iD installation’s wwwroot\bin directory.

Check that no existing core.lic files exist. If they do, delete it completely.

Download your new license file from the iD Client Portal into the bin directory.

Load up your web browser and navigate to your Intranet DASHBOARD installation, which will then allow you to activate yourlicense by clicking on a link.

iD should now be successfully activated.

If you receive an error message stating you have an invalid or missing license, the reason may be one of the following:

The license has been previously activated on another computer.

You will need to contact support and request for the license to be re-issued.

The license file has become corrupted or is missing data.

This usually occurs when the license hasn’t been saved correctly or the existing license file has been overwritten. Thiscan be fixed by downloading the license again. Try copying the text out of the new license file and into the old one,replacing the existing text in the license file.

Intranet DASHBOARD does not have the correct permissions to access the license file.

Ensure that the license file is inheriting the file and folder permissions from the parent folder.

In the case where the server you are trying to activate Intranet DASHBOARD on does not have an internet connection, you canactivate manually by following the manual activation instructions provided in your iD installation.

www.intranetdashboard.com 4|

System Administration Training

7Server Configuration: Licensing

To upgrade Intranet DASHBOARD, clients will need to havetheir subscription up to date. Updates for Intranet DASHBOARDcan be downloaded via iD Client Portal under SoftwareUpgrades.

When upgrading, although the Upgrade takes a backup ofyour web files and databases, it is also a good idea toensure you have separate backups to these as well.

There may be unique instructions for each Upgrade whichneed to be followed; these are generally available on thesupport website with each Upgrade.

8Server Configuration: Upgrading

Client Portal: Software Upgrades4

4

Page 7: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

There are four different security modes in Intranet DASHBOARD.They can be used separately or can be combined through the useof IP Based Security:

LoginWhen changing to Login security mode, this will prompt users toenter a username and password to log into iD. This is most commonlyused in an environment where a company does not have ActiveDirectory or wants to use Intranet DASHBOARD in an ExtranetConfiguration (combined with the use of IP Based Security) andrequires all users to be manually created in the admin system.

Login On DemandSimilar to Login mode users are created by the administratorsalthough by default all users are given access to all parts of theintranet. At any time a user can Login with their details and thenaccess secure areas restricted to their login account.

Active DirectoryActive Directory security will verify on the first request to the serverthat a client is part of your Active Directory domain and save a record oftheir AD login credentials (e.g. DOMAIN\username) for limiting accessto certain parts of the site. Please note that you must have an ADdomain, your web server must be a member of the domain and clientsmust also belong to the domain for Active Directory security to work.

Configuring Active DirectoryThere are three main things that need to be configured whensetting up Active Directory. These details will be:

AD Servers.

Global Catalog Server (option).

Primary Server

Connection Details

Applying RestrictionsThe restrictions tab allows you to configure restrictions forActive Directory’s integration in Intranet DASHBOARD. This isparticularly useful for hiding certain things from queries thatiD makes to Active Directory.

Trust DomainsIn some situations a company may have multiple domains intheir Active Directory Forest which have been joined togetherthrough a trust. To ensure that users from all these domainscan successfully authenticate into Intranet DASHBOARD, youwill need to configure these domains in iD.

Configuring the trusted domains in iD simply requires you to providethe domain details and AD server that controls this domain.

Configure your AD.

9

www.intranetdashboard.com 5|

System Administration Training

9Security: Security Modes

5

5

Page 8: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

When backing up Intranet DASHBOARD, there are a few difference components of the software that need to be backed up toensure that iD can be restored successfully in the case of disaster recovery or to complete a migration to another serversuccessfully.

The different components that need to be backed up are:

Intranet DASHBOARD application and Search files.

All iD databases.

In the case of disaster recovery where the Intranet DASHBOARD files or database may become corrupted, after diagnosing thesituation and determining what needs to be restored, you can simply restore your databases and/or web application files.

Where you are required to perform a full server migration, the instructions available on our help site should be followed to ensurea successful migration. Where a server migration is carried out, the client’s Intranet DASHBOARD licenses will need to be re-issuedafter completing the migration as they will not work on any other servers once activated.

www.intranetdashboard.com 6|

System Administration Training

10Backup and Restore Process

Backup and RestoreGuide

Provides instructions to backup, restore and migrate your iD installation.http://help.intranetdashboard.com/guides/TechnicalGuides/BackupRestoreGuide.html

Page 9: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

www.intranetdashboard.com 7|

System Administration Training

11System Admin Tools

Event LogEvent log allows you to keep track of any changes that have occurred in the system. It also keeps record of failed login attemptsto your Intranet’s administration.

Error ManagerError Manager shows and keeps record of any errors that have occurred in the Intranet installation. By monitoring this log is willenable you to see where any majors have occurred and also assist in troubleshooting and resolving issues that any of the intranetusers may be experiencing.

Audit LogThe Audit Log keeps track of any changes that occur within Intranet DASHBOARD and who made those changes. The audit log is aso useful to assist in troubleshooting where you may need to find who performed certain actions within iD.

Config SettingsConfig Settings contain the settings that control the Core of Intranet DASHBOARD. Most of these settings work as “set and forget”,once they are set you will rarely need to change them again.

IP Based SecurityIP Based Security can be used to apply different security modes to your Intranet depending on where it is being accessed from.You can use IP Based Security to for scenario such as below:

All users that are working in the office need to log into your Intranet using their Active Directory Details.Any user accessing your Intranet externally to your office need to access the Intranet, but are required to login.All requests to the extranet are go directly to the web server within the DMZ on your network, but still has access to active directory.

All users that are working in the office need to log into your Intranet using their Active Directory DetailsAny user accessing your Intranet externally to your office need to access the Intranet, but are required to login.All requests to the extranet are forwarded to iD server via a firewall with forwarding.

In this case, you would setup Intranet DASHBOARD to have a primary security mode of login, and then configure IP Based Securityfor the IP Subnet of their Office.

Another scenario that may occur, similar to above is:

The difference between this scenario and the first one is the way the requests to the extranet are handled. In this case we wouldset iD to use Active Directory as the primary security mode and configure IP Based Security to use Login mode of the IP addressthat the firewall sends in its request to the web server.

Single Sign OnSingle Sign-on can be used to integrate Intranet DASHBOARD into your other web applications. This enables iD to be the gatewayto all other web applications and systems that may be running in the organisation (such as a webmail interface).

We have guides available on the Support Site and Partner Portal that provide more information on implementing Single Sign-oninto your intranet and other web based applications.

Config Settings

IP Based Security

Define the way iD is set up.http://help.intranetdashboard.com/systemadmin/utilities/config_settings/ConfigSettings.html

Set a different front end security mode depending on the IP address of the users accessing the sitehttp://help.intranetdashboard.com/systemadmin/utilities/ipbased_security_settings/IPBasedSecuritySettings.html

Page 10: System Administration Training - GreenOrbithelp.intranetdashboard.com/.../_LIVE_/SystemAdministrationHandout.pdfActive Directory Active Directory security will verify on the first

Intranet DASHBOARD sends emails out to users which can be from notifications to welcome emails. These email messages canbe configured to how you want them to be.

To customize an email message, navigate to the wwwroot\cfr\ folder of your Intranet DASHBOARD installation. With the folder isa file called configSettings.xml which you can open and edit in a text editor

12Emails in config Settings.xml

www.intranetdashboard.com 8|

System Administration Training

Webframes and Developing Custom AppsWebframes can be used to integrate other web applications and develop your own applications for use with IntranetDASHBOARD. Details from Single Sign-on can also be used when integrating web based applications through a Webframe.

Webframes can be configured in iD CMS as a Webpage Frame or be integrated into part of the layout of Intranet DASHBOARDthrough Layout Manager.

Custom applications can be developed in the iD API and integrated either as a component in iD CMS, by being placed into aniFrame on accessed as an application in the software. Our API documentation explains further how to develop and integrate yourown custom applications or other systems into iD.

13Other Tools