Skip to main content

Installing Moderne DX

Moderne DX runs from a single jar. These steps start it on your own machine at https://moderne.localhost:8443. Serving it to your organization afterwards takes a name and usually a certificate.

Prerequisites​

Downloading Moderne DX​

curl -fLO -u <cgp-user>:<cgp-token> https://artifacts.codegenomeproject.org/moderne-dx.jar
java -jar moderne-dx.jar init    # macOS: say yes when it offers to trust DX's certificate authority

The URL always serves the newest release. On Linux, run java -jar moderne-dx.jar trust and follow what it prints.

Configuring Moderne DX​

Set these in the moderne.yml file that init wrote:

moderne.yml
moderne:
  license:
    key: ${MODERNE_LICENSE_KEY}
  recipe:
    marketplace:
      repositories:
        code-genome-project:
          username: <cgp-user>
          token: ${CGP_TOKEN}
        # maven:                  # or your own repository that proxies CGP
        #   - uri: https://artifactory.acme.com/artifactory/moderne-recipes
        #     username: moderne
        #     password: ${ARTIFACTORY_PASSWORD}
  organization:
    sources:
      http:
        - uri: https://moderne-lsts.s3.us-west-2.amazonaws.com/repos-lock.csv
          organizations: [Netflix]  # public repositories to start with
        # - uri: https://artifactory.acme.com/artifactory/moderne-ingest/repos-lock.csv
        #   username: moderne
        #   password: ${ARTIFACTORY_PASSWORD}
        #   organizations: [Payments]

Where the Moderne CLI on this machine holds the license key and the CGP username and token, init writes moderne.yml to read them from it. Such a value looks like ${moderne-cli:license.key}. DX asks the CLI for the value each time it starts. Add any secret the CLI lacks to the moderne.env file beside moderne.yml:

moderne.env
MODERNE_LICENSE_KEY=…
CGP_TOKEN=…

DX starts on Netflix's public repositories, from Moderne's mass ingest of open source. To index your own repositories, add the repos-lock.csv file your mass ingest publishes. The moderne.yml reference lists every other setting.

Starting Moderne DX​

java -jar moderne-dx.jar doctor
java -jar moderne-dx.jar start

Once DX is up, start prints the password of the moderne user. Open https://moderne.localhost:8443, sign in as moderne and choose a new password. Install recipes from the marketplace.

Connecting the CLI​

mod config moderne edit https://moderne.localhost:8443
mod login

On macOS, the CLI trusts DX's certificate authority once init or trust has added it to your keychain. Elsewhere, mod config http trust-store gives the CLI DX's certificate authority.

Next steps​