-
Notifications
You must be signed in to change notification settings - Fork 8
Getting Started
The easiest way to get started is to use the bootstrap script. There is a one liner you can copy from the README to run that.
The requirements for the bootstrap process are as follows:
- A Nuxeo Online Services account - aka credentials for https://connect.nuxeo.com
- A token for Nuxeo Online Services
- Access to the private packages on https://packages.nuxeo.com
- Token Credentials for https://packages.nuxeo.com
- Nuxeo Studio Project ID
If you do not have a Nuxeo Online Services account already, you may create an account via the trial registration process available from here. Hint: this is the account you use to log into https://connect.nuxeo.com/ and/or https://nuxeo-sso.okta.com/
In order for your Nuxeo instance to be able to access your Nuxeo Studio project, you need to provide a Nuxeo Online Services token. You can manage this here. There are instructions here.
In order to access the Nuxeo Docker image, you need access to the private artifacts on https://packages.nuxeo.com. Access must be granted to your Nuxeo Online Services account. If you haven't requested access yet, do so before running the bootstrap script (contact your Nuxeo representative).
Once you have access to the private artifacts, you need to generate token credentials:
- Go to https://packages.nuxeo.com/
- Use the "Sign In" link
- Go to https://packages.nuxeo.com/#user/usertoken
You may create tokens, access existing tokens, or reset the token here. Your "token name code" is your docker username and your "token pass code" is your password.
Your Nuxeo Studio Project ID is part of the URL you use the access the project in Nuxeo Studio. For example:
https://connect.nuxeo.com/nuxeo/site/studio/ide?project=my-cool-project
The Nuxeo Studio Project ID is my-cool-project in this case.
The script will first ask you for various project settings.
Next it will ask you for your credentials to access the private Docker image. Enter the "token name code" and "token pass code" generated previously.
The next prompts will ask for your Studio username and Studio token.
Note: If you are on a Mac, you have the option to save your token in your Keychain.
Once you have entered all the required info, the necessary images will be downloaded and/or built. This includes Nuxeo, OpenSearch, MongoDB, and OpenSearch Dashboards. This may consume a lot of bandwidth and may take a bit of time. Please be patient. At the end of the script, additional instructions will be displayed.
See Also: Advanced Installation
Next: Configure