Skip to content

Latest commit

 

History

History
171 lines (127 loc) · 6.21 KB

GETTING_STARTED.md

File metadata and controls

171 lines (127 loc) · 6.21 KB

Getting started with ElastOS Runtime

Install from the publisher

The public installer looks up signed releases for Linux x86_64/aarch64 and macOS Apple silicon. Intel Mac and other OS families fail closed. See the Mac runbook for source-home staging.

curl -fsSL https://elastos.elacitylabs.com/install.sh | bash

The installer installs Runtime, sets up the Home profile, and opens Home. Keep the terminal open while you use Home. Add $HOME/.local/bin to PATH when you later run elastos from a new shell. The installation guide explains how to inspect the selected signed manifest and installed component registry. A public install receives only the components in that manifest. Source and installed artifacts have separate identities. Install/update acceptance owns publication-parity evidence. The normal Home path does not need a separate elastos serve process.

The current default Home exposes Assistant, Chat (Community), System, People, Wallet, Documents, Library, Marketplace, and Inbox. On Apple Silicon Macs it also exposes Browser; Linux Homes do not show Browser in 2.0.0.

Welcome to Home lists the first steps in order: create your Profile and save the Recovery Kit, join Community in Chat, get a model and ask the Assistant, open a website in Browser (Apple Silicon Macs), then check Updates in System → About.

Home runs while its terminal is open. To open Home again after you close it, run elastos home --browser.

Only one live host may own an ElastOS data home at a time. Do not run elastos and elastos serve against the same home at the same time. The command matrix shows whether a command owns a Runtime, reuses one, or needs none.

Useful next commands:

elastos home --status
elastos update --check

Open Documents or Library from Home to work with your files. The source Home profile includes these apps and their content backend. For an installed release, its signed manifest determines the available components.

In 2.0.0, Library can lose a save when the same file is saved from two places at once, or renamed, moved or deleted while it saves (#480). Edit a file in one window at a time, and let a save or upload finish before you rename, move or delete it.

The same install also provides the operator runtime for serve, remote node control, WASM or microVM run, and non-interactive capsule work. Data run and interactive packaged capsules use the lanes in the command matrix. Installing ElastOS documents setup, trust, and updates. Sites documents the elastos site operator commands.

Build from source

Prerequisites:

  • Rust 1.91 or newer
  • Git
  • just, installed with cargo install just
  • Linux with KVM only when working on crosvm or microVM paths

Build and test:

cargo install just
just build
just test

After the build, check the release binary:

elastos/target/release/elastos --version

A source-built binary is not a self-contained install. The checkout provides source code and components.json, but it does not add a trusted publisher to the user's sources.json. Run source commands from the repository root so the binary can find repository assets.

For local source proof without changing a normal user home:

just local-carrier-setup-smoke
just home-frontdoor-smoke

These commands are developer checks. They do not prove the public installer path. Use Installing ElastOS when testing the signed installer.

Before handing off a change, run just verify. It runs the full repository gate, including lint and workspace tests.

Source-built trusted source example

If you operate a trusted release source, add it explicitly:

ELASTOS_DEV_DATA_HOME="$HOME/.local/share/elastos-dev"

XDG_DATA_HOME="$ELASTOS_DEV_DATA_HOME" \
./elastos/target/release/elastos source add \
  --name local-dev \
  --publisher did:key:PUBLISHER_KEY \
  --connect-ticket CONNECT_TICKET \
  --publisher-node-id PUBLISHER_NODE_ID \
  --install-path "$PWD/elastos/target/release/elastos"

XDG_DATA_HOME="$ELASTOS_DEV_DATA_HOME" \
./elastos/target/release/elastos source show

XDG_DATA_HOME="$ELASTOS_DEV_DATA_HOME" \
./elastos/target/release/elastos setup

XDG_DATA_HOME="$ELASTOS_DEV_DATA_HOME" \
./elastos/target/release/elastos

Replace the uppercase placeholders with values from the source you control. source add follows an existing source; it does not create a publisher from a checkout. The separate data root isolates this run from the installed Home. Do not copy another installation's sources.json into it.

macOS source staging

Mac source staging is an operator workflow, not a public install. Home-only staging requires an isolated source home, the offline principal-root readiness step, and the platform restart script. Browser VM guest artifacts are required only for Browser proof. Follow MAC.md rather than starting the gateway by hand.

Create a capsule

The supported WASM executable is a Component that uses elastos.component/v1 and elastos:bus@v1:

./elastos/target/release/elastos init my-capsule

See Capsule authoring for roles, manifests, templates, build commands, and verification. Product Components do not receive WASI, environment variables, host files, raw sockets, or direct provider authority. This path is currently proved by the conformance fixture and authoring template; shipped first-party UI Apps remain web projections.

Operator paths

elastos serve, remote node control, WASM or microVM run, non-interactive capsule execution, Browser target maintenance, and release handoff are operator work. Data run needs no Runtime, while interactive packaged capsules use the managed Home lane. See the command matrix for these paths:

Read next