Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs-site/public/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Allow: /

Sitemap: https://beacon-family-docs.netlify.app/sitemap-index.xml
10 changes: 7 additions & 3 deletions docs-site/src/content/docs/features/notifications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ Beacon sends notifications before upcoming calendar events through two channels:

## How notifications work

Every 60 seconds, Beacon scans your calendar events and checks if any event is starting within the next 15 minutes. When it finds one:
Every 60 seconds, Beacon scans your calendar events and checks if any upcoming event is starting within the configured notification window. When it finds one:

1. A **browser notification** is sent (if permission is granted)
2. A **Home Assistant mobile app notification** is sent (if the client is connected)

The default notification timing is **10 minutes** before each event. You can customize this in **Settings > Calendar** to 5, 10, 15, or 30 minutes.

Each event is only notified once — Beacon tracks which event IDs have already triggered notifications to avoid duplicates.

---
Expand All @@ -43,12 +45,14 @@ The first time Beacon loads, it checks the browser's notification permission:

### Notification timing

The timing depends on your **Settings > Calendar** configuration (default: 10 minutes before each event, configurable to 5, 10, 15, or 30 minutes).

| Time Before Event | Body Text |
|-------------------|-----------|
| 2-15 minutes | "Starts in X minutes" |
| 2+ minutes | "Starts in X minutes" |
| 0-1 minute | "Starting now" |

The check runs every 60 seconds, so the actual notification may arrive anywhere within the 15-minute window, typically within 1 minute of the 15-minute mark.
The check runs every 60 seconds, so the actual notification may arrive anywhere within the configured window, typically within 1 minute of reaching the threshold.

### All-day events

Expand Down
2 changes: 1 addition & 1 deletion docs-site/src/content/docs/getting-started/deployment.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Deployment"
description: "Deploying Beacon — HA add-on, Docker standalone, reverse proxy, hardware recommendations, kiosk mode, and performance optimization."
order: 4
order: 5
---

# Deployment
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Getting Started"
description: "Install Beacon as a Home Assistant add-on, Docker container, or development server and connect your family's calendar in under 10 minutes."
order: 2
order: 3
---

# Getting Started
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Beacon vs Skylight"
description: "Free open-source Skylight Calendar alternative. Home Assistant add-on or Docker. Calendar, chores, meals, photos — no subscription, no cloud lock-in."
order: 2
---

# A free Skylight alternative that runs on Home Assistant

Beacon is a self-hosted family command center for wall-mounted tablets. Same kitchen-wall job as Skylight Calendar — shared calendar, chores, meals, lists, photos — without the proprietary screen or the yearly Calendar Plus fee.

## Quick comparison

| | Skylight Calendar | Beacon |
|---|---|---|
| Cost | Hardware ~$300–$650+ | Free (MIT); bring your own tablet |
| Subscription | Calendar Plus ~$79/yr for meals, photos, extras | $0 |
| Privacy | Vendor cloud account | Local / Home Assistant; data stays on your network |
| Smart home | No Home Assistant | Native HA add-on + standalone mode |
| Hardware | Proprietary display | Any wall tablet or spare screen |
| Voice / AI | Vendor features | MCP server, voice API, HA Assist |

## Who should buy Skylight

You want a sealed consumer product, don't run a home server, and prefer support from a hardware vendor.

## Who should install Beacon

You already run (or will run) Home Assistant, want a wall tablet without a subscription, and care about local control. Or you want the same dashboard without HA via standalone mode.

## Replace a Skylight-style setup in about 10 minutes

1. Install Beacon as a Home Assistant add-on (or run standalone).
2. Connect your HA calendar entities (or use the built-in local calendar).
3. Add family members, pick a theme, mount any tablet in the kitchen.

## FAQ

**Is Beacon a Skylight alternative?**
Yes — same wall-display family calendar job, open source and self-hosted.

**Does Beacon require a subscription?**
No. MIT licensed, no cloud account required for core use.

**Do I need Home Assistant?**
Recommended for the richest integration. Standalone mode works with local calendars, lists, and tasks.

**What tablet works?**
Any browser-capable wall tablet or spare screen. Point it at Beacon's URL (or open via HA sidebar / direct add-on URL).

**Is the "Skylight" theme the Skylight product?**
No. It's a visual theme inspired by that clean bright look — not affiliated with Skylight.

---

## Next steps

- **[Installation guide](/docs/getting-started/installation/)** — install as a Home Assistant add-on or Docker container
- **[Full FAQ](/docs/reference/faq/)** — 20+ common questions answered
- **[Hardware recommendations](/docs/getting-started/deployment/)** — tablet and mount options
2 changes: 1 addition & 1 deletion docs-site/src/content/docs/getting-started/walkthrough.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Visual Walkthrough"
description: "A screenshot-guided tour of every Beacon view — dashboard, calendar, lists, tasks, music, weather, and settings — at both desktop and mobile sizes."
order: 3
order: 4
---

# Visual Walkthrough
Expand Down
22 changes: 21 additions & 1 deletion docs-site/src/content/docs/reference/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,14 @@ Beacon is designed for **landscape displays** (16:9 or 16:10). In portrait mode,

### Does it send notifications?

**Yes.** Beacon sends browser push notifications and HA mobile app notifications 15 minutes before calendar events. See [Notifications](/docs/features/notifications/).
**Yes.** Beacon monitors upcoming calendar events and sends notifications ahead of each event through two channels:

1. **Browser push notifications** (requires one-time permission grant)
2. **Home Assistant mobile app notifications** via `notify.notify`

By default, notifications fire 10 minutes before timed events (not all-day events). You can customize the timing in **Settings > Calendar** to 5, 10, 15, or 30 minutes. Beacon checks every minute and sends each notification once per event.

See [Notifications](/docs/features/notifications/) for setup details, permission requirements, and troubleshooting.

### Does it prevent screen burn-in?

Expand Down Expand Up @@ -123,6 +130,19 @@ Add multiple calendar integrations in Home Assistant (Google Calendar, CalDAV, L

Click the gear icon in the sidebar to open the Family Members modal. Click "+ Add Member" and fill in the name, avatar, color, role, and optional PIN. See [Family Members](/docs/features/family/).

### How do I hide the sidebar for wall tablets / kiosk setups?

**Beacon's own sidebar**: Enable **Kiosk Mode** in **Settings > Display**. This hides Beacon's sidebar entirely and uses a full-width layout. (Fixed in [PR #51](https://github.com/asachs01/beacon/pull/51) — earlier versions had a non-functional toggle.)

**Home Assistant's sidebar** (when running as an HA add-on): Beacon cannot hide HA's sidebar when running inside Home Assistant ingress — that chrome is controlled by Home Assistant itself. For dedicated wall tablets or Windows kiosk setups, open Beacon's direct URL in full-screen mode instead:

1. **Find the direct URL**: In HA, click "Open Web UI" on the Beacon add-on page, or use the direct ingress URL (typically `http://YOUR_HA_IP:8123/api/hassio_ingress/<addon-token>`)
2. **For Android tablets**: Use [Fully Kiosk Browser](/docs/getting-started/installation/#mounting-and-displaying-on-a-tablet) with "Hide Navigation Bar" and "Hide Status Bar" enabled
3. **For desktop/Pi kiosk**: Launch Chrome/Chromium with `--kiosk` flag pointed at the Beacon URL
4. **For standalone Docker**: Use the container's direct URL (e.g., `http://YOUR_DOCKER_HOST:3000`)

See the [Installation guide](/docs/getting-started/installation/#mounting-and-displaying-on-a-tablet) for detailed kiosk setup instructions.

---

## Updates and Maintenance
Expand Down
8 changes: 4 additions & 4 deletions docs-site/src/pages/index.astro
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ const features = [
];

const docLinks = [
{ title: 'Getting Started', description: 'Install Beacon and connect your calendar in under 10 minutes.', href: '/docs/getting-started/' },
{ title: 'Calendar', description: 'Week view, creating events, recurring events, drag-to-reschedule.', href: '/docs/calendar/' },
{ title: 'Configuration', description: 'Complete reference for all configuration options.', href: '/docs/configuration/' },
{ title: 'FAQ', description: 'Answers to 20+ common questions.', href: '/docs/faq/' },
{ title: 'Getting Started', description: 'Install Beacon and connect your calendar in under 10 minutes.', href: '/docs/getting-started/installation/' },
{ title: 'Calendar', description: 'Week view, creating events, recurring events, drag-to-reschedule.', href: '/docs/features/calendar/' },
{ title: 'Configuration', description: 'Complete reference for all configuration options.', href: '/docs/customization/configuration/' },
{ title: 'FAQ', description: 'Answers to 20+ common questions.', href: '/docs/reference/faq/' },
];
---

Expand Down
Loading