Skip to content
Plugwerk

Quickstart

Get Plugwerk running locally in under 5 minutes.

Prerequisites

Section titled “Prerequisites”
  • Docker and Docker Compose
  • A terminal

Setup

Section titled “Setup”

  1. Download the Docker Compose file

    Terminal window
    mkdir plugwerk && cd plugwerk
    curl -O https://www.plugwerk.io/deploy/docker-compose.yml

    This is the same compose file documented under Deployment — Option 1; it pulls the published image from Docker Hub.

  2. Generate the required secrets

    Terminal window
    export PLUGWERK_AUTH_JWT_SECRET="$(openssl rand -base64 32)"
    export PLUGWERK_AUTH_ENCRYPTION_KEY="$(openssl rand -base64 32)"

    Both are required — the compose file fails to start without them.

  3. Start the stack

    Terminal window
    docker compose up -d

  4. Open the Web UI

    Navigate to http://localhost:8080 in your browser.

    Plugwerk surfaces the generated superadmin password on two channels that bypass SLF4J (so log aggregators do not capture the credential) — pick whichever fits your operational setup:

    Terminal window
    # Container stderr (forwarded by `docker compose logs`):
    docker compose logs --no-log-prefix plugwerk-server | grep -A 6 "Initial Superadmin Password"
    

    # 0600 file inside the container:
    docker compose exec plugwerk-server cat /tmp/plugwerk-admin-password.txt

  5. Change the initial password

    On your first login, Plugwerk will automatically prompt you to change the generated password. Choose a new secure password to continue.

  6. Upload your first plugin

    Navigate to the default namespace and upload a PF4J plugin (JAR or ZIP) through the Web UI.

What's Next?

Section titled “What's Next?”