82 lines
3.7 KiB
Markdown
82 lines
3.7 KiB
Markdown
# Welcome to The Nest: Getting Started Guide
|
|
|
|
Welcome to **The Nest**! This guide serves as your starting point for creating your account, navigating available services, and getting support whenever you need it.
|
|
|
|
---
|
|
|
|
## 1. Requesting Access
|
|
|
|
Ready to join the flock? Head over to [fledgling.mynest.love](https://fledgling.mynest.love) to submit your account request.
|
|
|
|
To complete your request, you will need:
|
|
* **A Username:** Choose carefully! Usernames cannot be easily changed once created.
|
|
* **A Working Email Address:** Email aliases are completely fine. This address will be used for your initial setup, account recovery, and optional service notifications.
|
|
|
|
Once submitted, an administrator will review your request and approve your access.
|
|
|
|
---
|
|
|
|
## 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**.
|
|
|
|
> [!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**
|
|
|
|
### 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.)*
|
|
3. Follow the on-screen prompts to register a passkey on your device.
|
|
|
|
---
|
|
|
|
## 3. Your Default Account Services
|
|
|
|
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 |
|
|
|
|
*Additional services require separate administrator authorization. Please review the [Requesting Service Access](access-requests.md) guide for more information.*
|
|
|
|
---
|
|
|
|
## 4. Exploring & Signing Into Services
|
|
|
|
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!
|
|
|
|
---
|
|
|
|
## 5. Troubleshooting & Support
|
|
|
|
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.
|