<commit_before>---
description: A guide on installing the AD/LDAP Connector on different platforms.
---

# Install the AD/LDAP Connector on Non-Microsoft Platforms

This document covers how to install the AD/LDAP Connector on non-Microsoft Platforms.

:::panel-info Prerequisites
Prior to installing the AD/LDAP Connector, please ensure that you have already installed [Git](https://git-scm.com/download/linux), [Node.js](https://nodejs.org), and [npm](http://blog.npmjs.org/post/85484771375/how-to-install-npm).
:::

**Note**: For most platforms, you will need to run the required commands with root privileges.

1. Download the <a class="download-github" href=""></a> package to `/tmp`:

    <code class="curl-example"></code>

5. Expand the package and install dependencies:

    ```
    mkdir /opt/auth0-adldap
    tar -xzf /tmp/adldap.tar.gz -C /opt/auth0-adldap --strip-components=1
    cd /opt/auth0-adldap
    npm install
    ```
6. Run `node server.js` and insert the full ticket URL from the **Setup AD/LDAP connector** screen in the Auth0 console when prompted for "ticket number".

    ```
    Please enter the ticket number: https://YOUR_DOMAIN.auth0.com/some/other/stuff
    ```

7. You will be asked to edit the `config.json` configuration file. If you're using LDAP, see: [Modifying the Connector Settings](/connector/modify). Edit the `config.json` file to add your LDAP connection and authentication details as follows:

    ```
    "LDAP_URL": "ldap://YOUR_LDAP_SERVER_FQDN",
    "LDAP_BASE": "dc=YOURDOMAIN,dc=com",
    "LDAP_BIND_USER":"YOUR_LDAP_USER",
    "LDAP_BIND_PASSWORD":"<PASSWORD>" //<PASSWORD>
    ```

    When you next start the connector server with `node server.js`, the password will be read, hashed, and the line changed to
`"LDAP_BIND_CREDENTIALS":"hashed password"`

8. Run `node server.js` once more to start the connector.

9. Once the connector is running, you will need to daemonize the connector using a tool like upstart, systemd, init.d, etc.

<script type="text/javascript">
  $.getJSON('https://cdn.auth0.com/connector/windows/latest.json', function (data) {
    $('.download-github')
        .attr('href', 'https://github.com/auth0/ad-ldap-connector/releases/tag/v' + data.version)
        .text('adldap-' + data.version);

    $('.curl-example')
      .text('curl -Lo /tmp/adldap.tar.gz https://github.com/auth0/ad-ldap-connector/archive/v' + data.version + '.tar.gz');
  })
</script><commit_msg>Rewrite<commit_after>---
description: A guide on installing the AD/LDAP Connector on different platforms.
---

# Install the AD/LDAP Connector on Non-Microsoft Platforms

This document covers how to install the AD/LDAP Connector on non-Microsoft Platforms.

:::panel-info Prerequisites
Prior to installing the AD/LDAP Connector, please ensure that you have already installed [Git](https://git-scm.com/download/linux), [Node.js](https://nodejs.org), and [npm](http://blog.npmjs.org/post/85484771375/how-to-install-npm).
:::

**Note**: For most platforms, you will need to run the required commands with root privileges.

1. Download the <a class="download-github" href=""></a> package to `/tmp`:

    <code class="curl-example"></code>

2. Expand the <a class="download-github" href=""></a> package and install its dependencies:

    ```
    > mkdir /opt/auth0-adldap
    > tar -xzf /tmp/adldap.tar.gz -C /opt/auth0-adldap --strip-components=1
    > cd /opt/auth0-adldap
    > npm install
    ```

3. Start your server:

    ```
    node server.js
    ```

    When prompted for the ticket number, enter the full ticket URL from the **Settings** tab of the **Setup AD/LDAP connector** screen in the Auth0 Management Dashboard:

    ```
    > Please enter the ticket number: https://YOUR_DOMAIN.auth0.com/some/other/stuff
    ```

4. You will be prompted to edit the `config.json` configuration file with your LDAP connection and authentication details:

    ```
    "LDAP_URL": "ldap://YOUR_LDAP_SERVER_FQDN",
    "LDAP_BASE": "dc=YOURDOMAIN,dc=com",
    "LDAP_BIND_USER":"YOUR_LDAP_USER",
    "LDAP_BIND_PASSWORD":"<PASSWORD>" //cleartextpassword
    ```

    > If you're using LDAP, refer to the [Modifying the Connector Settings](/connector/modify) page.

5. Run `node server.js` once more to start the Connector.

      **Note**: The `LDAP_BIND_PASSWORD` line in `config.json` changes to `LDAP_BIND_CREDENTIALS` at this point.

6. Once the Connector is running, you will need to daemonize the Connector (if you don't already have a tool selected, you can consider [upstart](http://upstart.ubuntu.com/) or [systemd](https://www.freedesktop.org/wiki/Software/systemd/)).

<script type="text/javascript">
  $.getJSON('https://cdn.auth0.com/connector/windows/latest.json', function (data) {
    $('.download-github')
        .attr('href', 'https://github.com/auth0/ad-ldap-connector/releases/tag/v' + data.version)
        .text('adldap-' + data.version);

    $('.curl-example')
      .text('curl -Lo /tmp/adldap.tar.gz https://github.com/auth0/ad-ldap-connector/archive/v' + data.version + '.tar.gz');
  })
</script>

#### Notes

* If you get an `Invalid Ticket` message when configuring the Connector for the first time, the most likely cause is a network issue (for example, you have the Connector running behind a proxy). Try troubleshooting by connecting to `https://your_tenant.auth0.com/testall` with a browser other than Internet Explorer.
{'fraction_non_alphanumeric': 0.13700407860585836, 'fraction_numerical': 0.00982573229514275, 'mean_word_length': 3.7785651018600532, 'pattern_counts': {'":': 9, '<': 20, '<?xml version=': 0, '>': 26, 'https://': 14, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 9, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5991666', 'n_tokens_mistral': 1792, 'n_tokens_neox': 1694, 'n_words': 528}