Skip to content

Plan an independent IrregularNet realm

Use this plan when your organization wants its own membership, certificate trust and access policy. If you want community members to use their existing IrregularNet device certificates at your venue, start with the shared-realm hosting guide. Another location does not need another realm.

You can also download the portable AI hosting skill and ask Codex, Claude or another assistant to help with the independent-realm track. It checks current installer readiness and prepares the ownership, configuration and acceptance plan before proposing live changes.

The organization deployment guide compares three options: an existing managed fleet, a self-hosted mixed-device service, or a managed certificate/RADIUS service. Choose based on the identity, devices and operators you already have. Running this repository is one possible self-hosted starting point and requires further implementation work.

For every option, name a primary and backup owner for identity and eligibility, issuer and key custody, RADIUS and network equipment, updates, incident response, and off-host recovery. Decide who can revoke one device, offboard an account and authorize a restore. A service provider taking one role does not remove the others.

Download the realm planning worksheet and fill it in locally. It is a planning document, not an executable configuration or application form. Keep completed plans private; include no passwords, keys, profiles or member records.

  • Realm identity: Your own stable identifier and display name; independent of an AP or venue name
  • Enrollment and server names: Your own HTTPS enrollment hostname and the exact RADIUS server names clients must verify
  • Pilot network: A separate test SSID, actual AP/controller source, private authentication path and isolated IPv4/IPv6 segment
  • Membership: Identity provider, stable account identifier, human/service-account policy, eligibility source and freshness requirements
  • Authority: Administrator roles, any location delegation, required reasons and audit retention
  • Credential lifecycle: Per-device enrollment, expiry, renewal, lost-device handling, offboarding and the measured access-loss deadline
  • Trust and custody: Client and server trust boundaries, protected online issuer, offline root ownership and approved secret delivery
  • Operations: Supported software/equipment versions, monitoring, update owner, backup/restore evidence and alternate management access

Your realm should have its own keys, secrets and state. Do not import Muse’s state or use its bootstrap/SSO/NAS commands against an existing service as a shortcut. Independent certificates have no automatic trust at shared IrregularNet locations. An identical SSID does not establish federation.

The service source is the implementation reference; repository access may require sign-in. The following is an initial source map checked against main at 6a2a678b, not a complete realm-configuration API:

  • site.example.json, scripts/bootstrap.py, portal/letswifi.conf.php: Hostnames, realm, SSID, display names, issuer identities, client/server trust and generated profiles; the example JSON currently exposes only two hostnames and one NAS address
  • scripts/configure-sso.py, scripts/configure-gateway-sso.py, portal/saml-config.php, portal/wifi-admin-auth.php, gateway/: IdP application, signed identity, audience/return paths, eligibility, administrator roles and gateway/cookie scope
  • radius/policy.py, radius/, scripts/configure-nas.py: Exact verified certificate identity/issuer/serial, realm and enrollment policy, SSID and actual private NAS transport binding
  • portal/device-core.php, portal/wifi-admin-core.php, scripts/revoke.py, scripts/rotate-pki.py: Ownership, inventory, revocation and rotation target the same realm and preserve other realms’ records
  • deploy.sh, scripts/, tests/: Fresh install, upgrades and restore preserve trust and newer access decisions; tests demonstrate rejection of another realm

Changing site.example.json alone does not change all these policies. The installer milestone needs a versioned, validated contract consumed by every reader and writer, plus a reviewed migration path. Global text replacement is insufficient: identity checks and trust boundaries need behavior tests. The community moderation draft must be assessed separately when it becomes the accepted runtime baseline.

Use the technical deployment sequence for PKI, RADIUS, network and client details. Before opening access, record:

  • Eligible enrollment and renewal through the real identity provider, one credential per device, and rejection of ineligible or service accounts under your chosen policy.
  • A real client connection with the expected server identity; rejection of an untrusted server, another realm’s credential and a revoked credential at fresh authentication.
  • Correct network assignment and permitted internet/application access, with staff, management and private-network isolation over IPv4 and IPv6.
  • Measured behavior for an existing session, reauthentication, sleep/wake and roaming after revocation. Record the maximum access window actually observed.
  • Enrollment/authentication outages, alternate management access, and a restore that preserves revocations made after the backup. Verify the restored policy through a real authentication attempt.

Record the exact source/image, hardware/firmware, client OS, expected and actual results, reviewer and unresolved limitations. Configuration validation and CI are prerequisites; they do not replace these device checks.

  • Realm contract: Deliverable: Complete policy inventory, versioned nonsecret configuration and validation. Current state: Initial source map and planning worksheet in this documentation change; implementation pending.
  • Isolated bootstrap: Deliverable: Fresh realm-specific keys/state, reviewed configuration preview and protected secret delivery. Current state: Not a supported independent-realm installer.
  • Lifecycle and recovery: Deliverable: Enrollment/renewal, account and device revocation, upgrades, backups and restore acceptance. Current state: Needs independent-realm implementation and verification.
  • Pilot acceptance: Deliverable: One isolated deployment passes the real identity, EAP-TLS, network and recovery checks. Current state: Pending.
  • Optional federation: Deliverable: Explicit trust, admission, routing, offboarding and privacy agreements between realm owners. Current state: Separate design decision; no automatic cross-trust.

The implementation roadmap tracks this sequence alongside shared-location provisioning. Share a completed plan privately with the responsible infrastructure maintainer to agree scope, ownership and a test deployment. This page submits nothing and enables no access.

Recent changes

  1. docs(irregularnet): provide a portable AI hosting skill gitayam
  2. Fix mobile layout for IrregularNet planning guides gitayam
  3. docs(irregularnet): define independent realm planning and milestones gitayam