55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
|
# Getting Started with The Nest
|
||
|
|
|
||
|
|
Welcome! This guide will walk you through your first steps on **The Nest**, a shared home lab running on three Raspberry Pi 5s in a high-availability Kubernetes cluster.
|
||
|
|
|
||
|
|
## Your Default Account
|
||
|
|
|
||
|
|
When you join The Nest, you are granted access to the following services by default:
|
||
|
|
|
||
|
|
- **Matrix** — Chat and voice/video calls
|
||
|
|
- **Vaultwarden** — Password manager (Bitwarden-compatible)
|
||
|
|
- **Forgejo** — Git hosting for code collaboration
|
||
|
|
- **This Documentation Site** — You're reading it right now
|
||
|
|
|
||
|
|
All other services require an admin to grant you access. See [Requesting Service Access](access-requests.md) for details.
|
||
|
|
|
||
|
|
## Signing In with a Passkey
|
||
|
|
|
||
|
|
The Nest uses **passwordless authentication** powered by [Keycloak](https://keycloak.org/) and WebAuthn passkeys. This means:
|
||
|
|
|
||
|
|
1. You will never log in with a password (after initial setup).
|
||
|
|
2. You need a **passkey-capable device** — a smartphone, tablet, or computer with a fingerprint reader, face scanner, or security key (e.g., YubiKey).
|
||
|
|
3. Your **email address is required** for account recovery and initial verification. It is stored securely and not shared with third parties.
|
||
|
|
|
||
|
|
### First-Time Setup
|
||
|
|
|
||
|
|
1. Visit [sso.mynest.love](https://sso.mynest.love) and click **Sign In**.
|
||
|
|
2. Enter the email address you were provided.
|
||
|
|
3. Follow the prompts to create your first passkey on your device.
|
||
|
|
4. Choose a username (this is your Matrix display name and Forgejo handle).
|
||
|
|
|
||
|
|
> [!TIP]
|
||
|
|
> If you lose access to all your enrolled passkeys, contact an admin via Matrix (`@nest:starling.mynest.love`) for account recovery. You will need to verify your identity using your registered email.
|
||
|
|
|
||
|
|
## Setting Up Vaultwarden (Recommended First Step)
|
||
|
|
|
||
|
|
Before exploring other services, set up [Vaultwarden](vaultwarden.md). It stores your passkeys securely and syncs across devices — making future logins seamless.
|
||
|
|
|
||
|
|
1. Open <https://vault.mynest.love>
|
||
|
|
2. Click **Master Password** → **I forgot my master password** (first-time flow)
|
||
|
|
3. Follow the setup wizard to create your vault and enroll a passkey for The Nest SSO.
|
||
|
|
|
||
|
|
## Exploring Services
|
||
|
|
|
||
|
|
Once your account is set up, browse the user-facing guides above to learn about each service. Most will use **"Sign in with The Nest"** as their authentication method — no separate credentials needed.
|
||
|
|
|
||
|
|
## What If Something Goes Wrong?
|
||
|
|
|
||
|
|
- **Can't sign in?** Try a different passkey-capable device or contact an admin via Matrix.
|
||
|
|
- **Service won't load?** Some services auto-update daily around 03:00 EST. Wait a few minutes and try again.
|
||
|
|
- **Need help with a specific service?** Ask in the Matrix admin room or open a request via `@access-bot`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
*Ready to dive in? Pick a service from the sidebar and start exploring.*
|