Slow trudge through cleanup

This commit is contained in:
Astra Logical 2026-07-25 15:49:57 -04:00
parent b03b239578
commit 2c377dc11b
3 changed files with 39 additions and 16 deletions

View file

@ -1,8 +1,8 @@
# The Nest — Documentation # The Nest — Documentation
Welcome to the documentation for **The Nest**: one bird's homelab, shared from me to you! This documentation is split into two audiences: Welcome to the documentation for **The Nest**: one bird girl's homelab, shared from me to you! This documentation is split into two audiences:
## For Users (Accessible via `mynest.love`) ## For Users
These guides explain what each service does, how to reach it, and how to get started. No technical background required. These guides explain what each service does, how to reach it, and how to get started. No technical background required.
@ -16,7 +16,6 @@ These guides explain what each service does, how to reach it, and how to get sta
- **Media Request** - **Media Request**
- [Seerr](user-facing/media-request/seerr.md) — Request movies, TV shows, and anime for Jellyfin - [Seerr](user-facing/media-request/seerr.md) — Request movies, TV shows, and anime for Jellyfin
- [Shelfmark](user-facing/media-request/shelfmark.md) — Request ebooks and audiobooks for Calibre and Audiobookshelf - [Shelfmark](user-facing/media-request/shelfmark.md) — Request ebooks and audiobooks for Calibre and Audiobookshelf
- [DroppedNeedle](user-facing/media-and-entertainment/droppedneedle.md) — Discover and request music
- **Productivity & Creation** - **Productivity & Creation**
- [Forgejo](user-facing/productivity-and-creation/forgejo.md) — Git hosting and code collaboration - [Forgejo](user-facing/productivity-and-creation/forgejo.md) — Git hosting and code collaboration
- [Foundry VTT](user-facing/productivity-and-creation/foundry-vtt.md) — Virtual tabletop for TTRPGs - [Foundry VTT](user-facing/productivity-and-creation/foundry-vtt.md) — Virtual tabletop for TTRPGs
@ -66,7 +65,6 @@ These documents cover architecture, networking, security, backups, and internal
| Forgejo | <https://weaver.mynest.love> | User | | Forgejo | <https://weaver.mynest.love> | User |
| Matrix (Synapse) | <https://starling.mynest.love> | User | | Matrix (Synapse) | <https://starling.mynest.love> | User |
| Matrix RTC | <https://matrix-rtc.mynest.love> | User | | Matrix RTC | <https://matrix-rtc.mynest.love> | User |
| Keycloak (SSO) | <https://sso.mynest.love> | User |
| Foundry VTT | <https://foundry.mynest.love> | User | | Foundry VTT | <https://foundry.mynest.love> | User |
--- ---

View file

@ -1,6 +1,6 @@
# Requesting Service Access # Requesting Service Access
By default, new users are granted access to **Matrix**, **Vaultwarden**, **Forgejo**, and this documentation site. All other services require an admin to approve your request via Keycloak group membership. By default, new users are granted access to **Matrix**, **Vaultwarden**, **Forgejo**, **Foundry VTT**, and this documentation site. All other services require an admin to approve your request via Keycloak group membership.
## How to Request Access ## How to Request Access
@ -8,9 +8,20 @@ Access is managed through a Matrix bot. Follow these steps:
### 1. Open a Chat with the Bot ### 1. Open a Chat with the Bot
Send a direct message to `@access-bot:starling.mynest.love` on Matrix. If you don't see it, search for **Nest Access Bot** in your contacts. Send a direct message to `@access-bot:starling.mynest.love` on Matrix.
### 2. List Available Groups ### 2. List Available Groups
Send the command: Send the command:
`!groups`
### 3. Request Access to a Group
Send the command:
`!request <group name>`
An admin will be informed of your request and will approve/deny accordingly.
---
*Access to any service can be revoked by and admin at any time. Please use The Nest responsibly.*

View file

@ -1,28 +1,30 @@
# Getting Started with The Nest # 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. Welcome! This guide will walk you through your first steps on **The Nest**!
## Your Default Account ## Requesting Access to the Nest
When you join The Nest, you are granted access to the following services by default: Are you a new user looking to join The Nest? You're in the right place! Take a trip to https://fledgling.mynest.love to request initial access. In order to join The Nest you'll need:
- **Matrix** — Chat and voice/video calls - A username you're happy with. You can't change this later without a lot of hassle!
- **Vaultwarden** — Password manager (Bitwarden-compatible) - A working email. I don't care if this is an alias, but it will need to work for initial account setup, account recovery, and service notifications (if you enroll in them)
- **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. Once you've requested access, an admin will review your request and approve or deny you.
## Signing In with a Passkey ## Signing In with a Passkey
The Nest uses **passwordless authentication** powered by [Keycloak](https://keycloak.org/) and WebAuthn passkeys. This means: 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). 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). 2. You need a **passkey-capable password manager or device** — [Vaultwarden](communication-and-security/vaultwarden.md) (you will be given access to Vaultwarden by default), 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. 3. You will use the same passkey for all services in The Nest.
### First-Time Setup ### First-Time Setup
Once approved, you will receive two emails:
1. An invite to join Vaultwarden.
2. An email with instructions on first-time setup that pointed you here. Hi!
1. Visit [sso.mynest.love](https://sso.mynest.love) and click **Sign In**. 1. Visit [sso.mynest.love](https://sso.mynest.love) and click **Sign In**.
2. Enter the email address you were provided. 2. Enter the email address you were provided.
3. Follow the prompts to create your first passkey on your device. 3. Follow the prompts to create your first passkey on your device.
@ -39,6 +41,18 @@ Before exploring other services, set up [Vaultwarden](vaultwarden.md). It stores
2. Click **Master Password****I forgot my master password** (first-time flow) 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. 3. Follow the setup wizard to create your vault and enroll a passkey for The Nest SSO.
## 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
- **Foundry VTT** - A virtual tabletop for RPGs
All other services require an admin to grant you access. See [Requesting Service Access](access-requests.md) for details.
## Exploring Services ## 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. 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.