Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
364 lines (301 sloc) 14.7 KB
title description review labels toc confluence tree_item_index version_override history
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.
comment date status
2017-12-13
ok
admin-center
bchauvin
update-center
lts2017-ok
true
ajs-parent-page-id ajs-parent-page-title ajs-space-key ajs-space-name canonical canonical_source page_id shortlink shortlink_source source_link
3866685
Installation
NXDOC
Nuxeo Platform Developer Documentation
Registering+your+Nuxeo+Instance
4686231
l4FH
/display/NXDOC/Registering+your+Nuxeo+Instance
1200
LTS 2015 6.0 5.8
710/admindoc/registering-your-nuxeo-instance
60/admindoc/registering-your-nuxeo-instance
58/admindoc/registering-your-nuxeo-instance
author date message version
Solen Guitter
2016-09-08 11:57
XDOC-857: remove nuxeo.i
30
author date message version
Solen Guitter
2016-07-04 14:32
Add since 8.3 mention
29
author date message version
Solen Guitter
2016-07-04 14:32
Add section about nuxeoctl register
28
author date message version
Solen Guitter
2016-03-31 15:31
27
author date message version
Solen Guitter
2016-03-30 13:04
Rename Connect into Online Services
26
author date message version
Julie Allouch
2016-03-29 20:32
25
author date message version
Manon Lumeau
2016-03-25 10:06
24
author date message version
Solen Guitter
2015-09-04 09:07
23
author date message version
Solen Guitter
2014-11-21 16:40
22
author date message version
Solen Guitter
2014-11-21 16:24
Update screenshots and content with new registration steps
21
author date message version
Manon Lumeau
2014-09-23 14:27
20
author date message version
Solen Guitter
2014-02-10 18:15
19
author date message version
Solen Guitter
2014-02-10 18:04
Updated screenshot
18
author date message version
Solen Guitter
2014-02-10 17:27
17
author date message version
Solen Guitter
2014-02-10 17:23
16
author date message version
Solen Guitter
2013-10-16 16:52
15
author date message version
Solen Guitter
2012-12-14 12:00
14
author date message version
Solen Guitter
2012-12-11 14:33
13
author date message version
Solen Guitter
2012-12-11 14:32
Updated offline registration steps with latest Connect UI
12
author date message version
Solen Guitter
2012-12-07 18:04
11
author date message version
Solen Guitter
2012-12-07 18:04
10
author date message version
Solen Guitter
2012-09-14 09:48
Migrated to Confluence 4.0
9
author date message version
Solen Guitter
2012-09-14 09:48
Updated links
8
author date message version
Solen Guitter
2012-04-20 18:14
7
author date message version
Benjamin Jalon
2012-01-20 10:02
6
author date message version
Solen Guitter
2010-11-15 10:13
5
author date message version
Solen Guitter
2010-11-08 18:08
4
author date message version
Solen Guitter
2010-11-05 16:57
3
author date message version
Solen Guitter
2010-11-05 16:45
2
author date message version
Solen Guitter
2010-11-05 16:44
1

Registering your Nuxeo application with [Nuxeo Online Services]({{page space='studio' page='index'}}) 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.

{{#> callout type='info' heading='Nuxeo University'}} Watch the related courses on Nuxeo University

{{#> callout type='note' no_icon=true}} 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. {{/callout}}

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]({{page page='nuxeoctl-and-control-panel-usage'}}) 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 {{> anchor 'connect-account-creation'}}

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]({{page page='registering-your-nuxeo-instance'}}#registering-online-through-the-admin-tab) 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 {{> anchor 'online-registration'}}

The following method requires an Internet connection.

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

// Windows
$ .\$NUXEO_HOME\bin\nuxeoctl.bat stop
  1. Register the instance
// Linux and macOS
// 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]({{page page='nuxeoctl-and-control-panel-usage'}}).

Registering Online through the Admin Tab

{{! multiexcerpt name='requires-jsf-ui'}} {{#> callout type='info' no_icon=true}} These instructions require the JSF UI addon. If you are using Web UI, you should register using the nuxeoctl script instead.{{/callout}} {{! /multiexcerpt}}

  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]({{page page='installing-a-new-package-on-your-instance'}})).

Registering Offline Using nuxeoctl {{> anchor 'offline-registration'}}

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:

  2. Make sure your instance is stopped: ``` // Linux and macOS $ $NUXEO_HOME/bin/nuxeoctl stop

// Windows
$ .\$NUXEO_HOME\bin\nuxeoctl.bat stop
```
  1. Launch registration: ``` // Linux and macOS // 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

{{{multiexcerpt 'requires-jsf-ui' page='registering-your-nuxeo-instance'}}}

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. ![]({{file name='AdminCenter-offline-registration.png'}} ?w=500,border=true)
    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. ![]({{file name='AdminCenter-offline-registration-3.png'}} ?w=500,border=true) 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. ![]({{file name='AdminCenter-offline-registration-done.png'}} ?w=600,border=true)

Renewing Registration for Your Nuxeo Instance {{> anchor 'renewal'}}

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 macOS
// 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.

{{#> callout type='note' title='Important Note About Hotfixes' no_icon=true}} 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. {{/callout}}

Re-Registering your Nuxeo Instance

{{> anchor 're-registration'}}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:

{{{multiexcerpt 'requires-jsf-ui' page='registering-your-nuxeo-instance'}}}

  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. ![]({{file name='AdminCenter-offline-registration-3.png'}} ?w=450,border=true) Your instance is registered again and the registration summary is displayed. ![]({{file name='Admin-Center-Connect.png'}} ?w=650,h=267,border=true)
You can’t perform that action at this time.