> For the complete documentation index, see [llms.txt](https://docs.kinwall.family/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kinwall.family/getting-started/quick-start-docker.md).

# Quick start (Docker)

The image is `ghcr.io/johnduprey/kinwall`, built for `linux/amd64` and `linux/arm64`, so it runs on a Raspberry Pi, a NAS or any VPS.

```bash
docker run -d --name kinwall -p 8080:8080 -v ./data:/data \
  -e PUBLIC_URL=http://<your-server>:8080 ghcr.io/johnduprey/kinwall
docker logs kinwall   # prints the 6-digit setup code
```

Open `http://<your-server>:8080` and enter the setup code from the log. The [setup wizard](/getting-started/setup-wizard.md) handles the rest.

## What's in `/data`

| File             | What it is                                                                                                                          |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `kinwall.sqlite` | The whole database.                                                                                                                 |
| `encryption.key` | Generated on first boot (mode 0600) if you didn't set `ENCRYPTION_KEY`. It encrypts calendar logins, webhook secrets and push keys. |

**Back up both files.** Without the key, stored calendar credentials can't be recovered, and every account has to be reconnected. See [Backups](/your-data/backups.md).

## The setup code

While the instance is unclaimed, the server generates a new 6-digit setup code on every start and prints it to the log. Setting `ADMIN_API_KEY` gives you a permanent admin key that also works as the setup code. Claim attempts are limited to 10 per hour.

## HTTPS

Google sign-in only accepts HTTPS or `localhost` redirect URIs, and passkeys also need a secure origin. On a LAN you can:

* put Kinwall behind a reverse proxy with a real certificate, or
* use Cloudflare Tunnel or Tailscale instead of port forwarding, or
* finish Google sign-in from `http://localhost:8080` on the server itself.

## Next

* [Docker Compose](/self-hosting-reference/docker-compose.md) for a compose file with a healthcheck.
* [Configuration](/self-hosting-reference/configuration.md) for every environment variable.
* [Updating](/self-hosting-reference/updating.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kinwall.family/getting-started/quick-start-docker.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.