> 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/what-is-kinwall.md).

# What is Kinwall

Kinwall is a family calendar, chore chart and list app you host yourself. The main screen is a touch-first calendar meant to hang on the wall (usually an iPad in Guided Access). Everyone else uses the same app on their phone.

![Month view on the wall iPad](https://4251322152-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kP7ksVUPkKNBdqDQdkp%2Fuploads%2Fgit-blob-9dafffeb836476421871177cb81f31cc32b48163%2Fipad-month.png?alt=media)

## What it does

| Area          | In short                                                                                                                                                                | Read more                                               |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| Calendar      | Week, Day, Month and Schedule views. On phones the week becomes a 3-day view. Colour-coded by family member or category.                                                | [Calendar](/using-kinwall/calendar.md)                  |
| Events        | Create and edit events. Changes go back to Google, Outlook and CalDAV. You can add reminders, a travel time with a leave-by time, members, a category and linked tasks. | [Events](/using-kinwall/events.md)                      |
| Calendars     | Google, Microsoft 365 / Outlook, iCloud and other CalDAV servers, and any ICS URL.                                                                                      | [Connecting calendars](/connecting-calendars/google.md) |
| Chores        | One-off or recurring chores with points, streaks and a leaderboard.                                                                                                     | [Chores](/using-kinwall/chores.md)                      |
| Lists         | Shopping, to-do and reusable lists. Items remember their store and category.                                                                                            | [Lists](/using-kinwall/lists.md)                        |
| Notifications | Web Push reminders, a daily summary, chore nudges and list updates, set per device.                                                                                     | [Notifications](/using-kinwall/notifications.md)        |
| Automation    | REST API with OpenAPI docs, signed webhooks, an MCP server for AI assistants, and a Home Assistant integration.                                                         | [Integrations](/integrations/rest-api.md)               |

## How it runs

The same code runs in three places:

* **Cloudflare Workers**: fits the free tier, uses D1 as the database and comes with HTTPS. See [Deploy to Cloudflare Workers](/getting-started/deploy-cloudflare.md).
* **Docker** (amd64/arm64): a single container storing SQLite in `/data`. See [Quick start (Docker)](/getting-started/quick-start-docker.md).
* **Home Assistant add-on**: see [Home Assistant add-on](/getting-started/home-assistant-add-on.md).

A hosted version of Kinwall is coming soon. Until then, you run your own copy.

## Who can do what

Kinwall has no user accounts. Access comes from keys:

* **Admin**: a phone or computer signed in with a passkey (or an admin API key). It can do everything.
* **Display**: a paired wall screen. It can use the calendar, chores, lists and everyday settings, but can't manage members, calendar accounts, keys or webhooks.

For details, see [Sign-in & security](/using-kinwall/sign-in-and-security.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/what-is-kinwall.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.