Getting Started with Nx Private Cloud

The Community edition of Nx Private Cloud is a docker image that can be deployed to your cloud. Community edition keeps all data on your cloud, except for billing and utilization data that's sent to the Nx Cloud API to enable an integrated billing experience.

For companies who need complete control of data, with no external API calls, the Enterprise edition of Nx Private Cloud is for you.

Running Nx Private Cloud

Step 1: Pull the Image

> docker pull nxprivatecloud/nxcloud

To update the version of Nx Private Cloud, pull the new version of the image and run it against the same mount (see below).

Step 2: Create a Container

Depending on how your infrastructure is set up, you can either run Nx Private Cloud using HTTPS or HTTP. If you have a proxy in front of Nx Cloud, you will likely want to run Nx Private Cloud using HTTP (the proxy will handle SSL). Otherwise, you will likely want to run Nx Private Cloud using HTTPS.

To create a container:

  1. You will need to create a directory on the host machine where data will be stored. (This is not necessary if you are running mongo yourself. See below.)

  2. You will need to know the URL that the private cloud can be accessed by (see NX_CLOUD_APP_URL below).

    • NX_CLOUD_APP_URL should be accessible from your CI and dev machines.

    • NX_CLOUD_APP_URL can be set with an HTTP or HTTPS url. In a case where you are using a proxy, you can still put HTTPS (the url will be resolved by the proxy before hitting the app).

  3. If you are running Nx Private Cloud using HTTPS, you need to generate or obtain an SSL certificate and an SSL private key.

Once you obtain all the needed information, you can run the following:

Using HTTPS

> docker create --name cloud \ -p 443:8081 \ -e CERT_KEY="$(cat ./tools/certs/key.pem)" \ -e CERT="$(cat ./tools/certs/cert.pem)" \ -e NX_CLOUD_APP_URL="https://cloud.myorg.com" \ -e ADMIN_PASSWORD=admin \ -v /data/private-cloud:/data nxprivatecloud/nxcloud:latest

Using HTTP (no proxy)

> docker create --name cloud \ -p 80:8081 \ -e NX_CLOUD_APP_URL="http://cloud.myorg.com" \ -e ADMIN_PASSWORD=admin \ -v /data/private-cloud:/data nxprivatecloud/nxcloud:latest

Using HTTPS via proxy

> docker create --name cloud \ -p 80:8081 \ -e NX_CLOUD_APP_URL="https://cloud.myorg.com" \ -e ADMIN_PASSWORD=admin \ -v /data/private-cloud:/data nxprivatecloud/nxcloud:latest

Let's see what those options mean:

  • 443:8081 maps the internal port 8081 to 443, so it can be accessed in the browser without specifying the port. 80:8081 works the same way when you use HTTP instead of HTTPS.

  • CERT_KEY and CERT contain the values of private key and cert. The file extensions of the cert and key files can be different, but as long as they are in the PEM format (which is the case if you use, for instance, OpenSSL), the command will work.

  • NX_CLOUD_APP_URL is the URL the cloud can be accessed by (e.g., https://nxcloud.privateurl.com). Important: Unless you are experimenting, it won't be localhost. It has to be the URL that your CI and your developer machine can reach. Also note, there is no trailing slash in the URL.

  • ADMIN_PASSWORD contains the password of the admin user. The admin user is created the first time you run cloud, you can remove this env variable after that. Instead of an admin password, you can also follow the instructions here to set-up GitHub auth.

  • -v /data/private-cloud:/data sets up the volume where the data is stored. /data/private-cloud refers to a folder on your machine, /data is the shareable folder from the Docker image.

Step 3: Run the Container

Once you create the container, you can start it using:

> docker start cloud

Imagine NX_CLOUD_APP_URL is set to https://nxcloud.privateurl.com.

Now, go to https://nxcloud.privateurl.com to see cloud running. You can log into the account using admin/ADMIN_PASSWORD.

Step 4: Connect Your Workspace

Run NX_CLOUD_API=https://nxcloud.privateurl.com nx g @nrwl/nx-cloud:init. Click on the link to connect the workspace to your admin account.

Step 5: Configure Billing

Go to https://nxcloud.privateurl.com, select the workspace, click on Billing. You will see a link redirecting you to https://nx.app, where you can register your credit card. 

Note, it usually takes a few minutes for the billing information to sync up.

As stated above, Nx Private Cloud community will store all your artifacts and the information about runs on premises, but will report utilization to https://api.nrwl.io.

Optional step 6: Set-up GitHub auth

Follow the instructions here to set-up GitHub OAuth authentication so you can invite other members in your team to the workspace.

Optional step 7: Set-up GitHub Pull Request integration

You can optionally configure private cloud to post build stats directly on your GitHub pull requests.

Setting Up Proxy

If your container cannot access api.nrwl.io directly and has to talk via a proxy, you can add -e HTTPS_PROXY="https://myproxy.myorg.com" to the container creation command.

Select an article to learn more about Nx Cloud