The-Nest/docs
The-Nest/docs
1
0
Fork 0
Code Issues 2 Pull requests 1 Projects Releases Packages 1 Wiki Activity Actions

Lots of docs cleanup. Added external documentation links
Some checks are pending
Build and Publish Docs / build-and-push (push) Waiting to run
Details

Browse source
This commit is contained in:
Astra Logical 2026-07-28 16:52:30 -04:00
parent 727f1fcc67
commit 38545d3bb4
16 changed files with 112 additions and 126 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/user-facing/access-requests.md
View file

@ -1,6 +1,6 @@
# Requesting Additional Service Access
By default, every new member of **The Nest** receives instant access to our core platforms: **Matrix**, **Vaultwarden**, **Forgejo**, **Foundry VTT**, and this documentation site.
By default, every new member of **The Nest** receives instant access to our core platforms: **Matrix**, **Vaultwarden**, and **Forgejo**.
Looking for access to additional applications? You can easily request access directly through our automated Matrix access bot!
@ -26,13 +26,12 @@ Identify the group name you would like to join, then send:
*(Be sure to replace `<group_name>` with the exact name provided by the bot in Step 2.)*
> [!NOTE]
> **What Happens Next?**
> An administrator will automatically receive a notification with your request and will approve or review it shortly.
> [!NOTE] **What Happens Next?**
> *An administrator will automatically receive a notification with your request and will approve or review it shortly.*
---
## Responsibilities & Usage
> [!WARNING]
> Access to any service within The Nest is managed by administrators and can be adjusted or revoked at any time. Please remember to use all shared resources responsibly!
> *Access to any service within The Nest is managed by administrators and can be adjusted or revoked at any time. Please remember to use all shared resources responsibly!*

38
docs/user-facing/communication-and-security/keycloak-account.md
View file

@ -14,26 +14,6 @@ Keycloak works behind the scenes to handle three core functions:
---
## Managing Your Passkeys
You have full control over your authentication devices! You can view, add, or remove passkeys at any time directly from your account dashboard.
### Viewing Your Enrolled Passkeys
1. Visit [sso.mynest.love](https://sso.mynest.love) and sign in.
2. Click on **Account** (or navigate to **Security Devices**).
3. Here, you will see a list of all devices and passkeys currently linked to your account.
### Adding a New Passkey
1. From your Keycloak account page, navigate to **Security Devices** and click **Add**.
2. Follow your browser or device prompts to register your new passkey (e.g., a smartphone, security key, or browser password manager).
3. Give your passkey a recognizable name (such as *"Work Laptop"* or *"Personal iPhone"*) to keep track of your devices easily.
### Removing a Passkey
* To remove an old device, locate it under **Security Devices** and select **Delete**.
* **Safety Feature:** Keycloak prevents you from deleting your final remaining passkey to ensure you don't lock yourself out. You must enroll a replacement passkey before removing the last one.
---
## Group-Based Permissions
Your access to different applications across The Nest is managed through **Keycloak Groups**. In most cases, group names match the service they unlock (for example, belonging to the `foundry-vtt` group gives you access to Foundry VTT).
@ -46,21 +26,15 @@ To request access to additional services, please see the [Requesting Service Acc
If you lose access to all of your enrolled devices or passkeys:
1. Reach out to an administrator on Matrix at `@nest:starling.mynest.love`.
1. Reach out to an administrator on Matrix in the **Ask an Admin** room in the **Admin** space.
2. Verify your identity using the email address linked to your account.
3. An administrator will send you a secure recovery link to reset your credentials and register a new passkey.
---
## Related Services
## 5. Service Summary & Related Links
Here are a few core platforms that integrate directly with Keycloak:
* **[Matrix](../communication-and-security/matrix.md):** Unified chat and voice login via SSO.
* **[Vaultwarden](../communication-and-security/vaultwarden.md):** Can store and manage passkeys securely across devices.
* **[Forgejo](../productivity-and-creation/forgejo.md):** Seamless identity management for code repositories.
---
> [!NOTE]
> *Screenshots of the Keycloak Security Devices page will be added in a future update!*
| Component | URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **Keycloak** | [sso.mynest.love](https://sso.mynest.love) | Account, identity, and authorization |
| **Official Docs** | [Keycloak Docs](https://www.keycloak.org/documentation) | The official Keycloak docs |

18
docs/user-facing/communication-and-security/matrix.md
View file

@ -16,9 +16,8 @@ Because Matrix is a decentralized messaging network, you will log in by connecti
4. You will be redirected to our standard login screen (`sso.mynest.love`) to authenticate with your passkey.
5. Once authenticated, you will be brought right back into Matrix—ready to start chatting!
> [!TIP]
> **One-Time Authentication:**
> You only need to use your passkey for initial login on a new device. Your client app will stay securely signed in until you manually log out.
> [!TIP] **One-Time Authentication**
> *You only need to use your passkey for initial login on a new device. Your client app will stay securely signed in until you manually log out.*
---
@ -26,9 +25,9 @@ Because Matrix is a decentralized messaging network, you will log in by connecti
One of the best features of Matrix is that you can choose your own application client! However, because features like video calling and screen sharing require WebRTC support, we recommend using one of the official **Element** applications:
* **Element Desktop** *(Windows, macOS, Linux)*: The recommended option for desktop users, featuring full screen-sharing and multi-party video call support.
* **Element X** *(iOS & Android)*: A modern, high-performance mobile client for chatting on the go.
* **Element Web** *(Browser)*: Accessible immediately from any modern Web browser at [app.element.io](https://app.element.io).
- **Element Desktop** *(Windows, macOS, Linux)*: The recommended option for desktop users, featuring full screen-sharing and multi-party video call support.
- **Element X** *(iOS & Android)*: A modern, high-performance mobile client for chatting on the go.
- **Element Web** *(Browser)*: Accessible immediately from any modern Web browser at [app.element.io](https://app.element.io).
---
@ -42,9 +41,8 @@ If you are accustomed to Discord, Matrix has a slightly different vocabulary, bu
| **Server** | **Space** | A folder structure used to organize multiple rooms together. Anyone can create a private or public Space. |
| **Text / Voice Channel** | **Room** | Where messaging happens! In Matrix, every room (including 1-on-1 direct messages) supports text, voice, and video. |
> [!NOTE]
> **Federation (Connecting Beyond The Nest):**
> Matrix is *federated*. This means you can use your Nest account to join public rooms or send direct messages to users on other Matrix homeservers across the internet (such as `@username:matrix.org`).
> [!NOTE] **Federation (Connecting Beyond The Nest)**
> *Matrix is federated. This means you can use your Nest account to join public rooms or send direct messages to users on other Matrix homeservers across the internet (such as `@username:matrix.org`).*
---
@ -70,10 +68,12 @@ For reference or advanced client setup, here are the service endpoints powering
| **Homeserver (Synapse)** | `https://starling.mynest.love` | Handles chat messages and room routing |
| **Authentication Service (MAS)** | `https://mas.mynest.love` | Manages OAuth2 authentication flows |
| **Matrix RTC (LiveKit)** | `https://matrix-rtc.mynest.love` | Powers high-quality voice and video calls |
| **Matrix Official Docs** | [Matrix Docs](https://matrix.org/docs/chat_basics/matrix-for-im/) | Matrix Foundation Official Docs |
---
## 6. Troubleshooting & Related Services
* **Requesting Access to New Services:** Send a direct message to `@access-bot:starling.mynest.love` inside Matrix to request permissions.
- **Ask an Admin:** All Nest users should have access to the **Admin** space and **Ask an Admin** room. Use this room to ask questions, report issues, and seek help. If you have a problem, check **Ask an Admin** to see if someone else has run into the same issue!
* **Central Authentication:** Keycloak manages single sign-on access across Matrix and connected services.

18
docs/user-facing/communication-and-security/vaultwarden.md
View file

@ -13,6 +13,8 @@ With so many password management options available, here is why we encourage usi
* **Integrated Passkey & 2FA Support:** Store WebAuthn passkeys and built-in authenticator (TOTP) codes in one single, secure location—no need for separate authenticator apps!
* **Full Premium Feature Set:** Nest users receive full access to Bitwarden-compatible premium features (such as 2FA generation, secure attachment storage, and emergency access) at zero extra cost.
* **Automatic Backups vs. Local Files:** Local password files (like KeePass or un-synced text stores) risk permanent data loss if a device is damaged or lost. Vaultwarden keeps your vault synced in real time while benefit from automated Nest backups.
* **Secure Secret Sharing:** Securely share passwords and other secrets with anyone, even those outside The Nest!
- All Nest users are also automatically added to the The Nest Vaultwarden organization. You can create secrets at the organization level to share gameserver passwords, urls, notes, or anything else you want shared with the whole Nest securly.
---
@ -23,7 +25,7 @@ With so many password management options available, here is why we encourage usi
3. **Save Your Master Password:** This password encrypts your entire vault. Make sure to write it down or store it in a safe place!
> [!WARNING]
> **Important:** Because Vaultwarden uses zero-knowledge encryption, administrators **cannot** view or reset your Master Password if you forget it. Always keep a physical backup of your Master Password in a secure location!
> **Important:** Because Vaultwarden uses zero-knowledge encryption, administrators **cannot** view or reset your Master Password if you forget it. Always keep a physical backup of your Master Password in a secure location! If you lose your master password, you lose your vault!
*If your invite link has expired before setup, simply reach out to an administrator on Matrix to request a new invitation.*
@ -43,8 +45,8 @@ Export your saved passwords as an unencrypted **CSV** or **JSON** file from your
4. Select your exported file and click **Import Data**.
### Step 3: Clean Up
> [!CAUTION]
> **Security Reminder:** Once your import is complete, immediately delete the exported `.csv` or `.json` file from your device and empty your Trash/Recycle Bin. Export files contain your passwords in plain text!
> [!CAUTION] **Security Reminder**
> Once your import is complete, immediately delete the exported `.csv` or `.json` file from your device and empty your Trash/Recycle Bin. Export files contain your passwords in plain text!
---
@ -54,6 +56,8 @@ Vaultwarden uses standard **Bitwarden** client applications. When signing in to
`https://vault.mynest.love`
*The browser extension has a dropdown called "Accessing" at the bottom. Set this to self-hosted, then specify the URL above.*
### Recommended Downloads:
* **Browser Extension:** Install the **Bitwarden** browser extension (Chrome, Firefox, Edge, Safari) for one-click password auto-fill on websites.
* **Mobile Apps:** Download **Bitwarden** from the iOS App Store or Google Play Store to enable system-wide password and passkey auto-fill on smartphones.
@ -68,8 +72,7 @@ While The Nest relies primarily on **passwordless passkeys** managed via Keycloa
* **Passkey Vaulting:** Vaultwarden can securely store and sync passkeys used for both Nest services and external websites.
* **Credential Organization:** Safely store API keys, personal notes, credit cards, or recovery codes for all your digital accounts.
> [!TIP]
> **Passkey Auto-Fill:**
> [!TIP] **Passkey Auto-Fill**
> If you use the Bitwarden browser extension or mobile app, enable passkey support in the extension settings to sign into Nest services with a single click!
---
@ -79,7 +82,4 @@ While The Nest relies primarily on **passwordless passkeys** managed via Keycloa
| Component | URL | Purpose |
| :--- | :--- | :--- |
| **Vaultwarden Web UI** | [vault.mynest.love](https://vault.mynest.love) | Web vault, import tools, and account settings |
### Related Nest Documentation:
* **[Keycloak Identity](../technical/security-and-identity.md):** Powers central passkey logins across The Nest.
* **[Matrix Chat](../communication-and-security/matrix.md):** Get in touch with an administrator if you need help with your vault.
| **Bitwarden Official Docs** | [Bitwarden Docs](https://bitwarden.com/help/) | Bitwarden's official docs. Note: Vaultwarden is a fork of Bitwarden |

66
docs/user-facing/getting-started.md
View file

@ -9,10 +9,12 @@ Welcome to **The Nest**! This guide serves as your starting point for creating y
Ready to join the flock? Submit a [Fledgling Application](https://murmuration.mynest.love/public/nest/9df3e55b779db79ee8a00c0dc18d8dbb).
To complete your request, you will need:
* **A Username:** Choose carefully! Usernames cannot be easily changed once created.
* **A Working Email Address:** This address will be used for your initial setup, account recovery, and optional service notifications.
* **A quick message about who you know:** The Nest is for friends and family.
* **The Secret:** An inside joke. Ask someone who knows. No bots allowed!
- **A Username:** Choose carefully! Usernames cannot be easily changed once created.
- **A Working Email Address:** This address will be used for your initial setup, account recovery, and optional service notifications.
- **Note:** Your email address is never shared with external services.
- **A quick message about who you know:** The Nest is for friends and family.
- **The Secret:** An inside joke. Ask someone who knows. No bots allowed!
Once submitted, an administrator will review your request and approve your access.
@ -20,31 +22,34 @@ Once submitted, an administrator will review your request and approve your acces
## 2. Signing In with a Passkey
The Nest uses **passwordless authentication** (powered by Keycloak and WebAuthn). Instead of remembering complex passwords, you'll log in securely using a **passkey**.
The Nest uses **passwordless authentication** (powered by [Keycloak](communication-and-security/keycloak-account.md) and WebAuthn). Instead of remembering complex passwords, you'll log in securely using a **passkey**.
> [!NOTE]
> **What is a Passkey?**
> A passkey lets you sign in using your physical device or password manager instead of typing a password. You will use the exact same passkey for all services across The Nest.
> [!NOTE] **What is a Passkey?**
> *A passkey lets you sign in using your physical device or password manager instead of typing a password. You will use the exact same passkey for all services across The Nest.*
### What You Need
To sign in, you will need a passkey-compatible device or tool, such as:
* A smartphone or tablet
* A computer equipped with a fingerprint reader or face scanner
* A hardware security key (such as a YubiKey)
* A passkey-capable password manager like **Vaultwarden**
- A passkey-capable password manager like [**Vaultwarden**](communication-and-security/vaultwarden.md)
- *We highly recommend using Vaultwarden or a password manager like it.*
- A smartphone or tablet
- A computer equipped with a fingerprint reader or face scanner
- A hardware security key (such as a YubiKey)
### First-Time Account Setup
Once your account is approved by an administrator, you will receive two emails:
1. **An invitation to Vaultwarden** (an optional password manager service).
2. **Setup instructions** directing you to this guide.
If you would like to use Vaultwarden, accept the invite; if not, feel free to ignore it.
**To complete your initial sign-in:**
1. Navigate to [sso.mynest.love](https://sso.mynest.love) and click **Sign In**.
2. Enter the account username and temporary password provided in your setup details.
*(Note: This is the **only** time you will use a traditional password.)*
- *This is the **only** time you will use a traditional password.*
3. Follow the on-screen prompts to register a passkey on your device.
---
@ -55,13 +60,12 @@ Upon joining The Nest, you automatically gain access to several core platforms:
| Service | Description |
| :--- | :--- |
| **Matrix** | Group chat, direct messaging, and voice/video calling |
| **Vaultwarden** | Bitwarden-compatible password manager for securing credentials |
| **Forgejo** | Code hosting and collaborative project workspace |
| **Documentation Site** | The user guide platform you are currently reading |
| **Foundry VTT** | Virtual tabletop platform for tabletop RPG games |
| [**Matrix**](communication-and-security/matrix.md) | Group chat, direct messaging, and voice/video calling |
| [**Vaultwarden**](communication-and-security/vaultwarden.md) | Bitwarden-compatible password manager for securing credentials |
| [**Forgejo**](productivity-and-creation/forgejo.md) | Code hosting and collaborative project workspace |
*Additional services require separate administrator authorization. Please review the [Requesting Service Access](access-requests.md) guide for more information.*
> [!TIP] **Requesting Additional Access**
> *Additional services require separate administrator authorization. Please review the [Requesting Service Access](access-requests.md) guide for more information.*
---
@ -69,9 +73,8 @@ Upon joining The Nest, you automatically gain access to several core platforms:
As you explore the user guides for each platform, signing in is straightforward. Most services use a single button labeled **"Sign in with The Nest"**.
> [!TIP]
> **Terminology Tip:**
> Depending on the app, you might see phrases like *"Sign in with OIDC"*, *"Sign in with Keycloak"*, or *"Sign in with SSO"*. These all mean the exact same thing: sign in using your standard Nest passkey!
> [!TIP] **Terminology Tip**
> *Depending on the app, you might see phrases like "Sign in with OIDC", "Sign in with Keycloak", or "Sign in with SSO". These all mean the exact same thing: sign in using your standard Nest passkey!*
---
@ -79,6 +82,19 @@ As you explore the user guides for each platform, signing in is straightforward.
If you run into any issues along the way, here is how to resolve them:
* **Unable to Sign In?** Try using a different passkey-supported device, or reach out to an administrator on Matrix.
* **Service Unavailable or Unresponsive?** Systems undergo automated daily updates around **03:00 EST**. Please wait a few minutes and refresh your browser.
* **Need General Assistance?** Head over to the **Admin** space in Matrix and drop your question in the **"Ask an Admin"** room.
- **Unable to Sign In?** Try using a different passkey-supported device, or reach out to an administrator on Matrix.
- **Service Unavailable or Unresponsive?** Systems undergo automated daily updates around **03:00am EST**. Please wait a few minutes and refresh your browser.
- **Need General Assistance?** Head over to the **Admin** space in Matrix and drop your question in the **"Ask an Admin"** room.
---
## 6. Go Fish
We can't possibly document all the features of every service in The Nest. So that leaves you to figure some things out yourself!
- Start with the guides here. They'll get you in and focused on the main features we think you'll like.
- Mess around! Go dig into the settings, click on things, break something.
- Every service in The Nest is Free and Open Source Software (FOSS). This means you can find guides, resources, and wikis for just about everything.
- Ask questions. Go ask your fellow Nestlings for help!
- Have ideas? Post them in the **"Feature Requests"** room in the Admin space on Matrix.
- Improve the docs! The docs are maintained on forgejo. Go submit a PR and make The Nest a better place.

4
docs/user-facing/media-and-entertainment/audiobookshelf.md
View file

@ -27,8 +27,7 @@ To take your audiobooks and podcasts on the go, connect your smartphone using on
* **Server Connection:** When configuring any mobile client, set your server URL to:
`https://lyrebird.mynest.love`
> [!NOTE]
> **Connecting Mobile Apps:**
> [!NOTE] **Connecting Mobile Apps**
> When logging in via mobile apps, select the option to sign in via **OpenID / Single Sign-On** to authenticate using your standard Nest passkey.
---
@ -56,6 +55,7 @@ Want to add a new audiobook to the library?
| Component | URL / Endpoint | Description |
| :--- | :--- | :--- |
| **Audiobookshelf Web UI** | [lyrebird.mynest.love](https://lyrebird.mynest.love) | Web player, library management, and account settings |
| **Audiobookshelf Official Docs** | [Audiobookshelf Docs](https://audiobookshelf.org/docs/documentation/introduction/) | The Audiobookshelf docs |
### Related Nest Documentation:
* **[Shelfmark](../media-request/shelfmark.md):** Request new audiobooks to automatically populate your library.

6
docs/user-facing/media-and-entertainment/calibre-web.md
View file

@ -36,7 +36,7 @@ When logging in from an e-reader app, use the following credentials:
| Protocol | Service URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **OPDS** | `https://rookery.mynest.love/opds` | Browse and download books directly on your e-reader |
| **KoSync** | `https://rookery.mynest.love/sync` | Sync reading progress and bookmarks across devices |
| **KoSync** | `https://rookery.mynest.love/kosync` | Sync reading progress and bookmarks across devices |
---
@ -47,8 +47,7 @@ You can connect any app that supports OPDS or KoSync. Here are our top recommend
* **[KOReader](https://koreader.rocks/):** *(Available for Android, Kindle, Kobo, Windows, Linux)* — The premier open-source reading application featuring native OPDS browsing and built-in KoSync support.
* **[Readest](https://readest.app/):** *(Available for iOS)* — A sleek, modern e-reader app for iPhone and iPad with built-in OPDS support.
> [!TIP]
> **Have a Kindle?**
> [!TIP] **Have a Kindle?**
> If you'd like to install KOReader on a Kindle, check out [Kindle Mod Shelf](https://kindlemodshelf.me/) for jailbreaking guides! Alternatively, you can use the web interface's *"Send to Kindle"* feature to deliver EPUB or MOBI files directly to your Amazon account.
---
@ -88,6 +87,7 @@ Once linked, books you read in Calibre-Web will automatically sync with your Har
| Component | URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **Calibre-Web UI** | [rookery.mynest.love](https://rookery.mynest.love) | Web interface, online reading, and account settings |
| **Calibre-Web NextGen GitHub** | [CWANG GitHub](https://github.com/new-usemame/Calibre-Web-NextGen) | Calibre-Web NextGen doesn't have official docs |
### Related Nest Documentation:
* **[Shelfmark](../media-request/shelfmark.md):** Request new e-books to automatically populate the library.

15
docs/user-facing/media-and-entertainment/droppedneedle.md
View file

@ -25,7 +25,7 @@ DroppedNeedle acts as a **Subsonic-compatible music server**. This means you can
## 3. How Music Discovery & Requests Work
Unlike movie or TV requests, DroppedNeedle lets you search and request music directly—no administrator approval needed!
Unlike movie or TV requests, DroppedNeedle lets you search and request music directly—no additional service needed!
1. Use the main search bar to search for a song, album, or artist.
2. DroppedNeedle queries multiple sources simultaneously:
@ -35,8 +35,7 @@ Unlike movie or TV requests, DroppedNeedle lets you search and request music dir
* **YouTube:** Stream music directly from YouTube if it's available, or preview songs before adding them to your library.
3. Click **Play** to stream immediately, or **Download** to pull the track into the library.
> [!TIP]
> **Help Keep the Library Clean!**
> [!TIP] **Help Keep the Library Clean!**
> Occasionally, DroppedNeedle needs help matching a rare file. Visit the **Downloads** tab to review pending downloads, select correct releases, or verify track tagging. Helping review downloads ensures the library stays organized for everyone!
---
@ -51,6 +50,11 @@ Want weekly mixes and personalized artist recommendations? DroppedNeedle support
Once connected, DroppedNeedle will automatically generate custom weekly mixes and artist recommendations based on your listening habits!
> [!NOTE] **Privacy Note**
> Scrobbling technically causes your listening habit data to leave The Nest. In the future we may stand up local ListenBrainz and a MusicBrainz DB sync, but as it stands, getting weekly recommendations/playlists requires sending this data to an external source.
>
> *ListenBrainz (and Last.fm to a lesser extend) has very comprehensive privacy settings. Please review them to keep your data from being sold/scraped.*
---
## 5. Following Artists & Local Concert Tracking
@ -76,7 +80,4 @@ You can sync your existing Spotify playlists directly over to DroppedNeedle! How
| Component | URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **DroppedNeedle Web UI** | [heron.mynest.love](https://heron.mynest.love) | Web streaming, music search, and library management |
### Related Nest Documentation:
* **[slskd (Soulseek)](../technical/slskd-soulseek.md):** The peer-to-peer backend supporting music searches.
* **[Matrix Chat](../communication-and-security/matrix.md):** Reach out to an admin to request Spotify playlist integration.
| **DroppedNeedle Official Docs** | [DroppedNeedle Docs](https://droppedneedle.com/docs) | DroppedNeedle's Official Docs |

10
docs/user-facing/media-and-entertainment/jellyfin.md
View file

@ -21,8 +21,7 @@ Jellyfin offers official app support across almost every major platform:
* **Mobile / Desktop Apps:** iOS (iPhone/iPad), Android, Windows, macOS, Linux
* **Web Browsers:** Chrome, Firefox, Safari, Edge
> [!NOTE]
> **Signing In on TV Apps (Quick Connect)**
> [!NOTE] **Signing In on TV Apps (Quick Connect)**
> Smart TV apps cannot process passkey logins directly. To sign into a TV or streaming device, use **Quick Connect**:
>
> 1. Open the Jellyfin app on your TV or streaming device and select **Quick Connect**. A short code will appear on your TV screen.
@ -37,7 +36,7 @@ Jellyfin offers official app support across almost every major platform:
Looking for a specific movie or TV show that isn't in the library yet?
* **Submit Requests:** You can request new titles through **[Seerr](../media-requests/seerr.md)**!
* **Submit Requests:** You can request new titles through **[Seerr](../media-request/seerr.md)**!
* **Automated Sync:** Once requested, media moves through our automated ingest pipeline and automatically populates in Jellyfin.
* **Library Scans:** Jellyfin scans for new media regularly. If a newly approved request doesn't appear immediately, please wait up to 24 hours for automated library indexing. If content is still missing after 24 hours, reach out to an administrator on Matrix.
@ -56,7 +55,4 @@ Looking for a specific movie or TV show that isn't in the library yet?
| Component | URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **Jellyfin Web UI** | [beak.mynest.love](https://beak.mynest.love) | Web streaming, user profiles, and Quick Connect authorization |
### Related Nest Documentation:
* **[Seerr](../media-requests/seerr.md):** Request new movies and TV series to populate Jellyfin.
* **[Matrix Chat](../communication-and-security/matrix.md):** Contact an admin if media fails to sync after 24 hours.
| **Jellyfin Official Docs** | [Jellyfin Docs](https://jellyfin.org/docs/) | Jellyfin's official docs |

16
docs/user-facing/media-request/seerr.md
View file

@ -27,6 +27,7 @@ Requesting new content takes just a couple of clicks!
> [!WARNING]
> **Important Rule for Anime Requests!**
>
> When requesting an Anime series or movie, you **must** select the **Anime** profile from the profile dropdown instead of the default profile. Because anime formatting and episode numbering differ from Western TV releases, using the default profile will cause the automated request to fail.
---
@ -40,8 +41,8 @@ Once your request is submitted, The Nest's media pipeline processes it automatic
3. **Status Update:** Once complete, the request status in Seerr updates to **Available**.
### Fulfillment Timelines:
* **Standard Requests:** Popular movies or recent TV episodes are usually downloaded within a couple of hours.
* **Jellyfin Library Indexing:** It can take up to **24 hours** for newly downloaded files to automatically index and appear in Jellyfin.
* **Standard Requests:** Popular movies or recent TV episodes are usually downloaded within a couple of hours at most.
* **Jellyfin Library Indexing:** It can take up to **24 hours** for newly downloaded files to automatically index and appear in Jellyfin, but it typically should be shorter.
* **Stuck or Missing Requests?** If a title remains in *Pending* or *Processing* status for longer than 24 hours, the media may be rare or unavailable. Reach out to an administrator on Matrix to check its status!
---
@ -50,8 +51,14 @@ Once your request is submitted, The Nest's media pipeline processes it automatic
* **Search Before Requesting:** Always search the library first to avoid submitting duplicate requests for media that is already available or currently processing.
* **Default Quality Settings:** You can configure default quality preferences (such as preferred resolution) inside your Seerr profile settings.
- *Note: If you request a quality that does not exist (for example: Blueray for a series that never got a Blueray release), your request may fail to download.
* **Better Searching:** Seerr features rich metadata search and filtering capabilities; however its genre selection is a little lacking. Instead, use "tags" when you search, found in the filters menu.
* **Reccomendations & Similar Titles:** Looking for something similar to That Baking Show? Click into it in Seerr and scroll to the bottom to see titles similar to it!
* **Community Features:** Explore the **Requests** tab to see what other members are looking forward to watching, or leave ratings and comments on titles.
> [!WARNING] Adult Material
> Some filters have been put in place to deny-list outright porn; however some things might slip through the filter. If you notice some tags that need added, reach out to an admin.
---
## 5. Service Summary & Related Links
@ -59,7 +66,4 @@ Once your request is submitted, The Nest's media pipeline processes it automatic
| Component | URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **Seerr Web UI** | [stork.mynest.love](https://stork.mynest.love) | Media discovery, title searching, and request management |
### Related Nest Documentation:
* **[Jellyfin](../media-and-entertainment/jellyfin.md):** Stream requested movies and TV series once available.
* **[Media Automation Pipeline](../technical/media-automation-pipeline.md):** Technical documentation on the Sonarr and Radarr backend downloaders.
| **Seerr Official Docs** | [Seerr Docs](https://docs.seerr.dev/) | Seerr's docs |

1
docs/user-facing/media-request/shelfmark.md
View file

@ -49,6 +49,7 @@ Shelfmark automatically sources the highest-quality releases available for your
| Component | URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **Shelfmark Web UI** | [magpie.mynest.love](https://magpie.mynest.love) | Catalog browsing and e-book / audiobook request portal |
| **Shelfmark Github** | [Shelfmark Github](https://github.com/calibrain/shelfmark) | Shelfmark doesn't have official docs |
### Related Nest Services:
* **[Calibre-Web](../media-and-entertainment/calibre-web.md):** Read requested e-books in your browser or sync to an e-reader.

5
docs/user-facing/productivity-and-creation/forgejo.md
View file

@ -16,6 +16,7 @@
> [!WARNING]
> **HTTP Git Access is Disabled**
>
> For security reasons, HTTP/HTTPS Git cloning and pushing are completely disabled on The Nest. All command-line Git interactions must use **SSH**.
To interact with repositories from your terminal or command line, you must add your SSH public key to your Forgejo account.
@ -112,6 +113,4 @@ Repositories can automate builds, tests, and deployments using Forgejo Actions (
| **Web UI** | [weaver.mynest.love](https://weaver.mynest.love) | Browser (Passkey) | Repository management, issue tracking, and PRs |
| **Git SSH Server** | `ssh.weaver.mynest.love` (Port `22`) | SSH Key | Command-line Git cloning, pulling, and pushing |
| **Package Registry** | [weaver.mynest.love/packages](https://weaver.mynest.love/packages) | API / Token | Container images and package management |
### Related Nest Documentation:
* **[Semaphore](https://semaphore.k3s.home.nest):** Ansible automation UI for infrastructure deployment and execution.
| **Forgejo Official Docs** | [Forgejo Docs](https://forgejo.org/docs/latest/) | Forgejo's docs |

9
docs/user-facing/productivity-and-creation/foundry-vtt.md
View file

@ -7,9 +7,10 @@
## 1. Web Access & Initial Setup
1. Open **[foundry.mynest.love](https://foundry.mynest.love)** in your Web browser.
2. Click **Sign In** and log in using your standard Nest passkey.
3. Select your assigned **User Profile** from the campaign dropdown menu and enter your player passcode (if set by your GM).
*No passkey is required to access foundry. This is so you can invite players from outside The Nest on your adventures!*
---
## 2. Core Concepts: Worlds, Systems, and Modules
@ -26,8 +27,7 @@ To get the most out of Foundry VTT, it helps to understand its three primary lay
Want to run a campaign or one-shot for your gaming group on The Nest?
> [!IMPORTANT]
> **Single-Instance Server & Admin Access**
> [!IMPORTANT] **Single-Instance Server & Admin Access**
> Foundry VTT runs as a single service on The Nest, which means **only one World (campaign) can be actively hosted at any given time**.
>
> * **Admin Password:** Switching active campaign Worlds or installing new Game Systems and Modules requires the server's admin password.
@ -51,6 +51,3 @@ Want to run a campaign or one-shot for your gaming group on The Nest?
| :--- | :--- | :--- | :--- |
| **Foundry Web UI** | [foundry.mynest.love](https://foundry.mynest.love) | Web Browser | Connect to active tabletop campaign worlds |
| **Official Documentation** | [foundryvtt.com/kb](https://foundryvtt.com/kb/) | External Link | Official Foundry VTT Knowledge Base and user guides |
### Related Nest Documentation:
* **[Matrix Chat](../communication-and-security/matrix.md):** Coordinate game night schedules with other GMs or request admin credentials.

11
docs/user-facing/storage-and-files/nextcloud.md
View file

@ -38,8 +38,7 @@ Nextcloud includes a full-featured, browser-based office suite (powered by Nextc
Nextcloud provides built-in CalDAV and CardDAV endpoints for syncing your calendars, address books, and tasks across mobile and desktop applications.
> [!TIP]
> **Authentication Note for Native Apps (App Passwords)**
> [!TIP] **Authentication Note for Native Apps (App Passwords)**
> Native calendar and contact apps on iOS, macOS, Android, or Thunderbird cannot use passkeys directly.
>
> * Before configuring your app, go to **Settings → Security → Devices & Sessions** in Nextcloud.
@ -76,13 +75,9 @@ Nextcloud provides built-in CalDAV and CardDAV endpoints for syncing your calend
| :--- | :--- | :--- |
| **Web UI** | [cloud.mynest.love](https://cloud.mynest.love) | Primary cloud portal, office suite, and web manager |
| **DAV / CalDAV / CardDAV** | `https://cloud.mynest.love/remote.php/dav/` | Synchronization endpoint for files, calendars, and contacts |
| **Nextcloud Official Docs** | [NextCloud Docs](https://docs.nextcloud.com/) | NextCloud's docs |
### Backups & Data Protection:
* **User Data:** Backed up daily at **02:00 EST** using Restic to offsite Backblaze B2 storage.
* *Backups are encrypted before transmission and remain encrypted.*
* **Configuration & Database:** Application state and cluster configurations are snapshotted via Longhorn recurring backup tasks.
---
## Related Nest Documentation:
* **[Forgejo](../technical/forgejo.md):** Git code hosting and package management.
* **[Matrix Chat](../communication-and-security/matrix.md):** Instant messaging and administrative support.

5
mkdocs.yaml
View file

@ -23,6 +23,9 @@ theme:
toggle:
icon: material/brightness-4
name: Switch to light mode
markdown_extensions:
- markdown_gfm_admonition
nav:
- Home: index.md
- User Facing:
@ -44,4 +47,4 @@ nav:
- Forgejo (Git): user-facing/productivity-and-creation/forgejo.md
- Foundry VTT: user-facing/productivity-and-creation/foundry-vtt.md
- Storage and Files:
- Nextcloud: user-facing/storage-and-file/nextcloud.md
- Nextcloud: user-facing/storage-and-files/nextcloud.md

1
requirements.txt
View file

@ -1 +1,2 @@
mkdocs-material==9.5.3
markdown-gfm-admonition==0.3.0