@dxos/cli-app

App CLI

Operations

To deploy apps we need a number of steps:

• build: This generates the ditribution files along with configuration specific for the given app.yml
• publish: Upload the dist folder to IPFS. Update the hash in the app.yml
• register: Use app.yml to generate a record in WNS.

All this operations can be resumed with one command:

dx app deploy --domain "test" --name "app/example"

Build app.

Before you publish your app you need to build it using dx app build.

Your app.yml MUST be present and it must have name and version defined.

You can specify the following params in your app.yml:

• build: Build command. Defaults to yarn webpack -p.

Example:

name: 'Example App'
version: 0.0.0
build: yarn dist

Then run:

dx app build

Publish to IPFS

dx app publish

Registration

In package root folder:

• make sure app.yml is presented, with name and version fields. E.g.:

name: 'Example App'
version: 1.0.0
build: yarn dist
package:
  /: <IPFS HASH ID GENERATED BY PUBLISH>

• register app:

dx app register --domain "test" --name "app/example"

Query

dx app query

[
  {
    "id": "bafyreicjftv7di4x4og7gbxnrtqsqchiqcdchxnemnfiuqet35h2jzfww4",
    "names": [
      "dxn://dxos/application/example"
    ],
    "owners": [
      "6ee3328f65c8566cd5451e49e97a767d10a8adf7"
    ],
    "bondId": "d466a4a9a640040f3d9582a5dc8797b43409c3bfde338b4b74ead9ffa225b494",
    "createTime": "2020-08-25T18:47:03.082647202",
    "expiryTime": "2021-08-25T18:47:03.082647202",
    "attributes": {
      "package": {
        "/": "QmbPxkLXcHxWcUquhSEVCP5mUNQBLezjETGLzaDWmLscba"
      },
      "type": "dxn:app",
      "version": "0.0.1",
      "build": "yarn dist",
      "name": "Example App"
    }
  },
]

Serve Apps

Once apps are published to IPFS, a WNS record and name have been registered, we can use dx app serve to serve the distributed files.

dx app serve

• port: Which port to start the server. Defaults to 5999

The application will hosted at:

• GET: /app/${DXN}/

Since DXN's can contain characters which are reserved in URI's, it is often necessary to URI-escape the DXN portion of the URI.

For example, with the DXN dxn://dxos/application/example the URL is:

• GET: /app/dxn%3A%2F%2Fdxos%2Fapplication%2Fexample/

Because URI-encoded URL's are difficult to enter manually, there is an optimization for short WRN's of the form dxn://<org>/<appname> that does not require any URI-encoding of the name. For example, with the short WRN wrn://dxos/example, this plain URL can be used:

• GET: /app/dxos/example/

Apps config endpoints:

If using dxos/config dynamic configuration each app can request config from a config endpoint (/config/config.json). This endpoint will serve a JSON-formatted representation of the YAML file located at ~/.dx/remote.yml. The location of the YAML can be modified in the global configuration file:

cli:
  app:
    serve:
      config: '/opts/apps-config/default.yml'

The following URLs will be available:

• GET /config/config.json

You can setup whitelist of public keys of profile identities in the Wallet Extension that can authenticated through endpoint /wallet/auth. In order to do so create a file in your DXOS profile folder named keyhole-whitelist.yml. The file has to have the following structure:

  whitelistedPublicKeys:
    - <PUBLIC_KEY_1>
    - <PUBLIC_KEY_2>
    - ...

As for now verifying identity thorugh public key is not set up, public keys serve as a simple password stored in filesystem of the server.

Changelog

2.20.4 (2022-07-12)

Bug Fixes

• update ipfs start command. (5aaa0df)