Skip to Content

Installation

Use this page when you need to run Rune yourself. If someone has already given you access to a Rune workspace, you can skip to the Quick Start.

The installation path below follows the project README.

Run Rune with Docker

The fastest way to get Rune running locally is with Docker:

git clone https://github.com/rune-org/rune.git cd rune cp .env.example .env make up

When the containers are running, open:

http://localhost:3000

What starts

make up starts the full Rune stack:

ServicePortWhat it does
Frontend3000Web app and workflow canvas
API8000REST API for auth, workflows, credentials, templates, and orchestration
RTES8080Real-time execution streaming
WorkerN/ABackground workflow execution engine
ArchivistN/ACompletion recorder and data maintainer
SchedulerN/AScheduled workflow trigger service
PostgreSQL5432Primary database
MongoDB27017Execution history
Redis6379State and caching
RabbitMQ5672 / 15672Message broker
OpenObserve5080Observability platform
OpenTelemetry4317 / 4318Telemetry collector

Stop Rune

From the repository root, run:

make down

After installation

Once the web app opens, the product flow looks like this:

Next steps:

  1. Run the Quick Start.
  2. Read How Rune Works when a term feels unfamiliar.
  3. Use Node Families to choose the right kind of step.
  4. Add Credentials when your workflow needs private services.