Homestead docs
# Homestead docs
Homestead is a private, self-hosted app for one household. You paste links to the people you
care about, from Instagram, Facebook, LINE, WeChat, Bluesky, X, Douyin, Xiaohongshu and Truth
Social, and Homestead shows one calm feed of their stories and posts. The feed ends when you
are caught up. When a platform keeps its posts private, Homestead suggests you go and say
hello there instead.
Homestead runs as one Go program in one Docker container, with SQLite and a media folder in
one volume. It has a web app, a Flutter phone app, a REST API, an MCP server for AI agents and
a Firefox companion. It is MIT licensed and sends nothing home: no telemetry, no analytics, no
remote fonts.
<Aside type="caution" title="Homestead isn't released yet">
There are no releases, no published Docker image and no app store or add-on listings. You can
build it from source today. The server and most of the web app work on `main`; the phone
screens, some web screens and the browser companion's server side are still being built.
Pages mark those parts with a status chip, such as "Coming in 1.0". Live progress is in
[`work/tasks.yaml`](https://github.com/aprajnaparamita/homestead/blob/main/work/tasks.yaml).
</Aside>
## Who it's for
- **The family hub.** You run a small home server and set things up once for parents and
siblings.
- **The relative who just wants to look.** Tap a face, watch stories, read in large text.
Nothing to configure.
- **The curator.** You follow creators on Douyin and Xiaohongshu and paste their share text
as it comes.
- **The self-hoster with an AI agent.** Hermes, OpenClaw or another MCP client adds people
from chat and fetches stories with your own logged-in browser.
## Where to start
<CardGrid>
<LinkCard
title="Overview"
description="What Homestead does, what it can't see, and how the pieces fit."
href="/docs/getting-started/overview/"
/>
<LinkCard
title="Quick start"
description="Build the image from source and open the setup screen."
href="/docs/getting-started/quick-start/"
/>
<LinkCard
title="Concepts"
description="Households, people, platforms, the feed, circles, agents and the companion."
href="/docs/concepts/household-and-roles/"
/>
<LinkCard
title="Guides"
description="Docker Compose, remote access, agents, X, backups, sharing and more."
href="/docs/guides/docker-compose/"
/>
<LinkCard
title="Help"
description="FAQ, troubleshooting, privacy and responsible use, security."
href="/docs/help/faq/"
/>
<LinkCard
title="API"
description="REST under /api/v1, the OpenAPI file, MCP and curl examples."
href="/docs/api/"
/>
</CardGrid>
## Getting help
Questions and bug reports go to the
[issue tracker](https://github.com/aprajnaparamita/homestead/issues). Security problems go
through private reporting instead; see [Security](/docs/help/security/).
Homestead is a private, self-hosted app for one household. You paste links to the people you care about, from Instagram, Facebook, LINE, WeChat, Bluesky, X, Douyin, Xiaohongshu and Truth Social, and Homestead shows one calm feed of their stories and posts. The feed ends when you are caught up. When a platform keeps its posts private, Homestead suggests you go and say hello there instead.
Homestead runs as one Go program in one Docker container, with SQLite and a media folder in one volume. It has a web app, a Flutter phone app, a REST API, an MCP server for AI agents and a Firefox companion. It is MIT licensed and sends nothing home: no telemetry, no analytics, no remote fonts.
Who it’s for
Section titled “Who it’s for”- The family hub. You run a small home server and set things up once for parents and siblings.
- The relative who just wants to look. Tap a face, watch stories, read in large text. Nothing to configure.
- The curator. You follow creators on Douyin and Xiaohongshu and paste their share text as it comes.
- The self-hoster with an AI agent. Hermes, OpenClaw or another MCP client adds people from chat and fetches stories with your own logged-in browser.
Where to start
Section titled “Where to start”OverviewWhat Homestead does, what it can't see, and how the pieces fit.
Quick startBuild the image from source and open the setup screen.
ConceptsHouseholds, people, platforms, the feed, circles, agents and the companion.
GuidesDocker Compose, remote access, agents, X, backups, sharing and more.
HelpFAQ, troubleshooting, privacy and responsible use, security.
APIREST under /api/v1, the OpenAPI file, MCP and curl examples.
Getting help
Section titled “Getting help”Questions and bug reports go to the issue tracker. Security problems go through private reporting instead; see Security.