Installation
2.1 Installation on Linux Platforms
Installing via Yum
The strongly recommended approach is to take advantage of the Build Service's ability to act as a yum repository alongside your existing OS-supplied repository. Ths allows you to manage the Shibboleth packages in a standard way and pick up updates using a single command.
For Red Hat Enterprise, the CentOS team provides some usual material on using yum.
The root of the repository tree for Shibboleth can be found at http://download.opensuse.org/repositories/security://shibboleth/ with each supported OS in its own subdirectory. Each subdirectory is the root of a yum repository and contains a definition file named security:shibboleth.repo
.
Installation varies by OS, but usually you just drop the definition file into a directory such as /etc/yum.repos.d
. You can turn the repository on and off by adjusting the "enabled" property in the file, such as to prevent automated updates and maintain manual control. While enabled, the yum command will "see" the Shibboleth packages when you perform standard operations, and installing the EDS should require only a single command:
$ yum install shibboleth-embedded-ds
Installing Manually
If you prefer to do things by hand, you can download the package from the repositories hosted on the Build Service at http://download.opensuse.org/repositories/security://shibboleth/.
Installation details.
The Installation places the files you will need to configure the EDS into /etc/shibboleth-ds
.
It then configures the Apache webserver to serve the EDS files (including the ones you use to configure) as:
/shibboleth-ds/idpselect_config.js
/shibboleth-ds/idpselect.js
/shibboleth-ds/idpselect.css
/shibboleth-ds/index.html
used for testing
2.2 Installation on Other Platforms
Locate on same domain as SP
Because of browser security, the files need to be located on the same domain as the SP.
Web Server Setup
- Download the Embedded Discovery Service Distribution
- Unzip the distribution
- Copy the Javascript files (
idpselect_config.js
andidpselect.js
, and the CSS (idpselect.css
) files in to the location from where your web server is serving static content. - For testing purposes you may chose to copy the
index.html
file to the same location.
Once complete, open a browser and test to make sure each file is reachable.
2.3 Web Page Setup
The first way, useful for testing, is to use the index.html
file that comes with the EDS distribution.
If, however, you'd like to embed the discovery service in to an existing page template you have for your site (the behavior we'd expect for an production install) then make the following modifications to your HTML page:
- Within the
head
element add a link to the discovery service CSS page similar to:<link rel="stylesheet" type="text/css" href="idpselect.css">
- Within the
body
element add the followingdiv
element in the location you wish to use for the upper-left corner of the discovery service (i.e., where you want it to start rendering):<div id="idpSelect"></div>
- At the bottom of the
body
element (just before the closing tag) add the following script definitions:<!-- Load languages scripts --> <script src="idpselect_config.js" type="text/javascript" language="javascript"></script> <script src="idpselect.js" type="text/javascript" language="javascript"></script>
The
<script>
element must appear after the<div>
element in the document.
Now, if you're testing against a brand new Service Provider 2.4 install you can test at this point (since 2.4 comes with the discovery data feed configured by default). If you upgraded to 2.4 from a previous version you will need to complete the Service Provider configuration steps given in the next section before you can test.
So, if you want to and can test at this point, then open a web browser and go to the embedded discovery service page. If everything is working okay you'll see the discovery service rendered.