Skip to content

Quick Start

Get EUDIPLO running in under 2 minutes! This guide gets you from zero to issuing your first credential.

New to EUDIPLO?

This is the fastest path to see EUDIPLO working. For production setup and advanced configuration, see the Architecture and API sections.

What You'll Need

  • CLI access via one of these options:
    • Option A (recommended on Linux/macOS): standalone CLI via installer
    • Option B: npm package @eudiplo/cli with Node.js 22+
    • Windows: npx @eudiplo/cli demo (Node.js 22+) or Windows x64 release archive
  • Docker installed
  • 2 minutes of your time ⏱️
curl -fsSL https://eudiplo.dev/install.sh | bash
eudiplo demo

Already using Node.js 22+?

npx @eudiplo/cli demo

Windows

Use Node.js 22+:

npx @eudiplo/cli demo

or download the Windows x64 standalone release archive and run:

eudiplo demo

Both options run the same EUDIPLO CLI. The standalone CLI removes the Node.js requirement, but Docker and Docker Compose are still required for eudiplo demo.

This generates editable demo files in your current directory:

  • .eudiplo.demo.env
  • .eudiplo/demo-config

It then starts backend and client containers using compatible image tags.

Demo mode only

Demo mode uses predictable onboarding credentials and loopback-bound ports.
It is not suitable for production.

Step 2: Verify It's Working

After starting the demo, check that EUDIPLO is healthy by querying its health endpoint:

curl http://localhost:3000/health

Expected response from EUDIPLO:

{
    "status": "ok",
    "info": {
        "database": { "status": "up" }
    },
    "errors": {}
}

The CLI is the primary workflow for local onboarding and lifecycle commands. Use the same mode you chose in Step 1:

# Stop demo stack
eudiplo down

# npm alternative
npx @eudiplo/cli down

# Reset demo data and regenerate demo config
eudiplo demo --reset --force

# npm alternative
npx @eudiplo/cli demo --reset --force

You can still use the Web Client or Swagger API at any time:

Open the Web Interface:

The web client provides a user-friendly interface for:

  • 📋 Managing credential templates
  • 🎫 Issuing credentials to wallets
  • ✅ Verifying credential presentations
  • 📊 Viewing system status

Perfect for first-time users

The web client is the easiest way to understand EUDIPLO's capabilities without needing API knowledge.

Open the API Documentation: http://localhost:3000/api/docs

The Swagger UI provides direct API access for:

  • 🔌 Integration testing
  • 📖 API documentation exploration
  • ⚡ Advanced automation workflows
  • 🧪 Direct endpoint testing

Step 4: Optional UI and API Exploration

After starting with the CLI, choose an interface for interactive exploration:

  1. Open: http://localhost:4200
  2. Log in with the default credentials:
    • EUDIPLO Instance: http://localhost:3000
    • Client ID: root
    • Client Secret: root
  3. Explore the dashboard to see:
    • Available credential templates
    • Quick action buttons for common tasks

Learn More

For detailed web client features and workflows, see the Web Client Guide.

Authenticate via Swagger UI

  1. Open the API Documentation: http://localhost:3000/api/docs
  2. Click the "Authorize" button (🔓 lock icon) in the top-right
  3. Enter your credentials:
    • Client ID: root
    • Client Secret: root
  4. Click "Authorize" and then "Close"

You're now authenticated! The 🔓 icon should change to 🔒 (locked).

Test Your First API Call

  1. Find the "App" section in Swagger UI
  2. Expand / → GET
  3. Click "Try it out" → "Execute"

You should see a successful response with available credential templates!

Success

EUDIPLO is now running and ready for credential issuance and verification.

What's Next?

New to EUDIPLO? Start here!

Follow the First Steps Guide for a complete walkthrough:

  1. Create your first tenant
  2. Set up credential configurations
  3. Issue your first credential
  4. Troubleshoot common issues
  • 📚 First Steps Guide - Complete setup walkthrough (recommended)
  • 🎫 Issue Your First Credential - Use the web interface to create and send credentials to wallets
  • 🔍 Verify Credentials - Set up verification flows through the web UI
  • 📋 Manage Templates - Create custom credential templates for your use case

Common Next Steps

Clean Up

When you're done experimenting:

Use the same CLI mode from Step 1:

eudiplo down

# npm alternative
npx @eudiplo/cli down

To reset managed demo data and regenerate demo config:

npx @eudiplo/cli demo --reset --force
# or
eudiplo demo --reset --force