Skip to content
Capell CMS

Access Gate

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

FieldValue
Composer packagecapell-app/access-gate
Package slugaccess-gate
Product groupCapell Security & Compliance
Tierpremium
Bundlesecurity-compliance
Runtime contextsadmin, frontend, console
Capell version^1.0
Catalogue roleextension
Release channelBeta
Source repositorycapell-app/packages
Source pathpackages/access-gate
Docs sourcepackages/access-gate/docs
Manifestcapell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Access Gate is an Available, Schema-owning Capell package in the Capell Security & Compliance product group. It ships as capell-app/access-gate and extends these surfaces: admin, frontend, console.

Access Gate protects Capell pages, downloads, and member areas with request, approval, grant, claim-link, and browser-token workflows.

Admins manage protected areas, requests, grants, tokens, and audit events. Visitors can request access or see a blocked state until a valid grant is resolved.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: security-compliance
  • Composer package: capell-app/access-gate
  • Namespace: Capell\AccessGate
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: AccessGateMiddleware delegates access decisions to package Actions, while registries handle request methods and fields without adding that logic to core.

For teams: Teams can approve, reject, expire, or revoke access and retain a record of requests, grants, and blocked visits.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Illustrative access areas admin index preview Illustrative access areas admin index preview Illustrative access area create/edit form preview Illustrative access area create/edit form preview
  • Illustrative access areas admin index preview (frontend, required evidence).
  • Illustrative access area create/edit form preview (frontend, required evidence).
  • Illustrative registrations admin index with review actions preview (frontend, required evidence).
  • Illustrative grants admin index preview (frontend, required evidence).
  • Illustrative claim tokens admin index preview (frontend, required evidence).
  • Illustrative browser tokens admin index preview (frontend, required evidence).
  • Illustrative access events admin index preview (frontend, required evidence).
  • Illustrative site lockdown add screen preview (frontend, required evidence).
  • Public access request form (frontend, required evidence).
  • Public gated message (frontend, required evidence).
  • Public request CTA component (frontend, required evidence).

Technical Shape

Section titled “Technical Shape”

Service providers

Section titled “Service providers”
  • Capell\AccessGate\Providers\AccessGateServiceProvider

Config files

Section titled “Config files”
  • packages/access-gate/config/access-gate.php

Migrations

Section titled “Migrations”
  • packages/access-gate/database/migrations/2026_05_10_190838_01_create_access_gate_areas_table.php
  • packages/access-gate/database/migrations/2026_05_10_190838_02_create_access_gate_registrations_table.php
  • packages/access-gate/database/migrations/2026_05_10_190838_03_create_access_gate_grants_table.php
  • packages/access-gate/database/migrations/2026_05_10_190838_04_create_access_gate_claim_tokens_table.php
  • packages/access-gate/database/migrations/2026_05_10_190838_05_create_access_gate_browser_tokens_table.php
  • packages/access-gate/database/migrations/2026_05_10_190838_06_create_access_gate_events_table.php
  • packages/access-gate/database/migrations/2026_06_06_052053_01_create_access_gate_areas_table.php
  • packages/access-gate/database/migrations/2026_06_06_052054_02_create_access_gate_registrations_table.php
  • packages/access-gate/database/migrations/2026_06_06_052055_03_create_access_gate_grants_table.php
  • packages/access-gate/database/migrations/2026_06_06_052056_04_create_access_gate_claim_tokens_table.php
  • packages/access-gate/database/migrations/2026_06_06_052057_05_create_access_gate_browser_tokens_table.php
  • packages/access-gate/database/migrations/2026_06_06_052058_06_create_access_gate_events_table.php
  • packages/access-gate/database/migrations/2026_06_08_101249_add_claim_landing_url_to_access_gate_areas_table.php
  • packages/access-gate/database/migrations/2026_06_14_000001_add_announcement_bar_fields_to_access_gate_areas_table.php
  • packages/access-gate/database/migrations/2026_07_20_000001_create_access_gate_site_access_policies_table.php
  • packages/access-gate/database/migrations/2026_09_29_120000_remove_implicit_timestamp_updates_from_access_gate.php

Models

Section titled “Models”
  • AccessGateModel
  • Area
  • BrowserToken
  • ClaimToken
  • Event
  • Grant
  • Registration
  • SiteAccessPolicy

Filament classes

Section titled “Filament classes”
  • AccessGateSiteSchemaExtender
  • AccessAreaResource
  • CreateAccessArea
  • EditAccessArea
  • ListAccessAreas
  • BrowserTokenResource
  • ListBrowserTokens
  • ClaimTokenResource
  • ListClaimTokens
  • AccessGateEventResource
  • ListAccessGateEvents
  • GrantResource
  • ListGrants
  • ListRegistrations
  • RegistrationResource
  • PendingAccessRequestsFilamentWidget

Route files

Section titled “Route files”
  • packages/access-gate/routes/web.php

Policies

Section titled “Policies”
  • AbstractAccessGateResourcePolicy
  • AccessAreaPolicy
  • AccessGateEventPolicy
  • BrowserTokenPolicy
  • ClaimTokenPolicy
  • GrantPolicy
  • RegistrationPolicy

Extension contracts

Section titled “Extension contracts”
  • AccessRequestMethod
  • AdminNotificationRecipientResolver
  • RegistrationField

Events

Section titled “Events”
  • RegistrationApproved

Listeners

Section titled “Listeners”
  • CopySiteAccessPoliciesOnSiteReplicated
  • NotifyAdminsOfAccessRequest

Actions

Section titled “Actions”
  • ApplySiteAccessPolicySiteSpecAction
  • ApproveNextRegistrationsAction
  • ApproveRegistrationAction
  • AreaIsCurrentlyGatingAction
  • AuthenticateSiteAccessRequestAction
  • BuildAccessGatePrivacyExportAction
  • ConsumeAccessGateClaimTokenAction
  • CreateAccessGateBrowserTokenAction
  • CreateAccessGateClaimTokenAction
  • CreateAccessGateGrantAction
  • CreatePaidAccessCheckoutForRegistrationAction
  • CreateRegistrationAction
  • EnsureAccessGateGrantCanIssueTokenAction
  • EraseAccessGatePrivacyDataAction
  • ExpireRegistrationAction
  • ExportAccessGateAuditCsvAction
  • ExportSiteAccessPolicyShapeAction
  • GetAccessAreaSiteOptionsAction
  • InstallAccessGatePackageAction
  • ListAccessRequestMethodsAction
  • PruneAccessGateRecordsAction
  • RecordEventAction
  • RecordSiteLockdownAttemptAction
  • RegisterAccessGateFrontendRenderHooksAction
  • RegisterAccessGateRateLimitersAction
  • RegisterAccessGateRequestNotificationsAction
  • RejectRegistrationAction
  • ResendAccessGateClaimTokenAction
  • ResolveAccessGateAccessAction
  • ResolveAccessGateAnnouncementBarAction
  • ResolveAccessGateAreaForRequestAction
  • ResolveAccessGatePrivacyRecordIdsAction
  • ResolveEffectiveSiteAccessPolicyAction
  • RevealRecoverableDomainSiteAccessPasswordAction
  • RevealRecoverableSiteAccessPasswordAction
  • RevokeAccessGateBrowserTokenAction
  • RevokeAccessGateBrowserTokenRecordAction
  • RevokeAccessGateGrantAction
  • SendAccessGateApprovedNotificationAction
  • SetupDefaultAccessAreaAction
  • SubmitAccessGatePublicAction
  • UpdateAccessGateApprovalLimitAction
  • UpdateAccessGateAreaStatusAction
  • UpdateSiteAccessPoliciesAction

Data objects

Section titled “Data objects”
  • AccessGateAccessResultData
  • AccessGatePrivacyRecordIdsData
  • AccessRequestMethodData
  • AnnouncementBarData
  • CreatePaidAccessCheckoutData
  • EffectiveSiteAccessPolicyData
  • IssuedAccessGateTokenData
  • PrunedAccessGateRecordsData
  • RegistrationFieldValue

Command signatures

Section titled “Command signatures”
  • capell:access-gate-audit-export
  • capell:access-gate-doctor
  • capell:access-gate-install
  • capell:access-gate-prune
  • capell:access-gate-setup

Manifest action API

Section titled “Manifest action API”
  • install: Capell\AccessGate\Actions\InstallAccessGatePackageAction
  • paidAccessCheckout: Capell\AccessGate\Actions\CreatePaidAccessCheckoutForRegistrationAction
  • paidAccessCheckoutContribution: Capell\AccessGate\Manifest\PaidAccessCheckoutCreationContribution

Console command classes

Section titled “Console command classes”
  • AccessGateAuditExportCommand
  • AccessGateDoctorCommand
  • AccessGateInstallCommand
  • AccessGatePruneCommand
  • AccessGateSetupCommand

Manifest contributions

Section titled “Manifest contributions”
  • admin-resource: Capell\AccessGate\Manifest\AccessAreaResourceContribution
  • admin-resource: Capell\AccessGate\Manifest\AccessGateEventResourceContribution
  • admin-resource: Capell\AccessGate\Manifest\BrowserTokenResourceContribution
  • admin-resource: Capell\AccessGate\Manifest\ClaimTokenResourceContribution
  • admin-resource: Capell\AccessGate\Manifest\GrantResourceContribution
  • admin-resource: Capell\AccessGate\Manifest\RegistrationResourceContribution
  • console-command: Capell\AccessGate\Manifest\AccessGateConsoleCommandsContribution
  • dashboard-widget: Capell\AccessGate\Manifest\PendingAccessRequestsWidgetContribution
  • health-check: Capell\AccessGate\Manifest\AccessGateHealthContribution
  • migration: Capell\AccessGate\Manifest\AccessGateMigrationsContribution
  • model: Capell\AccessGate\Manifest\AccessGateModelsContribution
  • permission: Capell\AccessGate\Manifest\AccessGatePermissionsContribution
  • render-hook: Capell\AccessGate\Manifest\AccessGateRenderHookContribution
  • route: Capell\AccessGate\Manifest\AccessGateRoutesContribution

Health checks

Section titled “Health checks”
  • Capell\AccessGate\Health\AccessGateHealthCheck

Blade views

Section titled “Blade views”
  • packages/access-gate/resources/views/claimed.blade.php
  • packages/access-gate/resources/views/components/announcement-bar.blade.php
  • packages/access-gate/resources/views/components/request-cta.blade.php
  • packages/access-gate/resources/views/message.blade.php
  • packages/access-gate/resources/views/request.blade.php
  • packages/access-gate/resources/views/site-lockdown/unlock.blade.php

Data Model

Section titled “Data Model”
  • Required tables: access_gate_areas, access_gate_registrations, access_gate_grants, access_gate_claim_tokens, access_gate_browser_tokens, access_gate_events, access_gate_site_access_policies.
  • Models: AccessGateModel, Area, BrowserToken, ClaimToken, Event, Grant, Registration, SiteAccessPolicy.
  • Core record references in migrations: sites via site_id, users via user_id.
  • Migration files: 2026_05_10_190838_01_create_access_gate_areas_table.php, 2026_05_10_190838_02_create_access_gate_registrations_table.php, 2026_05_10_190838_03_create_access_gate_grants_table.php, 2026_05_10_190838_04_create_access_gate_claim_tokens_table.php, 2026_05_10_190838_05_create_access_gate_browser_tokens_table.php, 2026_05_10_190838_06_create_access_gate_events_table.php, 2026_06_06_052053_01_create_access_gate_areas_table.php, 2026_06_06_052054_02_create_access_gate_registrations_table.php, 2026_06_06_052055_03_create_access_gate_grants_table.php, 2026_06_06_052056_04_create_access_gate_claim_tokens_table.php, 2026_06_06_052057_05_create_access_gate_browser_tokens_table.php, 2026_06_06_052058_06_create_access_gate_events_table.php, 2026_06_08_101249_add_claim_landing_url_to_access_gate_areas_table.php, 2026_06_14_000001_add_announcement_bar_fields_to_access_gate_areas_table.php, 2026_07_20_000001_create_access_gate_site_access_policies_table.php, 2026_09_29_120000_remove_implicit_timestamp_updates_from_access_gate.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships and null-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core.
  • Admin navigation: declares admin-resource: AccessAreaResourceContribution, admin-resource: AccessGateEventResourceContribution, admin-resource: BrowserTokenResourceContribution, admin-resource: ClaimTokenResourceContribution, admin-resource: GrantResourceContribution, admin-resource: RegistrationResourceContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: dashboard-widget: PendingAccessRequestsWidgetContribution.
  • Permissions: View:Area, Create:Area, Update:Area, Delete:Area, View:Registration, Update:Registration, View:Grant, Update:Grant, View:BrowserToken, Update:BrowserToken, View:ClaimToken, View:Event, ManageSiteAccess:Site; access also governed by package policies: AbstractAccessGateResourcePolicy, AccessAreaPolicy, AccessGateEventPolicy, BrowserTokenPolicy, ClaimTokenPolicy, GrantPolicy, RegistrationPolicy.
  • Public routes: loads routes/web.php; registers AccessGateRoutesContribution.
  • Database changes: package migrations are declared.
  • Config: config/access-gate.php.
  • Settings: no package settings declared.
  • Queues or schedules: none declared.
  • Cache tags: none declared.
  • Commands: capell:access-gate-audit-export, capell:access-gate-doctor, capell:access-gate-install, capell:access-gate-prune, capell:access-gate-setup.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/access-gate.php.
  • Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.

Troubleshooting

Section titled “Troubleshooting”
SymptomLikely causeCheckFix
Package health check reports a problemPackage configuration or runtime dependencies are not readyRun php artisan capell:access-gate-doctorFollow the reported checks, then rerun the doctor command
Package surface is missing after installProvider or manifest is not loadedConfirm capell.json, package composer.json, and provider registrationReinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing tablePackage migrations have not runCheck the tables listed in Data ModelRun host migrations and rerun the focused package test
Route returns unexpected outputRoute cache, middleware, or signed URL setup does not match the package route fileCheck the route files listed in Technical ShapeClear route cache and verify middleware before exposing public routes
Public output leaks unexpected stateRender data, cache variation, or authoring boundary has regressedCheck public Blade, cache tags, and public-output safety testsMove data loading out of Blade and rerun the package public-output tests

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/access-gate.
  2. Run the package setup: php artisan capell:access-gate-install.
  3. Open /access/request/capell-preview and confirm the public output renders without admin state.

Next Steps

Section titled “Next Steps”