Upload
others
View
25
Download
0
Embed Size (px)
Citation preview
THE SOCIAL FOUNDRY
November 9, 2012
SOAPbox Installation Guide
Installation Documentation Version 1.0
1
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
SOAPbox Installation Guide
Installation Documentation Version 1.0
The SOAPbox installation guide covers the intitial installation of the SOAPbox on the following supported platforms:
Windows XP
Windows 7
Windows Server 2008
Min RAM: 2 GB
Reccomended RAM: 4 GB or above
Min Hard Disk Space: 1 GB (installation only)
IIS Version: 7 or above
Tip: We highly recommend that production installations of the SOAPbox be installed on a dedicated workstation or server to prevent
application conflicts. In addition, the SOAPbox default installation uses port 80 and 443 (for SSL installations), so please either
change the ports via the IIS server control, or ensure that no other applications are utilizing those ports to prevent port contention.
Tip: We also highly recommend that production installations of the SOAPbox be installed on a workstation or server that does not
already have an installation or SQL Server or SQL Express running. The installation process creates a SQL Express database and
configures it for SOAPbox use. The database settings for the SOAPbox and your existing database may be incompatible. As such
running multiple databases on a single machine, while possible, is not supported by the Social Foundry.
2
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Table of Contents:
SOAPbox networking considerations-3
SOAPbox installation-4
SOAPbox SSL configuration-25
SOAPbox server-side settings-31
3
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
It is good practice to install the gateway in your DMZ with either
an SSL accelerator or web application firewall in front of the
gateway. The SOAPbox is not a security appliance and as such
should be protected using your companies preferred hardening
method for internet facing servers.
If you are using the Salesforce.com add-in, you can further
enhance your security by using IP address range restrictions.
Since Salesforce.com owns the entire range, there is no danger
in havin g another entity co mingled.
204.14.232.0/23 East Coast Data Center (set one)
204.14.237.0/24 East Coast Data Center (set two)
96.43.144.0/22 MidWest Data Centers
96.43.148.0/22 MidWest Data Centers
204.14.234.0/23 West Coast Data Center (set one)
204.14.238.0/23 West Coast Data Center (set two)
182.50.76.0/22 Japan Data Center
4
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Installation:
Select the ‘SOAP box Setup.exe’ file from the The SOAPBox\ Setup Files directory.
The SOAPbox requires both the .Net Framework (version 4x) and SQL Express as a prerequisite.
Hit ‘Next’ to begin the installation.
Note: Ensure that you have IIS installed set on your machine before you attempt to intall the SOAPbox. Otherwise
the installation will terminate when the installer attempts to install the SOAPbox after the prerequisites are
completed.
5
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
If you have the .Net framework already installed, the pre-requisites installer will not check that box. Ensure that this box is
checked as some base installations of the .Net framework have been known to be faulty.
Hit the ‘Next’ button.
Follow the installation instructions of the Web Installer for Microsoft. As this changes based on the latest release of the .Net
Framework, we cannot provide step by step instructions as Microsoft constantly changes the user interface depending on the version
installed.
If your choice is to ‘Remove’ or ‘Repair’ the .Net framework select ‘Repair’. Otherwise follow the steps for a new installation.
TIP: It is NOT necessary to reboot after a repair, but is necessary to reboot after a fresh installation.
6
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Once the .Net framework has been installed, the installer will start to unpack the SQL Express files.
8
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
This is Microsofts SQL Server Installatin screen. Select ‘New installation or add features to an existing installation’.
9
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Check the ‘I accept the license terms’ checkbox.
Hit ‘Next’.
16
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Close this window. The installer will now install the SOAPbox itself. There may be a slight pause between the time you close this
window and the start of the next step in the installation process.
17
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Check the ‘I agree to the License terms and conditions.’ checkbox.
Hit ‘Next’.
18
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Enter the Serial number. This is unique to your organization and will be provided to you by the Social Foundry.
Select ‘Install’.
20
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Once installed, you will need to perform a final post installation step.
Go to the ‘Internet Information Service (IIS) Manager.
Select Application Pools.
Highlight the SOAPbox entry.
Select the ‘Advanced Settings’ link.
21
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Set the’Load User Profile’ option to ‘True’.
Select ‘OK’.
22
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Select ‘Recycle’ to reset the SOAPbox application pool.
23
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Once the application pool is recycled, navigatet to the SOAPbox website and hit the ‘Restart’ link.
24
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
The SOAPbox login address is http://hostname/thesoapbox/login.aspx
To configure SSL settings for the SOAPbox, please see the SSL configuration section in this document.
You can test your login by using the default credentials
User Name: admin
Password :admin
25
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
SSL Installation and Configuration:
The Social Foundry recommends that you run the SOAPbox using SSL in order to safeguard the information between your
external clients and the SOAPbox..
The SOAPbox conforms to the standard Microsoft SSL configuration practices for IIS.
Step by step instructions on generating a certificate and installing it on IIS7+ from Go Daddy.com (as an example) can be
found here:
http://support.godaddy.com/help/article/4801
You can purchase a SSL certificate from any of the major domain hosting companies.
The following URL lists the major certificate authorities that offer SSL certificates.
http://wiki.developerforce.com/page/Outbound_Messaging_SSL_CA_Certificates
26
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Once you have installed the SSL certificate, you will need to make a change in the servers web.config file to allow the software
to run via SSL.
In the IIS Manager console, find the SOAPbox Website and right click.
Select ‘Explore’ to see the file system the SOAPbox uses.
27
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
The Web.config file contains all of the websites settings and controls how the site behaves in IIS.
Tip: When making changes to the web.config file. Always copy the file just in case you make a keying error.
Tip: You can use a text editor like Wordpad to edit the web.config file.
28
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Once you open the file search for any instances of SSL in the file.
29
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Change the values to ‘true’.
There should be two occurances of this setting in a default installation of the SOAPbox.
Save the web.config file.
31
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
If you certificate is installed correctly, you should not be challenged by your web browser when navigating to your SSL enabled
SOAPbox login screen.
Your login url should now be https://hostame/thesoapbox/login.aspx.
32
SO
AP
bo
x In
stal
lati
on
Gu
ide
| 1
1/9
/20
12
Other usefule web.config settings.
UnityECS_LoginType: Valid values are ‘local’ for using passwords and user-ids stored locally on the machine. This
should not be changed.
UnityECS_ExternalSystem: This value is defaulted to ‘salesforce’. If you choose to use a different, external system,
you may type any other value here. If the value is salesforce it will implement a rolling cryptographic key
that only the salesforce.com platform can understand. If you are not using the salesforce.com
platform, simply leave this blank.
UnityECS_Reset_Admin_Password: Values can be ‘true’ or ‘false’. If the value is true, then upon restart of the site, the
default username and password are reset. If ‘false’ then they are not.
UnityECS_Admin_Default_Username: This is the default username of the application. You can change it to anything
you wish.
UnityECS_Admin_Default_Password: This is the default password of the application. This exists in the unlikely case
where a user has locked them self out of the application and may need to set to factory defaults and not lose any data.
UnityECA_IncorrectLoginAttempts: This is the number of external login failures the system will accept before
shutting the service down. When local authentication is enabled, this value also governs the amount of incorrect
logins before a given user account is locked.