ethernick / statamic-activitypub-places
ActivityPub Places, OpenStreetMap Geolocation, and Check-ins for Statamic 5.x and 6.x
Package info
github.com/ethernick/statamic-activitypub-places
Language:Vue
Type:statamic-addon
pkg:composer/ethernick/statamic-activitypub-places
Requires
- php: ^8.2
- ethernick/statamic-activitypub-core: ^0.9 || ^1.0 || dev-main
- statamic/cms: ^5.0 | ^6.0
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Note
Pre-Release:
ActivityPub Places is an early companion addon for statamic-activitypub-core. Free for local development and non-production testing under our Commercial Source-Available License. Available for feedback ahead of official Marketplace publication.
Add rich geographic context, interactive OpenStreetMap location discovery, and federated Arrive check-ins to your Statamic site. ActivityPub Places extends statamic-activitypub-core to seamlessly publish check-ins and location-tagged posts to Mastodon, Pixelfed, and the broader Fediverse.
β¨ Features at a Glance
| Feature | Description |
|---|---|
π Federated Check-Ins (Arrive) |
Broadcast native ActivityStreams Arrive check-in activities across the Fediverse whenever you publish or check in to a place. |
| πΊοΈ OpenStreetMap & Nominatim Search | Search global places, venues, cafes, and landmarks directly from the Statamic Control Panel with live polygon and bounding-box previews. |
| π Interactive Pin Drop & Reverse Geocode | Click anywhere on the map to drop a pin and instantly reverse-geocode coordinates via Nominatim & Overpass. |
| π± Mastodon Compatibility Mode | Automatically syndicate an accompanying Mastodon-compatible Note with markdown deep links to OpenStreetMap for platforms without native Arrive views. |
| π§ Custom Leaflet Antlers Tags | Render interactive Leaflet maps with pins ({{ activitypub_place:map }}) and external map provider links ({{ activitypub_place:links }}) on your frontend. |
| π¬ Interactive Inbox Maps | View incoming location-tagged posts and check-ins with an interactive Leaflet map rendered directly in the Control Panel Inbox stream. |
| β‘ Zero-Bloat Sidecar Storage | GeoJSON coordinates, OSM nodes/ways/relations, and ActivityPub payloads are stored cleanly alongside flat-file entries. |
π Quick Start
1. Require Package via Composer
Install activitypub-places into your Statamic application root:
composer require ethernick/statamic-activitypub-places
2. Run the Interactive Guided Installer
Run the one-step guided installer:
php artisan activitypub:places:install
The installer automatically:
- Provisions the
placescollection and defaultplace.yamlblueprint with OSM identifiers, coordinates, and address fields. - Configures
/places/{osm_type}/{osm_id}nested routing. - Enables Places federation in
settings/activitypub.yaml. - Publishes Control Panel Vue 2 (Statamic 5) and Vue 3 (Statamic 6) assets.
3. Configure Nominatim User-Agent
Open Control Panel > ActivityPub > Settings > Places and provide your application or contact name in the Nominatim User-Agent field to comply with OpenStreetMap's API usage policy.
ποΈ System Architecture
graph LR
subgraph OpenStreetMap [OpenStreetMap Ecosystem]
Nominatim[Nominatim Geocoding API]
Overpass[Overpass API]
OSMTiles[OSM Standard Tiles]
end
subgraph StatamicCP [Statamic Control Panel]
Author[Creator / Editor] -->|Search / Pin Drop| LocSearch[LocationSearch Vue Component]
LocSearch -->|Geocode Request| CPController[PlaceSearchController]
Author -->|New Check-In| CheckInModal[CheckInStack Modal]
end
subgraph CoreEngine [ActivityPub Core Engine]
CheckInModal --> ArriveAct[Create 'Arrive' Activity]
CheckInModal -.->|Compatibility Mode| NoteAct[Create Dual 'Note' + OSM Link]
ArriveAct --> OutboxQueue[(activitypub-outbox)]
end
subgraph Fediverse [Decentralized Fediverse]
OutboxQueue -->|Signed HTTP POST| FediverseServers[Mastodon / Pixelfed / Firefish]
end
CPController <--> Nominatim
CPController <--> Overpass
LocSearch <--> OSMTiles
Loading
π·οΈ Antlers Frontend Tags
Display locations and maps on your public site using the {{ activitypub_place }} Antlers tags:
Interactive Leaflet Map ({{ activitypub_place:map }})
Renders a mobile-responsive Leaflet map centered on the place's coordinates with a customizable marker:
<div class="place-container my-8"> <h1 class="text-3xl font-bold">{{ title }}</h1> <p class="text-gray-600">{{ address }}</p> <!-- Renders responsive Leaflet map (default height: 400px) --> {{ activitypub_place:map }} </div>
Map Provider Directions & Links ({{ activitypub_place:links }})
Generates deep links to popular external navigation providers (OpenStreetMap, Google Maps, Apple Maps):
<div class="directions-links mt-4"> <h3 class="font-semibold text-lg">Open in Maps:</h3> <ul class="flex gap-4"> {{ activitypub_place:links }} <li> <a href="{{ url }}" target="_blank" rel="noopener" class="underline text-blue-600 capitalize"> {{ type }} </a> </li> {{ /activitypub_place:links }} </ul> </div>
πΌοΈ Control Panel Experience
| Places Dashboard & Leaflet Map | OSM Search & Pin Drop Drawer |
|---|---|
![]() |
![]() |
| Federated Check-In Modal | Interactive Inbox Map Feed |
|---|---|
![]() |
![]() |
π Documentation & Guides
- Production Operator & Installation Guide β Requirements, automated setup, tile server tuning, and Nominatim compliance.
- Troubleshooting & Operations Runbook β Resolutions for Nominatim 403s, map container zero-height, and check-in delivery.
- Places Federation & Architecture Guide β Architectural details on
ArrivevsCreate, OSM identifier mapping, and caching. - Extension Developer Guide (HOOKS.md) β How to extend Places, customize transform hooks, and override Antlers templates.
- Marketplace Launch Blueprint β Hero banner specs, screenshot briefs, demo video storyboard, and onboarding copy.
- Product Requirements Document β Discovery history, design decisions, and session changelog.
- Task Roadmap & Release Checklist β Punch-list and milestones.
π€ Community & Support
- Bug Reports & Issues: GitHub Issues
- Source Code: GitHub Repository
- ActivityPub Core: Core Addon Repository
π License
ActivityPub Places for Statamic is source-available software provided under the Statamic Commercial License (free for local development and non-production testing; requires a valid commercial license for live production deployments).
π¦Ύ AI Disclosure
Written with the assistance of AI agents including Gemini & Claude.




