EnclaveStack
GitHubGet started

Getting started

Build EnclaveStack, start it, and create your first database and app.

Pick how to start

  • Just want to look around? Use the demo: one command, sample data, no Docker.
  • Want real databases and apps on this computer? Keep reading: this guide builds EnclaveStack and runs it for real.

What you need

  • A Mac or a Linux computer.
  • Docker, running.
  • Go 1.26 or later, Node 22.12 or later and pnpm 9, to build it.

EnclaveStack is built from source until an installer is published. It takes a few minutes the first time. VMs also need QEMU 8 or later (brew install qemu on a Mac; qemu-system and qemu-utils on Linux): skip it until you want one.

Set it up

  1. Get the code and build it

    This builds one program, build/enclave, with the console inside.

    Terminal
    git clone https://github.com/EnclaveStack/platform.git enclavestack && cd enclavestack
pnpm install && make build

  2. Start the server

    It prints the console’s address and a one-time setup code. Leave it running.

    Terminal
    ./build/enclave server

  3. Create your admin account

    Open http://127.0.0.1:7070, enter the setup code, and choose your email and password. You land on the Overview.

  4. Sign in from a second terminal

    This saves a token, so the commands that follow work without a password.

    Terminal
    ./build/enclave login

  5. Try it: make a database and an app

    These two commands are examples of what you can create. --wait makes each one wait until the resource is ready.

    Terminal
    ./build/enclave db create orders --wait
./build/enclave app create web --image nginx:1.27-alpine --port 80 --publish --wait

  6. See it

    The app’s page in the console shows its address on this computer; ./build/enclave ls lists everything.

    Terminal
    ./build/enclave ls

Next steps

Something unclear or out of date? Tell us in the community, or improve these docs on GitHub.