v0.1.0 Latest

Starter doc types

What SEED_ON_START loads, field by field, with the shared option lists.

With SEED_ON_START=true the first boot loads these doc types and the option lists they draw on. The seed is idempotent and never creates users; the first administrator comes from the setup screen. Edit, archive, or ignore any of them.

Doc typeScopeFields
VendorcompanyName, Type [Vendor Types], Support Phone, Support URL, Account #, Notes (markdown)
ISPlocationProvider [Internet Providers], Circuit Type [Circuit Types], Circuit ID, Static IPs, Gateway (ip), Speed Down/Up, Account #, Support Notes (markdown)
FirewalllocationMake [Firewall Vendors], Model, Serial, Firmware, LAN IP (ip), WAN [doc_link → ISP], Admin URL, Credentials [secret_ref], Notes (markdown)
SwitchlocationMake, Model, Serial, Mgmt IP (ip), VLANs (markdown), Uplinks (markdown)
Wi-FilocationSSID, Security [Wi-Fi Security], VLAN, Controller/AP Model, Credentials [secret_ref]
PrinterlocationMake, Model, IP (ip), Serial, Driver URL, Supplies Vendor [doc_link → Vendor]
ServerlocationHostname, Role [multi: Server Roles], OS [Server Operating Systems], IP (ip), Host/Hypervisor, Backup Notes (markdown)
RacklocationName, Room, Power, Notes (markdown). Marked is_rack: gets an elevation
Domain/DNScompanyDomain (role: domain), Registrar [Registrars and DNS Hosts] (role: registrar), DNS Host [same list] (role: dns_host), Expiration (date, role: expiry), Records Notes (markdown)
M365/Google TenantcompanyTenant Name, Tenant ID, Admin URL, Licenses (markdown), Break-glass [secret_ref]

Shared lists

Who a domain or a circuit is with is the same handful of companies for every client, so these are shared lists rather than a document per company. Anything missing is added inline from a document with the +, and it is there for every company after.

  • Vendor Types: ISP, Hardware, Software, Distributor, Carrier
  • Registrars and DNS Hosts: Cloudflare, GoDaddy, Namecheap, Hostinger, and more. Both domain fields draw on one list: the firms that register domains are the firms that host DNS
  • Internet Providers, Circuit Types, Firewall Vendors, Wi-Fi Security, Server Roles, Server Operating Systems

Field roles

The Domain/DNS fields carry roles (domain, registrar, dns_host, expiry) that tell domain checks which field holds what. Give the same roles to fields on your own doc type and the checks work there too.