Skip to content

Commit

Permalink
Update ad sync docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tusmester committed Feb 28, 2018
1 parent ed727f1 commit ed843aa
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 18 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# Active Directory snchronization for sensenet ECM
Two-way synchronization between the Content Repository and Active Directory for the [sensenet ECM](https://github.com/SenseNet/sensenet) platform. It handles users, groups, organizational units and memberships too.
Synchronization between Active Directory and the Content Repository for the [sensenet ECM](https://github.com/SenseNet/sensenet) platform. It handles users, groups, organizational units and memberships too.

[![Join the chat at https://gitter.im/SenseNet/sn-adsync](https://badges.gitter.im/SenseNet/sn-adsync.svg)](https://gitter.im/SenseNet/sn-adsync?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![NuGet](https://img.shields.io/nuget/v/SenseNet.SyncPortal2AD.Install.svg)](https://www.nuget.org/packages/SenseNet.SyncPortal2AD.Install)

[![NuGet](https://img.shields.io/nuget/v/SenseNet.SyncAD2Portal.Install.svg)](https://www.nuget.org/packages/SenseNet.SyncAD2Portal.Install)

You may install this component even if you only have the **sensenet ECM Services** main component installed. That way you'll get the backend part of the ad sync feature.

If you also have the [sensenet ECM WebPages](https://github.com/SenseNet/sn-webpages) component installed (which gives you a UI framework built on *ASP.NET WebForms* for sensenet ECM), you'll also get UI elements for managing the sync process.
If you also have the [sensenet ECM WebPages](https://github.com/SenseNet/sn-webpages) component installed (which gives you a UI framework built on the ASP.NET WebForms technology), you'll also get UI elements for managing the sync process.

> To find out which packages you need to install, take a look at the available [sensenet ECM components](http://community.sensenet.com/docs/sensenet-components).
Expand Down
4 changes: 3 additions & 1 deletion docs/adsync.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: At many companies users, groups and organization structure is store
At many companies users, groups and organization structure is stored and maintained in **Active Directory** - or in another storage, synced to AD. This is why sensenet ECM is capable of synchronizing AD objects into both directions:

- [AD to Portal sync](/docs/sync-ad-to-portal): AD users can be synchronized to the portal
- [Portal to AD sync](/docs/sync-portal-to-ad): portal users can be synchronized to AD servers.
- Portal to AD sync: portal users can be synchronized to AD servers (*this feature is not yet supported in sensenet ECM 7*).

![Active Directory](https://github.com/SenseNet/sn-adsync/raw/master/docs/images/adsync-adexplorer.png "Active Directory")

Expand Down Expand Up @@ -110,6 +110,8 @@ Notes:
There is a way to authenticate users against an Active Directory even when using **Forms authentication** (instead of using Windows Integrated authentication). This means that when a portal user logs in with Forms authentication, his/her password is checked against the user's password set in an Active Directory server and not against the one given on the portal.

#### Configuration
> This feature is not yet supported in sensenet ECM 7.
The settings for *forms authentication from AD* be found in the ```sensenet/formsAuthenticationFromAD``` section of the web.config. Below you can see a fully featured skeleton of this configuration:

```xml
Expand Down
16 changes: 7 additions & 9 deletions docs/install-adsync-from-nuget.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This article is **for developers** about installing the [AD sync](/docs/adsync)
There are two packages - one for each sync direction:

- Sync AD to Portal
- Sync Portal to AD
- Sync Portal to AD (*this feature is not yet supported in sensenet ECM 7*)

You do not have to install both - only the one for the direction you plan to synchronize users and groups (*AD-to-portal* synchronization is used a lot more widely, because companies are used to managing their internal security structure in AD).

Expand All @@ -32,14 +32,10 @@ To get started, **stop your web site** and install the 'sync AD to portal' packa

[![NuGet](https://img.shields.io/nuget/v/SenseNet.SyncAD2Portal.svg)](https://www.nuget.org/packages/SenseNet.SyncAD2Portal)

> `Install-Package SenseNet.SyncAD2Portal -Pre`
> `Install-Package SenseNet.SyncAD2Portal`
### Sync Portal to AD package
The other direction (synchronizing users and groups from the Content Repository to AD) is included in the following package:

[![NuGet](https://img.shields.io/nuget/v/SenseNet.SyncPortal2AD.svg)](https://www.nuget.org/packages/SenseNet.SyncPortal2AD)

> `Install-Package SenseNet.SyncPortal2AD -Pre`
> This feature is not yet supported in sensenet ECM 7.
## Installing the ad sync components in the repository
To complete the install process, please execute the appropriate SnAdmin command as usual:
Expand All @@ -49,5 +45,7 @@ To complete the install process, please execute the appropriate SnAdmin command

```text
.\snadmin install-syncad2portal
.\snadmin install-syncportal2ad
```
```

## Deploying the executor
For details about deploying the tool, please check out the [AD to Portal sync](/docs/sync-ad-to-portal) article.
6 changes: 2 additions & 4 deletions docs/sync-ad-to-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ description: Active Directory Synchronization is about replicating LDAP or porta
# Sync Active Directory to the portal
[Active Directory Synchronization](/docs/adsync) is about *replicating* LDAP or portal users, groups and other security-related entities in another server or repository. In case of 'AD to Portal' sync this means creating the same set of entities in the [Content Repository](/docs/content-repository) as in in **Active Directory (AD)**.

> This article contains information about the tool available from **version 6.5.3 (Patch 5)**. For earlier versions please visit the [AD to Portal sync (old)](http://wiki.sensenet.com/AD_to_Portal_sync_(old)) article.
The synchronization of users from Active Directory to the portal is performed by a [task executor](/docs/task-management#Task_Executor) tool. For details about deploying and managing task executors please visit the following article:

- [Task Management: deploying executors](/docs/task-management-for-developers#Deploying_executor_tools)
Expand Down Expand Up @@ -52,9 +50,9 @@ The settings for AD to Portal sync can be found here:
By navigating to this file in Content Explorer there are two ways to edit the settings:

- In explore mode: we provide a graphical user interface to edit settings
- Clinking on the *Edit in browser* link: the underlying JSON text can be found and edited in the browser's code editor
- Clicking on the *Edit in browser* link: the underlying JSON text can be edited in the browser's code editor

> Please note that all values (AD and Content Repository paths, property names, etc.) are **case sensitive**. Please use the exact same names here as the ones you see in the Active Directory.
> Please note that all values (AD and Content Repository paths, property names, etc.) are **case sensitive**. Please use the exact same names here as the ones you see in Active Directory.
The settings can be divided into the following main parts:

Expand Down

0 comments on commit ed843aa

Please sign in to comment.