directory/docs/directory.example.yaml

# yaml-language-server: $schema=http://localhost:3000/schema.json
# Replace the placeholder addresses with your own.
# Sign-in is disabled. Uncomment one auth example below to enable it.
version: 1
site:
  # Set your public origin when deploying beyond localhost (no trailing slash).
  # url: https://directory.example.com
  title: Home Server
  description: Useful things running at home.
  footer: Something not working? Ask your household maintainer.
  # Optional public Open Graph image; generated when omitted.
  # og_image_path: /public/share.png

appearance:
  primary_light_color: '#0f766e'
  primary_dark_color: '#5eead4'

# Shared sign-in. Set site.url above to your directory's HTTPS origin.
# HTTP localhost is allowed for local testing. Restart after changing auth.
# auth:
#   credentials:
#     username: admin
#     password: replace-with-your-own-password

# Or SSO. Your provider must return an email for each identity.
# Register the client for client_secret_basic authentication and this callback:
# https://directory.example.com/auth/callback/oidc
# auth:
#   oidc:
#     issuer: https://identity.example.com
#     client_id: directory
#     client_secret: replace-with-your-client-secret

# Sessions expire seven days after sign-in, without renewal.
# Restarts sign everyone out unless you set auth.secret. To keep unexpired sessions
# across restarts, generate a value once with: openssl rand -base64 32
# Add it inside your chosen auth block as: secret: 'your-generated-value'
# Passwords and secrets can also use '${VAR}' from an optional .env file.
# Keep files containing secrets private.

# Reserved example.com destinations are placeholders, not live integrations.
# All bookmarks use generated logos; site branding uses the bundled default.
links:
  photos:
    title: Photos
    url: https://photos.example.com
    description: >-
      Family photos and videos, all in one place.
      Install your photo service's mobile app for automatic uploads.
    tags: [photos, videos, memories]
    group: Photos & files
    requires_auth: true
  files:
    title: Files
    url: https://files.example.com
    description: Shared documents, school projects and household paperwork.
    tags: [documents, sharing, storage]
    group: Photos & files
  backups:
    title: Backups
    url: https://backups.example.com
    description: |
      Check the latest backup status before you need a restore.
      Ask your household maintainer for help recovering a file.
    tags: [backup, recovery, storage]
    group: Photos & files
  scans:
    title: Paperwork inbox
    url: https://scans.example.com
    description: Sort recent scans into searchable bills, receipts and warranties.
    tags: [scans, documents, receipts]
    group: Photos & files
  archive:
    title: Family history archive
    url: https://archive.example.com
    description: Old letters, digitized albums and notes about the family tree.
    tags: [history, memories, documents]
    group: Photos & files
  albums:
    title: Shared albums
    url: https://albums.example.com
    description: Choose a photo collection to share with visiting relatives.
    tags: [photos, albums, sharing]
    group: Photos & files
  transfers:
    title: File drop
    url: https://transfers.example.com
    description: Temporary space for large files moving between household devices.
    tags: [transfer, sharing, storage]
    group: Photos & files
    internal_only: true
  notebooks:
    title: Household notebooks
    url: https://notebooks.example.com
    description: Shared notes for school, travel plans and everyday reference.
    tags: [notes, writing, planning]
    group: Photos & files
  sync:
    title: Device sync status
    url: https://sync.example.com
    description: Check whether laptop folders have reached the home server.
    tags: [sync, devices, storage]
    group: Photos & files
    internal_only: true
  keepsakes:
    title: DigitalKeepsakesAndSchoolProjectCollections
    url: https://keepsakes.example.com
    description: Finished school projects and small creations worth keeping.
    tags: [school, archive, memories]
    group: Photos & files
  music:
    title: Music
    url: https://music.example.com
    description: Albums, playlists and a soundtrack for dinner.
    tags: [music, audio, playlists]
    group: Entertainment
  movies:
    title: Movies
    url: https://movies.example.com
    description: Browse the family movie and television library.
    tags: [movies, television, streaming]
    group: Entertainment
  books:
    title: Books
    url: https://books.example.com
    description: Find your next ebook or audiobook for the commute.
    tags: [books, reading, audiobooks]
    group: Entertainment
  radio:
    title: Radio
    url: https://radio.example.com
    description: Saved station links and recordings from the community radio club.
    tags: [radio, audio, recordings]
    group: Entertainment
  podcasts:
    title: Podcast queue
    url: https://podcasts.example.com
    description: Episodes downloaded for the next long drive.
    tags: [podcasts, audio, travel]
    group: Entertainment
  reading:
    title: Weekend reading list
    url: https://reading.example.com
    description: Saved articles and reading suggestions from around the household.
    tags: [reading, articles, bookmarks]
    group: Entertainment
  requests:
    title: Library requests
    url: https://requests.example.com
    description: Suggest something for the household media collection.
    tags: [library, requests, media]
    group: Entertainment
    requires_auth: true
  home-automation:
    title: Home automation
    url: https://home.example.com
    description: |
      Lights, room temperatures and everyday routines.
      Connect to the home network or VPN before opening this service.
    tags: [home, lights, routines]
    group: Everyday tools
    internal_only: true
  recipes:
    title: Recipes
    url: https://recipes.example.com
    description: Favorite meals, shopping lists and this week's dinner plan.
    tags: [cooking, meals, shopping]
    group: Everyday tools
  calendar:
    title: Family calendar
    url: https://calendar.example.com
    description: Appointments, school events and reminders for bin collection.
    tags: [calendar, reminders, planning]
    group: Everyday tools
  groceries:
    title: Shopping list
    url: https://groceries.example.com
    description: Add groceries before the next trip to the shops.
    tags: [shopping, groceries, pantry]
    group: Everyday tools
  weather:
    title: Garden weather station
    url: https://weather.example.com
    description: Local rainfall and temperature readings from the garden sensors.
    tags: [weather, garden, sensors]
    group: Everyday tools
  energy:
    title: Energy
    url: https://energy.example.com
    description: Household electricity trends and daily solar production.
    tags: [energy, solar, sensors]
    group: Everyday tools
    internal_only: true
  guides:
    title: Workshop guides
    url: https://guides.example.com
    description: Repair notes and instructions for frequently used tools.
    tags: [workshop, repair, guides]
    group: Workshop
  printer:
    title: 3D printer
    url: https://printer.example.com
    description: Check the current print before starting another job.
    tags: [printing, workshop, projects]
    group: Workshop
    internal_only: true
  inventory:
    title: Parts inventory
    url: https://inventory.example.com
    description: Find spare cables, screws and electronic components.
    tags: [parts, storage, workshop]
    group: Workshop
  projects:
    title: Works in progress
    url: https://projects.example.com
    description: Sketches, task lists and progress photos for household projects.
    tags: [projects, planning, workshop]
    group: Workshop
  manuals:
    title: Appliance manuals and warranty notes
    url: https://manuals.example.com
    description: Setup instructions and service records for household appliances.
    tags: [manuals, warranties, repair]
    group: Workshop
  router:
    title: Router
    url: https://router.example.com
    description: Manage the home network; leave changes to your household maintainer.
    tags: [network, router, maintenance]
    group: Behind the scenes
    requires_auth: true
    internal_only: true
    admin_only: true
  monitoring:
    title: Server health
    url: https://monitoring.example.com
    description: Storage capacity, temperatures and service availability.
    tags: [monitoring, maintenance, server]
    group: Behind the scenes
    internal_only: true
    admin_only: true
  containers:
    title: Container console
    url: https://containers.example.com
    description: Maintenance console for the services running on the home server.
    tags: [containers, maintenance, server]
    group: Behind the scenes
    requires_auth: true
    internal_only: true
    admin_only: true
  dns:
    title: Local name service
    url: https://dns.example.com
    description: Household DNS records and local network filtering settings.
    tags: [network, dns, maintenance]
    group: Behind the scenes
    internal_only: true
    admin_only: true