Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
565 lines (447 sloc) 19.9 KB
title review labels toc confluence tree_item_index version_override history
Installing a New Package on Your Instance
comment date status
2017-12-14
ok
content-review-lts2016
admin-center
bchauvin
update-center
admin-center-component
multiexcerpt-include
multiexcerpt
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
16089349
Nuxeo Add-Ons
NXDOC
Nuxeo Platform Developer Documentation
Installing+a+New+Package+on+Your+Instance
4686234
moFH
/display/NXDOC/Installing+a+New+Package+on+Your+Instance
100
LTS 2015 6.0 5.8
710/admindoc/installing-a-new-package-on-your-instance
60/admindoc/installing-a-new-package-on-your-instance
58/admindoc/installing-a-new-package-on-your-instance
author date message version
Solen Guitter
2016-07-04 15:32
ove nuxeoctl instructions u
32
author date message version
Manon Lumeau
2016-04-22 09:21
Fix links
31
author date message version
Manon Lumeau
2016-04-21 16:03
30
author date message version
Manon Lumeau
2016-03-11 13:50
29
author date message version
Manon Lumeau
2016-03-11 13:42
28
author date message version
Manon Lumeau
2016-03-11 13:40
27
author date message version
Manon Lumeau
2016-03-11 13:39
26
author date message version
Manon Lumeau
2016-03-11 13:32
Merge install and uninstall package
25
author date message version
Solen Guitter
2015-11-26 14:08
24
author date message version
Solen Guitter
2015-11-26 13:41
NXDOC-658: Marketplace packages are now called Nuxeo Packages
23
author date message version
Solen Guitter
2014-11-24 18:27
Add note about dependencies in offline mode
22
author date message version
Solen Guitter
2014-11-24 18:09
21
author date message version
Thierry Martins
2014-11-24 18:00
20
author date message version
Solen Guitter
2014-11-24 17:54
19
author date message version
Solen Guitter
2014-11-24 17:49
Add nuxeoctl steps and related pages
18
author date message version
Solen Guitter
2014-11-24 16:14
Update screenshot for offline and Marketplace installation steps
17
author date message version
Solen Guitter
2014-11-24 15:10
Screenshot update
16
author date message version
Solen Guitter
2014-11-24 14:13
15
author date message version
Solen Guitter
2013-10-16 16:58
14
author date message version
Solen Guitter
2012-12-19 15:33
13
author date message version
Solen Guitter
2012-12-19 15:02
Added offline installation steps
12
author date message version
Solen Guitter
2012-12-14 12:09
11
author date message version
Solen Guitter
2012-12-14 12:00
10
author date message version
Solen Guitter
2012-12-14 12:00
Updated steps
9
author date message version
Solen Guitter
2012-12-07 18:04
8
author date message version
Solen Guitter
2011-06-07 17:22
Migration of unmigrated content due to installation of a new plugin
7
author date message version
Solen Guitter
2011-06-07 17:22
Migration of unmigrated content due to installation of a new plugin
6
author date message version
Solen Guitter
2011-06-07 17:22
Migrated to Confluence 4.0
5
author date message version
Solen Guitter
2011-06-07 17:22
4
author date message version
Solen Guitter
2011-06-07 15:08
3
author date message version
Solen Guitter
2010-11-15 12:07
2
author date message version
Solen Guitter
2010-11-05 16:52
1

Packages can be installed directly from the Admin tab, from the Marketplace or using the nuxeoctl script. Packages can be addons bringing new features or hotfixes providing corrections or small improvements. Some Nuxeo Packages are totally public, not requiring a Nuxeo Online Services account to install them. Others can only be installed on instances [registered on Nuxeo Online Services]({{page page='registering-your-nuxeo-instance'}}).

Online Installation

Installing a Package Using the nuxeoctl Script

{{! multiexcerpt name='nuxeoctl-note'}}

The instructions below provide the steps to follow to install a package using the nuxeoctl script, without detailed explanation about nuxeoctl. For an overview of this script, please read the page [nuxeoctl and Control Panel Usage]({{page space='NXDOC' page='nuxeoctl and+Control+Panel+Usage'}}).

For Windows users, use nuxeoctl.bat instead of ./nuxeoctl commands below.

{{! /multiexcerpt}}

  1. Stop your server.

    ./nuxeoctl stop
    
  2. Get the name or ID of the package you want to download. You can get it from the package Marketplace URL: For instance, the ID of the Nuxeo Drive package (https://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-drive?version=1.6.6) is nuxeo-drive-1.6.6.

  3. Install the package.

    ./nuxeoctl mp-install nuxeo-drive-1.6.6
    

    The server checks possible dependencies.

    Detected Tomcat server.
    Nuxeo home:          /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat
    Nuxeo configuration: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/bin/nuxeo.conf
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/common-base
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/common
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/default
    
    Optional dependencies [nuxeo-jsf-ui] will be ignored for 'nuxeo-drive-1.6.6'.
    
    Dependency resolution:
    Installation order (1):        nuxeo-drive-1.6.6
    Unchanged packages (2):        nuxeo-web-ui:1.0.1, nuxeo-spreadsheet:1.2.4
    Packages to download (1):      nuxeo-drive:1.6.6
    
  4. Confirm installation.

    Do you want to continue (yes/no)? [yes] yes
    

    The package is downloaded and installed.

    Do you want to continue (yes/no)? [yes]
    Downloading [nuxeo-drive-1.6.6]...
    Added nuxeo-drive-1.6.6
    Installing nuxeo-drive-1.6.6
    
  5. Start your server.

    ./nuxeoctl start
    

Alternative Syntax Options

It is possible to ask for installation without specifying a version number. In this case, nuxeoctl will retrieve the latest version available compatible with your current Nuxeo Server version.

  ./nuxeoctl mp-install nuxeo-drive

  [...]

  Installation order (1):        nuxeo-drive-1.6.6
  Unchanged packages (2):        nuxeo-web-ui:1.0.1, nuxeo-spreadsheet:1.2.4
  Packages to download (1):      nuxeo-drive:1.6.6

You can also install several packages in a single command. Package names should be separated with a space.

./nuxeoctl mp-install nuxeo-web-ui nuxeo-dam nuxeo-drive

  [...]

  Dependency resolution:
    Installation order (3):        nuxeo-web-ui-1.0.1/nuxeo-dam-6.2.3/nuxeo-drive-1.6.6
    Packages to download (2):      nuxeo-web-ui:1.0.1, nuxeo-drive:1.6.6
    Local packages to install (1): nuxeo-dam:6.2.3

If for some reason one of the packages requested can't be installed, nuxeoctl will not install any of them.

./nuxeoctl mp-install nuxeo-web-ui nuxeo-drive unknown-package-name

[...]

org.nuxeo.connect.update.PackageException: Package not found: unknown-package-name

Installing a Package from the Admin Tab

{{{multiexcerpt 'JSF-UI-required' page='generic-multi-excerpts'}}}

The Admin tab includes a section called Update Center from which you can easily install hotfixes, updates, addons and your customizations. The Update Center features a Packages from Nuxeo Marketplace tab that shows the list of packages available from the Marketplace and allowing you to install these packages directly from your Nuxeo application.

To install a package from the Admin tab:

  1. As an administrator (Administrator/Administrator by default), in the Admin tab, click on the Update Center left tab.

  2. Click on the Packages from Nuxeo Marketplace. The list of available packages, including hotfixes and addons, is displayed. By default, only packages compatible with your version of the Nuxeo Platform are listed.

  3. Optionally, filter the list of packages:

    • Uncheck the Show only packages compatible with my distribution box if you want to see all available packages;
    • Check the Hide local packages box if you want to hide already downloaded packages from the list. ![]({{file name='Admin-Center-updateCenter.png'}} ?w=650,h=287,border=true)
  4. Click on the Download link of the package you want to install. A download in progress page is displayed while the package is being downloaded. ![]({{file name='package-downloading.png'}} ?w=350,border=true) When the download is finished, the list of packages is displayed again and the downloaded package has an Install link. ![]({{file name='package-downloaded.png'}} ?w=600,border=true) The package is also available from the Local packages tab of the Update Center.

  5. Click on the Install link to start the installation. ![]({{file name='package-installation-start-page.png'}} ?w=450,border=true)

  6. Start the installation by clicking on the Start button.

{{#> callout type='info' heading='Packages with dependencies'}} If the package has some missing dependencies, the Start button is not displayed. You are displayed a series of steps to install the required dependencies.

a. If dependency packages are not already in the Local packages, you need to download them. Click on the Download all packages button. ![]({{file name='package-dependencies-download.png'}} ?w=350,border=true) Required packages are downloaded.

b. Click on the Installation of package and dependencies button. ![]({{file name='package-dependencies-installation.png'}} ?w=350,border=true) A page detailing the packages to be installed is displayed.

c. Click on the Confirm install button at the bottom of the page. ![]({{file name='package-dependencies-installation-confirmation.png'}} ?w=400,border=true) {{/callout}}

Once the installation is done, a confirmation screen is displayed.

  1. Click on the Finish button.

    ![]({{file name='package-installation-finish.png'}} ?w=600,border=true)

    You need to restart the application for the installation to be completed. ![]({{file name='package-restart-required.png'}} ?w=600,border=true)

    {{#> callout type='tip' heading='Hot-reload'}} Some packages don't require the server to be restarted to be fully installed. For instance your Nuxeo Studio configuration, when the [dev mode]({{page page='deploying-your-project-in-dev-mode' space='studio'}}) is activated. {{/callout}}

  2. Click on the Restart required button to restart the server.

  3. On the pop-up displayed, click on the OK button to confirm restart. ![]({{file name='restart-confirmation-popup.png'}} ?w=300,border=true,thumbnail=true)

    You're displayed a Restarting page as the server is restarting. ![]({{file name='restarting-page.png'}} ?w=550,border=true) The server immediately restarts. The login page will automatically be displayed when the server is restarted.

Offline Installation

It is possible to install packages available on the Nuxeo Marketplace even if your server is not connected to the Internet. This takes two steps:

  1. Download the package from the Marketplace.
  2. Install the package using the nuxeoctl script or upload it from the Update Center.

Installing a Package Offline Using the nuxeoctl Script

{{{multiexcerpt 'nuxeoctl-note' page='Installing a New Package on Your Instance'}}}

  1. Stop your server.

    ./nuxeoctl stop
    
  2. Install the package by providing the path to the downloaded .zip file.

    ./nuxeoctl mp-install /Users/NUXEO/Downloads/nuxeo-drive-1.6.6.zip
    

    The server checks possible dependencies.

    Detected Tomcat server.
    Nuxeo home:          /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat
    Nuxeo configuration: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/bin/nuxeo.conf
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/common-base
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/common
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/default
    Added /Users/NUXEO/Downloads/nuxeo-drive-1.6.6.zip
    
    Optional dependencies [nuxeo-jsf-ui] will be ignored for 'nuxeo-drive-1.6.6'.
    
    Dependency resolution:
    Installation order (1):        nuxeo-drive-1.6.6
    Unchanged packages (2):        nuxeo-web-ui:1.0.1, nuxeo-spreadsheet:1.2.4
    
    Do you want to continue (yes/no)? [yes]
    

    If some dependencies are not already locally available, repeat this step for each required package.

  3. Confirm installation.

    Do you want to continue (yes/no)? [yes] yes
    

    Installation is confirmed.

    Installing nuxeo-drive-1.6.6
    
  4. Start the server.

    ./nuxeoctl start
    

Downloading a Package from the Marketplace

{{#> callout type='tip' }}

Depending on the package you want to install, you may need to be logged in to the Marketplace to download the package.

{{/callout}}

  1. On the Nuxeo Marketplace, click on the Install button of the package you want to install, then on the download link. ![]({{file name='marketplace-download.png'}} ?w=600,border=true)
  2. Save the .zip file on a disk that is accessible by the Nuxeo server or directly on a storage device.

Installing a Package Offline from the Admin Tab

{{{multiexcerpt 'JSF-UI-required' page='generic-multi-excerpts'}}}

  1. As administrator (Administrator/Administrator by default), in the Admin tab, click on the Update Center left tab.

  2. Click on the Local packages tab.

  3. Click on the Upload a package button. An upload form is displayed just below the tabs. ![]({{file name='package-upload.png'}} ?w=600,border=true)

  4. Click on the Choose file button to select the downloaded package .zip package file.

  5. Click on the Upload button. The package is uploaded to the server and ready to be installed.

  6. Install the package by clicking on the Install link. ![]({{file name='package-downloaded.png'}} ?w=600) A confirmation page is displayed.

  7. Click on Start to confirm installation. ![]({{file name='package-installation-start-page.png'}} ?w=500,border=true) Once the set up is achieved, a message from the server confirms that the installation was performed correctly.

  8. If required, restart the server by clicking the Restart required button that replaces Install and Remove buttons. Otherwise, installation is completed and you're displayed an Uninstall button.

  9. On the pop-up displayed, click on the OK button to confirm restart. ![]({{file name='restart-confirmation-popup.png'}} ?w=300,border=true,thumbnail=true)

    You're displayed a Restarting page as the server is restarting. The login page is displayed as soon as the server is available again. ![]({{file name='restarting-page.png'}} ?w=500,border=true)

Uninstalling a Package

Uninstalling a package can be done from a terminal using the nuxeoctl script or from the Admin tab.

Uninstalling a Package Using the nuxeoctl Script

The instructions below provide the steps to follow to uninstall a package using the nuxeoctl script. For a overview of this script, please read the page [nuxeoctl and Control Panel Usage]({{page page='nuxeoctl-and-control-panel-usage'}}).

  1. Stop your server.

    ./nuxeoctl stop
    
  2. In a terminal, get the list of packages available on your Nuxeo server.

    ./nuxeoctl mp-list
    
  3. Copy the name of the id of the package you want to uninstall.

  4. Run the uninstallation:

    ./nuxeoctl mp-uninstall nuxeo-dam-6.0.0
    

    The server checks possible dependencies:

    Detected Tomcat server.
    Nuxeo home:          /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat
    Nuxeo configuration: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/bin/nuxeo.conf
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/common-base
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/common
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/default
    Include template: /Users/NUXEO/Downloads/nuxeo-server-8.10-tomcat/templates/drive
    
    Dependency resolution:
      Uninstallation order (1):      nuxeo-dam-6.0.0
      Unchanged packages (2):        nuxeo-drive:1.4.1, nuxeo-spreadsheet:1.0.0
      Local packages to remove (1):  nuxeo-dam:6.0.0
    
    Do you want to continue (yes/no)? [yes]
    
  5. Confirm uninstallation.

    Do you want to continue (yes/no)? [yes] yes
    

    Uninstallation is confirmed.

    Uninstalling nuxeo-dam-6.0.0
    
  6. Start the server.

    ./nuxeoctl start
    

Uninstalling a Package from the Admin Tab

{{{multiexcerpt 'JSF-UI-required' page='generic-multi-excerpts'}}}

  1. In the Admin tab, go on the Local packages tab of the Update Center. The list of packages that you have downloaded and possibly installed is displayed.

  2. Click on the Uninstall link of the package you want to uninstall from your application. A confirmation message is displayed.

  3. Click on the Start button to confirm you want to uninstall the package. ![]({{file name='AdminCenter-uninstall2.png'}} ?w=450,border=true)

  4. When uninstallation is done, click on the Finish button. ![]({{file name='AdminCenter-uninstall3.png'}} ?w=600,border=true) The list of packages is displayed. You need to restart the application for the uninstallation to be completed.

    {{#> callout type='tip' heading='Hot-reload'}}

    Some packages don't require the server to be restarted to be fully uninstalled.

    {{/callout}}

    ![]({{file name='AdminCenter-uninstall4.png'}} ?w=600,h=186,border=true)

  5. Click on the Restart server button and confirm server restart.

  6. When the server is restarted, log back in and go the Local Packages tab. The uninstalled package now has an Install link displayed. ![]({{file name='AdminCenter-uninstall5.png'}} ?w=600)


{{#> panel heading='Related Documentation'}}
  • [nuxeoctl and Control Panel Usage]({{page page='nuxeoctl-and-control-panel-usage'}})
  • [Admin Tab Overview]({{page page='admin-tab-overview'}})

{{/panel}}