Skip to content

60-second quickstart

This takes about a minute. You’ll run Bunker on your own computer, create your account, publish a page and open it. No Microsoft, Google or SSO needed.

Terminal window
# Linux / macOS. Without sudo it just puts the binary in ~/.local/bin.
curl -fsSL https://raw.githubusercontent.com/kucukkanat/bunker/master/install.sh | sh
bunker serve

Or with Docker:

Terminal window
docker run -p 8080:8080 -v bunker:/data ghcr.io/kucukkanat/bunker

Bunker prints a box with a setup URL and a one-time code.

Open http://localhost:8080/setup. Choose Just me or my team and enter your email, name and a password (10 characters or more). You’re now the admin.

The same step as one API call:

Terminal window
curl -X POST http://localhost:8080/api/v1/setup -H 'Content-Type: application/json' \
-d '{"provider":"local","email":"you@example.com","name":"You","password":"a-long-passphrase"}'
  • When you open the setup page on the same machine (localhost), you don’t need the code.
  • With Docker, requests arrive through Docker’s network, so type the code from the logs (docker logs <container>). It’s also in setup-code.txt in the data folder.

Save this as index.html, or use any HTML file you already have (one from ChatGPT or Claude is fine):

<!doctype html>
<title>Team lunch vote</title>
<h1>Where should we eat on Friday?</h1>
<p>Built in a minute with Bunker.</p>

In the browser: drop the file on the Bunker home page. You get a link right away.

From a terminal (works today): every Bunker action is also an API call. Send a personal access token (Settings → Tokens), or, in bunker dev, just the X-Bunker: 1 header:

Terminal window
curl -X POST http://localhost:8080/api/v1/drop \
-H "Authorization: Bearer $TOKEN" \
-F 'files=@index.html' -F 'title=Lunch vote'

The reply contains the new app’s address:

{ "version": 1, "files": 1, "slug": "lunch-vote",
"url": "http://localhost:8080/s/lunch-vote/" }

Open it. Your page runs inside Bunker’s sandbox, with a small Bunker badge in the corner.

New apps are private. Invite a friend or coworker first (Admin → People, or POST /api/v1/admin/invites). They get a one-time link to set their password. Then share the app with them:

Terminal window
curl -X POST http://localhost:8080/api/v1/sites/lunch-vote/members \
-H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
-d '{"type":"user","id":"sam@example.com","role":"viewer"}'

Anyone signed in who isn’t on the list sees You need access with an Ask for access button. You get a notification and can let them in with one click.