Nuxeo Server

Registering your Nuxeo Instance

Registering your Nuxeo application with Nuxeo Online Services will let you 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.

Nuxeo University
Watch the related courses on Nuxeo University

The instance registration is only valid for your current subscription contract dates, and needs to be renewed on a regular basis. Please refer to the registration renewal section for further information.

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, using the nuxeoctl script or through the Admin tab if the JSF UI addon is installed.

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.

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 download the Nuxeo Platform.

Registering Online Using nuxeoctl

The following method requires an Internet connection.

  1. Make sure your instance is stopped
// Linux and Mac OS
$ $NUXEO_HOME/bin/nuxeoctl stop

// Windows
$ .\$NUXEO_HOME\bin\nuxeoctl.bat stop
  1. Register the instance
// Linux and Mac OS
// Requires a Nuxeo Online Service account
$ $NUXEO_HOME/bin/nuxeoctl register

// Windows
// Requires a Nuxeo Online Service account
$ .\$NUXEO_HOME\bin\nuxeoctl.bat register

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

Registering Online through the Admin Tab

These instructions require the JSF UI addon. If you are using Web UI, you should register using the nuxeoctl script instead.

  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 Using nuxeoctl

Offline registration can be used when the server does not connect to the Internet. It allows to use hotfixes on the instance.

Since 10.3, the nuxeoctl script allows you to register your instance offline using an existing Nuxeo Online Services account.

To register your instance for the first time:

  1. On the offline server:

    1. Make sure your instance is stopped
    // Linux and Mac OS
    $ $NUXEO_HOME/bin/nuxeoctl stop
    
    // Windows
    $ .\$NUXEO_HOME\bin\nuxeoctl.bat stop
    
    1. Launch Registration
    // Linux and Mac OS
    // Requires a Nuxeo Online Service account
    $ $NUXEO_HOME/bin/nuxeoctl register --offline
    
    // Windows
    // Requires a Nuxeo Online Service account
    $ .\$NUXEO_HOME\bin\nuxeoctl.bat register --offline
    

    nuxeoctl will display a CTID to be used for registration.

    1. 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 My Applications tab
    3. Click on the application name for which you want to register your Nuxeo Platform to access its settings.
    4. Click on the Instances tab
    5. Click on the Register Instance button
    6. Fill in the registration form and submit it.
      The instance is registered.
    7. Copy the identifier (CLID) from the instance you just registered.
  3. On the offline server:

    1. In nuxeoctl, paste the identifier (CLID) from Nuxeo Online Services and confirm registration.
      The registration is approved and the registration summary is displayed. You can now use hotfixes on this instance for the duration of your subscription.

Registering Offline Through the Admin Tab

These instructions require the JSF UI addon. If you are using Web UI, you should register using the nuxeoctl script instead.

Offline registration can be used when the server does not connect to the Internet. It allows to use hotfixes on the instance and removes 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 My Applications tab
    3. Click on the application name for which you want to register your Nuxeo Platform to access its settings.
    4. Click on the Instances tab
    5. Click on the Register Instance button
    6. Fill in the registration form and submit it.
      The instance is registered.
    7. Copy the identifier (CLID) from the instance you just registered.
  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.

Renewing Registration for Your Nuxeo Instance

Renewing your Nuxeo instance registration can be done anytime while you have an active Nuxeo Online Services subscription using the nuxeoctl script:

To renew the registration:

// Linux and Mac OS
// Requires an active Nuxeo Online Services subscription
// An internet connection
// And that instance is currently registered
$ $NUXEO_HOME/bin/nuxeoctl register --renew
// Windows
// Requires an active Nuxeo Online Services subscription
// An internet connection
// And that instance is currently registered
$ .\$NUXEO_HOME\bin\nuxeoctl.bat register --renew

Provided that your instance has internet access, this call can easily be automated using a cron / scheduled task. If for some reason your contract expires before you launch the command above though, you can still register your Nuxeo server instance as a new one by following the online of offline registration indications.

Using hotfixes on your instance requires a valid subscription.

If your instance is not registered anymore but still uses hotfixes, you will receive specific warnings in the logs during startup explaining the situation.

If it happens, your Nuxeo instance will stop after a certain number of commits or when too many users are connected at the same time. You should make sure to register your instance as soon as you can to prevent this.

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:

These instructions require the JSF UI addon. If you are using Web UI, you should register using the nuxeoctl script instead.

  1. Log in to the Nuxeo Online Services portal.
  2. Click on the My Applications tab
  3. Click on the application name for which you want to register your Nuxeo Platform to access its settings.
  4. Click on the Instances tab
  5. Copy the Identifier of the instance you want to register. 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.
15 days ago GitHub Fix double steps
19 days ago manonlumeau Review renewing section
19 days ago manonlumeau Update due to UI change, add offline for nuxeoctl
19 days ago manonlumeau Fix format
2 months ago Loubna Benzaama Fix Showcase Content add-on doc
2 years ago Solen Guitter 30 | XDOC-857: remove nuxeo.i
2 years ago Solen Guitter 28 | Add section about nuxeoctl register
2 years ago Solen Guitter 29 | Add since 8.3 mention
3 years ago Solen Guitter 27
3 years ago Solen Guitter 26 | Rename Connect into Online Services
3 years ago Julie Allouch 25
3 years ago Manon Lumeau 24
3 years ago Solen Guitter 23
4 years ago Solen Guitter 22
4 years ago Solen Guitter 21 | Update screenshots and content with new registration steps
4 years ago Manon Lumeau 20
5 years ago Solen Guitter 19
5 years ago Solen Guitter 18 | Updated screenshot
5 years ago Solen Guitter 17
5 years ago Solen Guitter 16
5 years ago Solen Guitter 15
6 years ago Solen Guitter 14
6 years ago Solen Guitter 13
6 years ago Solen Guitter 12 | Updated offline registration steps with latest Connect UI
6 years ago Solen Guitter 10
6 years ago Solen Guitter 11
6 years ago Solen Guitter 8 | Updated links
6 years ago Solen Guitter 9 | Migrated to Confluence 4.0
7 years ago Solen Guitter 7
7 years ago Benjamin Jalon 6
8 years ago Solen Guitter 5
8 years ago Solen Guitter 4
8 years ago Solen Guitter 3
8 years ago Solen Guitter 2
8 years ago Solen Guitter 1
History: Created by Solen Guitter

We'd love to hear your thoughts!

All fields required