Search the SharePoint Connector 1.0 documentation:

[Downloads (PDF, HTML & XML formats)]
[Other versions]

This documentation relates to an earlier version of the SharePoint Connector.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata


1. Confluence 2.6.1 or later.
    a. See to download
2. Windows SharePoint Services (WSS) v3 (free with Windows Server 2003).
    (info) To check whether Windows SharePoint Services are installed, go to Start, All Programs, Admin, SharePoint 3.0 Central Administration. If you can see 'SharePoint 3.0 Central Administration', it is already installed.
    a. See for information.
    b. To download, see this page.
3. (optional) Microsoft Office SharePoint Server (MOSS) 2007 (Standard or Enterprise)
MOSS is Required for the following features:
    a. Integrated Search
    b. Single Sign-On functionality from SharePoint using Windows Integrated Authentication to Confluence using Forms Based Authentication. See this page for information.

4. To download a trial version of MOSS, see this page.

5. To determine whether you have WSS v3 or MOSS 2007 installed, go to Add/Remove Programs. If you see "Microsoft Office SharePoint Server 2007" you have MOSS; if you see "Microsoft Windows SharePoint Services" you just have WSS v3.

Installing the plugin

To install the plugin, do the following:

  1. In Confluence, navigate to Administration -> Plugin Repository -> SharePoint Plugin.
    • (for Confluence 2.6 you need to download the plugin jar manually, copy into confluence/WEB-INF/lib and restart the server - then skip down to 'Configuring the SharePoint plugin' ).
  2. On the row named SharePoint Plugin, click on 'install'.
    (if your Confluence server doesn't have an Internet connection attached, you can CONFEXT:download the Confluence SharePoint plugin separately. Once installation is complete, move on to configuration.
  3. If you're using the SharePoint web part features, then you need to install the Confluence permission check RPC plugin (follow link for instructions).
    1. If you're running Confluence 3.0 or later, you will have to manually enable Confluence Remote API in Confluence Admin > General Configuration, CONFEXT:Remote API.
    2. If you're running Confluence 2.7+ you can do this from the Plugin Repository (see step 1).
    3. If you're running Confluence 2.6 or earlier, download the Confluence permission check RPC plugin to this directory:
      Following this, restart Confluence.
  4. If you're running Confluence 2.8 or earlier, you have to manually update the Atlassian extras file.

Important: Once you've installed the plug-in, you have to put the license information into it, or it won't work.

Configuring the SharePoint plugin

Ensure you also read the next passage, entitled Important Conditions for Configuration Values. Otherwise, your configuration may fail.

Make sure you're logged in with Administration privileges.

1. Navigate to Administration -> SharePoint Admin (under the Administration list on the left)
(note: this information is for version 1.0.4 of the plugin or higher)

SharePoint Plugin Admin screen details

Screenshot: The SharePoint Admin Screen

2. Set the theme. Navigate to Administration -> Themes and select the 'SharePoint theme'.

Screenshot: Choosing the SharePoint theme

3. Set the configuration values.

Sample values for configuration:

Server URL: atlassian-serv:80 username = ATLASSIAN-SERV\Administrator password = ******* Search URL = http://atlassian-serv/_layouts/searchresults.aspx (forWSS, MOSS is slightly different)Search Field Name = k (thisisforMOSS)

Add your SharePoint License to the SharePoint Admin screen

Be sure to add your SharePoint Connector license at the bottom of the SharePoint Admin screen.

Important Conditions for Configuration Values

1. 'Server Name' Value
The SERVERNAME value is especially important. Leaving out the SERVERNAME will cause failure. Notice also it is the backslash being used, \ not the forward-slash. It's very easy to accidentally get this wrong.

2. Username Format
The username must be of the format:


Make sure the username provided is a SharePoint site administrator for any site from which list and document library data is retrieved with the sp-list macro. Using a site collection administrator will ensure this.

3. Setting Home Page URL
If your SharePoint home page has a URL like the following:


then you will need to use a setting like this:


4. User Attributes
The user specified must have either of the following attributes:

  • Be a local user to the SharePoint server, as opposed to a domain user if the SharePoint server is running as a local user.
  • If the SharePoint server is running as a domain user, then a domain user can be used for this setting. Otherwise it seems that SharePoint doesn't know how to resolve domain users coming in via a web service.

5. Configure SharePoint for 'Basic Authentication'
SharePoint must be configured to use either NTLM and/or Basic Authentication. The 'authentication type' should be 'Windows'. These settings are found on SharePoint under Central Administration -> Application Management -> Authentication Providers.
Other configurations may be possible but have not been tested. Kerberos will not work at this time.

6. Human-Readable Names Preferred
Editing SharePoint documents works better if the Server URL is a name or domain name (such as as opposed to an IP address (such as

7. Optional - Configuring the plugin when the SharePoint server is using SSL
The SharePoint plugin within Confluence also supports SSL on SharePoint. You need only configure your container to connect to SSL services. In most cases this just involves adding the SSL certificate from the SharePoint server to the keystore maintained by your Java VM and then specifying http*s*://yourserver as the way to reach your SharePoint server in the plugin's configuration.

Details on how to do this can be found here: Connecting to SSL services
This is also a helpful reference for doing the same thing from a slightly different perspective: Configuring an SSL Certificate for Microsoft Active Directory

If you're still having problems after following these steps, see SharePoint Plugin configuration troubleshooting.

Version Info

Unknown macro: {repository-plugin}