Quick Start
This document helps you to deploy, install and configure your SharePoint web application to use Shetab SharePoint Live Authentication. All steps can be done and customized with stsadm command, but for simplicity we provide batch file to make to process more easily.
Note: After you purchase commercial license you need do some additional steps to install your certificate and deploying a Security Token (STS), but free trial users can simply ignore them and just do the following steps.
Check Requirements
SharePoint Foundation 2010 or SharePoint Server 2010 should be installed on your server.
- You have root access to server with an administrator privilege account otherwise you will get access denied error while executing batch file. You can do one of the following to run bath file:
- Run with "administrator" account. Account name should be exactly "administrator" not a user that exists in administrators group
- Rub Batch File as Administrator
- Turn off UAC (User Account Control)
- Make sure the date and time of your SharePoint machine is
valid
.
- Make sure your SharePoint Web Application created with Claims Based Authentication not Classic Authentication
Download and deploy Shetab SharePoint Live Authentication Solution
- Download the Free Trial edition from here.
- Extract zip file.
- Open Deployment folder from extracted folder.
- Run Deploy.bat file.
Note: if you already deploy the solution you should run Redeploy.bat.
Note: If you run Redeploy.bat at first time, you will see just some error message that the solution not exists, those errors can be ignored.
Install Shetab SharePoint Live Authentication as Trusted Identity provider
- Open Configure folder where you extract the product.
- Run Install.bat file.
Note: If you already run install.bat before, you will see some error that can be ignored.
Note: Only one Trusted Identity provider can be installed on server at time, so you should un-install other Trusted Identity provider.
Configure your SharePoint Web Application to use Shetab SharePoint Live Authentication
- Open Configure folder where you extract the product.
- Open Vars.bat file with a text editor such as Notepad and set your SharePoint web application URL in url parameter and save the file. NoteApplication
Example: @SET url=http://localhost
- Run Add.bat file.
Note: SharePoint Application at specified url should be created with Claims Based Authentication not Classic Authentication.
Note: Make sure the date and time of your SharePoint machine is valid otherwise the timestamp of sign-in message will be invalid and you will
redirect back to sign-in page each time.
Note: If not any site exists in web application url, you should set profile site too. Exmaple: @ProfileSiteUrl=http://localhost/sites/site1
Now anyone can sign-in to your site with any OpenID provider and Windows Live ID.
Optional Parameters
These parametes is optional and you can simply ignore them.
Changing Profile Site
Shetab SharePoint Live Authentication use SharePoint lists to store its database such as user profiles, this list will be create in your web application and only site collection administrator can see them. You can tell Shetab SharePoint Live Authentication to create these lists to another SharePoint site with following ProfileSiteUrl parameter in vars.bat file.
Example: @SET ProfileSiteUrl=http://localhost:500
User's E-Mail Compulsion
You can set whether user should enter their emails or not by set the EmailRequired parameter, but Shetab SharePoint Live Authentication always try to verify users emails' by email verification system, it mean even you set EmailRequired to false, it just don’t force users to enter e-mail but if they enter email, they should verify it.
Example: EmailRequired=false
Use SharePoint default sign-in page
Shetab SharePoint Live Authentication redirect user to its own sign-in page by default, if you like to use original SharePoint multi login page that ask the user the authentication system first, you can set SetAsDefaultSignInPage parameter to false.
Example: @SET SetAsDefaultSignInPage=false