Home > Developer Documentation Center > Getting Started > Tutorials > 1 - Discover Nuxeo Platform APIs > Setting up Your Nuxeo Environment
Getting Started

Setting up Your Nuxeo Environment

Updated: December 4, 2024

This how-to is the first step of the tutorial Getting Started with the Nuxeo Platform, allowing you to explore the Nuxeo Platform through its REST API. It provides instructions for installing and running a Nuxeo Platform instance using Docker, Homebrew or the ZIP package.

Docker

OS: Linux, Mac OS, Windows

Installation

  1. Install Docker: Follow the Docker Installation documentation.

  2. Download and start the Nuxeo Platform:

    $ docker run -ti --name mynuxeo -p 8080:8080 nuxeo/nuxeo:discover-ft

  3. Register your Nuxeo instance on Nuxeo Online Services:

    # You don't have a Nuxeo Online Service account
$ docker exec -ti mynuxeo bin/nuxeoctl register-trial
# OR
# You already have a Nuxeo Online Service account
$ docker exec -ti mynuxeo bin/nuxeoctl register

    And follow the instructions displayed.

Setting up Environment

You now have a Nuxeo Platform instance ready to run. At this step, you need to install some addons, in particular the addon Getting started with the Nuxeo Platform.

The addon Getting started with the Nuxeo Platform will add some business logic and documents to your Nuxeo Platform instance, that we will leverage all through this tutorial.

  1. Stop the server.

    $ docker exec mynuxeo bin/nuxeoctl stop

  2. Initialize local Nuxeo addons.

    $ docker exec mynuxeo bin/nuxeoctl mp-init

  3. Get the list of local Nuxeo addons.

    $ docker exec mynuxeo bin/nuxeoctl mp-list

    You get the list of local addons, whose status is downloaded.

  4. Install the addons required for this tutorial.

    $ docker exec -ti mynuxeo bin/nuxeoctl mp-install nuxeo-dam nuxeo-web-ui nuxeo-platform-getting-started

  5. Validate the dependency resolution step.

    Dependency resolution:
  Installation order (3):        nuxeo-dam-6.4.3/nuxeo-web-ui-2.4.0/nuxeo-platform-getting-started-1.3.3
  Packages to download (3):      nuxeo-web-ui:2.4.0, nuxeo-dam:6.4.3, nuxeo-platform-getting-started:1.3.3

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

  6. Check the Nuxeo addons were correctly installed.

    $ docker exec mynuxeo bin/nuxeoctl mp-list
[...]
Local packages:
 addon     started    nuxeo-dam (id: nuxeo-dam-6.4.3)
 addon     started    nuxeo-web-ui (id: nuxeo-web-ui-2.4.0)
 addon     started    nuxeo-platform-getting-started (id: nuxeo-platform-getting-started-1.3.3)

    The installed addons now have the status started.

  7. Start the server:

    $ docker exec mynuxeo bin/nuxeoctl start  
[...]
Server started with process ID 973.

    Your server is now running. You benefit from the following features brought by the addon Getting started with the Nuxeo Platform.

The addon brings the following document types:

  • The portfolio document type (BCPortfolio) holds the contracts of a customer. Its holds properties about the customer: the company name, industry and size, and the customer's juridical contact information.
  • The contract document type (BCContract) have several properties: an owner (an application user), some dates (signature, start, expiration dates), a type, an amount. It inherits customer information from its portfolio.
  • Some vocabularies are used to populate the portfolio and contract metadata (companySize, contractType and industry)
  • Contracts have a specific lifecycle, so they can evolve though the states draft, approval, running, renegociation and void
  • Some business logic through automation chains and event handlers make contracts inherit properties from its portfolio, and evolve following its lifecycle

Learn more

Homebrew

OS: Mac OS

Installation

  1. Install Homebrew: Follow their documentation.

  2. Install the Nuxeo Platform:

    $ brew install nuxeo

  3. Register your Nuxeo instance on Nuxeo Online Services:

    # You don't have a Nuxeo Online Service account
$ nuxeoctl register-trial
# You already have a Nuxeo Online Service account
$ nuxeoctl register

    And follow the instructions displayed.

Setting up Environment

You now have a Nuxeo Platform instance ready to run. At this step, you need to install some addons, in particular the addon Getting started with the Nuxeo Platform.

The addon Getting started with the Nuxeo Platform will add some business logic and documents to your Nuxeo Platform instance, that we will leverage all through this tutorial.

To install a Nuxeo Package:

  1. Initialize local Nuxeo addons.

    $ nuxeoctl mp-init

  2. Get the list of local Nuxeo addons.

    $ nuxeoctl mp-list

    You get the list of local addons, whose status is downloaded.

  3. Install the addons required for this tutorial.

    $ nuxeoctl mp-install nuxeo-dam nuxeo-web-ui nuxeo-platform-getting-started

  4. Validate the dependency resolution step.

    Dependency resolution:
  Installation order (3):        nuxeo-dam-6.4.3/nuxeo-web-ui-2.4.0/nuxeo-platform-getting-started-1.3.3
  Packages to download (3):      nuxeo-web-ui:2.4.0, nuxeo-dam:6.4.3, nuxeo-platform-getting-started:1.3.3

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

  5. Check the Nuxeo addons were correctly installed.

    $ nuxeoctl mp-list
[...]
Local packages:
 addon     started    nuxeo-dam (id: nuxeo-dam-6.4.3)
 addon     started    nuxeo-web-ui (id: nuxeo-web-ui-2.4.0)
 addon     started    nuxeo-platform-getting-started (id: nuxeo-platform-getting-started-1.3.3)

    The installed addons now have the status started.

  6. Start the server

    $ nuxeoctl console

    Your server is now running. You benefit from the following features brought by the addon Getting started with the Nuxeo Platform.

The addon brings the following document types:

  • The portfolio document type (BCPortfolio) holds the contracts of a customer. Its holds properties about the customer: the company name, industry and size, and the customer's juridical contact information.
  • The contract document type (BCContract) have several properties: an owner (an application user), some dates (signature, start, expiration dates), a type, an amount. It inherits customer information from its portfolio.
  • Some vocabularies are used to populate the portfolio and contract metadata (companySize, contractType and industry)
  • Contracts have a specific lifecycle, so they can evolve though the states draft, approval, running, renegociation and void
  • Some business logic through automation chains and event handlers make contracts inherit properties from its portfolio, and evolve following its lifecycle

Learn more

Universal ZIP Package

OS: Linux, Mac OS, Windows

Contrarily to the Brew installation or Docker image, the universal ZIP package comes without the related software needed for this tutorial. Please install and set up related software before going to the next step.

Installation

  1. Unzip the Nuxeo Platform .zip.

  2. Register your Nuxeo instance on Nuxeo Online Services:

    # Linux and Mac OS
# You don't have a Nuxeo Online Service account
$ ./$NUXEO_HOME/bin/nuxeoctl register-trial
# 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
# You already have a Nuxeo Online Service account
$ .\$NUXEO_HOME\bin\nuxeoctl.bat register

    And follow the instructions displayed.

Setting up Environment

You now have a Nuxeo Platform instance ready to run. In this step, you need to install some addons, in particular the addon Getting started with the Nuxeo Platform.

The addon Getting started with the Nuxeo Platform will add some business logic and documents to your Nuxeo Platform instance which we will leverage throughout this tutorial.

To install a Nuxeo Package:

  1. Initialize local Nuxeo addons.

    # Linux and Mac OS
$ ./nuxeoctl mp-init

# Windows
$ .\nuxeoctl.bat mp-init

  2. Get the list of local Nuxeo addons.

    # Linux and Mac OS
$ ./nuxeoctl mp-list

# Windows
$ .\nuxeoctl.bat mp-list

    You get a list of the local addons that have been downloaded.

  3. Install the addons required for this tutorial.

    # Linux and Mac OS
$ ./nuxeoctl mp-install nuxeo-dam nuxeo-web-ui nuxeo-platform-getting-started

# Windows
$ .\nuxeoctl.bat mp-install nuxeo-dam nuxeo-web-ui nuxeo-platform-getting-started

  4. Validate the dependency resolution step.

    Dependency resolution:
  Installation order (3):        nuxeo-dam-6.4.3/nuxeo-web-ui-2.4.0/nuxeo-platform-getting-started-1.3.3
  Packages to download (3):      nuxeo-web-ui:2.4.0, nuxeo-dam:6.4.3, nuxeo-platform-getting-started:1.3.3

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

  5. Check that the Nuxeo addons were correctly installed.

    # Linux and Mac OS
$ ./nuxeoctl mp-list
[...]
Local packages:
 addon     started    nuxeo-dam (id: nuxeo-dam-6.4.3)
 addon     started    nuxeo-web-ui (id: nuxeo-web-ui-2.4.0)
 addon     started    nuxeo-platform-getting-started (id: nuxeo-platform-getting-started-1.3.3)

# Windows
$ .\nuxeoctl.bat mp-list
[...]
Local packages:
 addon     started    nuxeo-dam (id: nuxeo-dam-6.4.3)
 addon     started  nuxeo-web-ui (id: nuxeo-web-ui-2.4.0)
 addon     started    nuxeo-platform-getting-started (id: nuxeo-platform-getting-started-1.3.3)

    The installed addons now have the status 'started'.

  6. Start the server.

    # Linux and Mac OS
$ ./nuxeoctl console

# Windows
$ .\nuxeoctl.bat console

    Your server is now running with the addon Getting started with the Nuxeo Platform.

The addon brings the following document types:

  • The portfolio document type (BCPortfolio) holds the contracts of a customer. Its holds properties about the customer: the company name, industry and size, and the customer's juridical contact information.
  • The contract document type (BCContract) have several properties: an owner (an application user), some dates (signature, start, expiration dates), a type, an amount. It inherits customer information from its portfolio.
  • Some vocabularies are used to populate the portfolio and contract metadata (companySize, contractType and industry)
  • Contracts have a specific lifecycle, so they can evolve though the states draft, approval, running, renegociation and void
  • Some business logic through automation chains and event handlers make contracts inherit properties from its portfolio, and evolve following its lifecycle

Learn more

Setting up Your JavaScript Environment