Nuxeo Server

Registering your Nuxeo Instance

Updated: September 22, 2017 Page Information Edit on GitHub

Registering your Nuxeo application with Nuxeo Online Services will give you access to the Update Center, so that you can easily install patches and bug fixes, install addons from the Nuxeo Marketplace, or update your application with your Nuxeo Studio customization, all that directly from the Nuxeo Platform.

The registration process only copies a file on your file system. This enables the Nuxeo Online Services portal to identify the instance among all the registered instances. You can register multiple instances.

How to Register

To be able to register, you need to have a Nuxeo Online Services account.

Registration can be done during the installation steps using the configuration wizard or at any time later, through the Admin tab or using the nuxeoctl script.

Registration does not require an Internet access. If your server cannot connect to the Internet, follow the offline registration steps. Otherwise, follow the online registration steps.

For development instances on which you may need to remove your data, you may need to re-register your instance.

Registering Using nuxeoctl

Registration using nuxeoctl requires an Internet connection.

Since 8.3, the nuxeoctl script allows you to register your instance using an existing Nuxeo Online Services or to subscribe to a trial as you register your instance.

// Linux and Mac OS
// You don't have a Nuxeo Online Service account
$ $NUXEO_HOME/bin/nuxeoctl register-trial
// OR you already have a Nuxeo Online Service account
$ $NUXEO_HOME/bin/nuxeoctl register

// Windows
// You don't have a Nuxeo Online Service account
$ .\$NUXEO_HOME\bin\nuxeoctl.bat register-trial
// OR you already have a Nuxeo Online Service account
$ .\$NUXEO_HOME\bin\nuxeoctl.bat register

For more information about the nuxeoctl script, read nuxeoctl and Control Panel Usage.

Creating your Nuxeo Online Services Account

If you already have an account for Nuxeo Online Services, either because you are a Nuxeo customer, or because you created a trial account, you can continue to the Registering Online step. If not, follow those steps to get credentials to Online Services.

To subscribe to a Nuxeo Online Services trial:

  1. Go to the Nuxeo Online Services trial registration form.
  2. Fill in the form. Provide a valid email address or else registration will not be completed.
  3. Confirm registration by clicking on the link sent to the email address in the previous step. You can now use the Nuxeo Platform online or download it if you want to use it on premises.

Registering Online through the Admin Tab

  1. Start your Nuxeo instance and connect as an administrator (Administrator/Administrator by default).
  2. Click on the Admin tab.
  3. In the Nuxeo Online Services tab, click on Register this instance. A Nuxeo Connect login window pops up.
  4. Authenticate to Nuxeo Online Services portal by giving your credentials.
  5. Select the project to associate with your instance. The pop-up closes. Your instance is now registered. You can now browse the various tabs of the Update Center area, and install addons from the Nuxeo Marketplace (see the page Installing a New Package on Your Instance).

Registering Offline

Offline registration can be used when the server does not connect to the Internet. It enables to remove the Nuxeo Online Services registration message.

To register your instance for the first time:

  1. On the offline server:

    1. Start your Nuxeo instance and connect as an administrator (Administrator/Administrator by default).
    2. Click on the Admin tab. The Nuxeo Online Services tab is displayed.
    3. Copy the instance technical identifier called CTID (ex:Mac OS X-EbMKUsirT9WQszM5mDkaKAp=-BhnJsMDaabDHAQ0A300d6Q==) displayed in the No network access? box.
    4. Store the CTID in a file that you can use from another computer that can connect to the Internet.
  2. From an Internet-connected computer:

    1. Go to the Nuxeo Online Services portal.
    2. Click on the application title for which you want to register your Nuxeo Platform.
    3. Put your mouse over the icon  and click Add a new instance.
    4. Fill in the registration form and submit it. The instance is registered. You are given an identifier (CLID) to validate registration from Nuxeo Admin tab.
    5. Copy this identifier.
  3. On the offline server:
    1. In the Admin tab, fill in the instance description, paste the CLID from Nuxeo Online Services and click on the Register this instance button.
      The registration is approved and the registration summary is displayed. The Nuxeo Online Services registration message is not displayed anymore after you browse the application, although registration cannot be validated on the Nuxeo Online Services server.

Re-Registering your Nuxeo Instance

If you have removed your data from your Nuxeo application, in case of a development instance, for example, you will need to register your instance again.

To re-register your instance:

  1. Log in to the Nuxeo Online Services portal.
  2. In the associated instances, click on your Nuxeo instances link. The page listing the associated instances for your project opens.
  3. Copy the Identifier of the instance you want to register (Identifier is of the form dedaf21-be00-412e-b0ab-f2394479d5f8--885dcf60-5a4a-46e8-a904-0123456789ab). In the Nuxeo Admin tab, paste this identifier in the CLID field and click on the Register this instance button.
    Your instance is registered again and the registration summary is displayed.
3 days ago manonlumeau NXDOC-1323: Update BDE doc
a year ago Solen Guitter 30 | XDOC-857: remove nuxeo.i
a year ago Solen Guitter 28 | Add section about nuxeoctl register
a year ago Solen Guitter 29 | Add since 8.3 mention
a year ago Solen Guitter 27
a year ago Solen Guitter 26 | Rename Connect into Online Services
a year ago Julie Allouch 25
2 years ago Manon Lumeau 24
2 years ago Solen Guitter 23
3 years ago Solen Guitter 22
3 years ago Solen Guitter 21 | Update screenshots and content with new registration steps
3 years ago Manon Lumeau 20
4 years ago Solen Guitter 19
4 years ago Solen Guitter 18 | Updated screenshot
4 years ago Solen Guitter 17
4 years ago Solen Guitter 16
4 years ago Solen Guitter 15
5 years ago Solen Guitter 14
5 years ago Solen Guitter 13
5 years ago Solen Guitter 12 | Updated offline registration steps with latest Connect UI
5 years ago Solen Guitter 10
5 years ago Solen Guitter 11
5 years ago Solen Guitter 8 | Updated links
5 years ago Solen Guitter 9 | Migrated to Confluence 4.0
5 years ago Solen Guitter 7
6 years ago Benjamin Jalon 6
7 years ago Solen Guitter 5
7 years ago Solen Guitter 4
7 years ago Solen Guitter 3
7 years ago Solen Guitter 2
7 years ago Solen Guitter 1
History: Created by Solen Guitter