{"id":48123420,"url":"https://github.com/chesnotech/osticket-push-notifications","last_synced_at":"2026-06-01T16:00:46.661Z","repository":{"id":347525818,"uuid":"1194351331","full_name":"ChesnoTech/osTicket-push-notifications","owner":"ChesnoTech","description":"Web Push (PWA) notifications plugin for osTicket staff panel with per-agent preferences","archived":false,"fork":false,"pushed_at":"2026-05-26T21:35:55.000Z","size":4325,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-26T23:25:11.327Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ChesnoTech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-28T08:29:17.000Z","updated_at":"2026-05-26T21:35:57.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ChesnoTech/osTicket-push-notifications","commit_stats":null,"previous_names":["chesnotech/osticket-push-notifications"],"tags_count":191,"template":false,"template_full_name":null,"purl":"pkg:github/ChesnoTech/osTicket-push-notifications","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChesnoTech%2FosTicket-push-notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChesnoTech%2FosTicket-push-notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChesnoTech%2FosTicket-push-notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChesnoTech%2FosTicket-push-notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChesnoTech","download_url":"https://codeload.github.com/ChesnoTech/osTicket-push-notifications/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChesnoTech%2FosTicket-push-notifications/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33782317,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-04T16:22:31.846Z","updated_at":"2026-06-01T16:00:46.655Z","avatar_url":"https://github.com/ChesnoTech.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"🌐 **English** | [Русский](docs/README.ru.md) | [العربية](docs/README.ar.md) | [Español](docs/README.es.md) | [Français](docs/README.fr.md) | [Deutsch](docs/README.de.md) | [中文](docs/README.zh.md) | [Português](docs/README.pt.md) | [Türkçe](docs/README.tr.md)\n\n# osTicket Push Notifications Plugin\n\nWeb Push (PWA) notifications for osTicket staff panel. Delivers real-time browser push notifications for ticket events, completely independent from email alerts.\n\n## Features\n\n- **Real-time push notifications** for: new tickets, new messages/replies, assignments, transfers, overdue tickets\n- **Independent from email alerts** — works even when all email alerts are disabled\n- **Agent preferences** with per-event toggles, per-department filtering, and quiet hours\n- **Admin controls** with master switch, per-event toggles, custom notification icon, and VAPID key management\n- **Multi-language support** using osTicket's built-in translation system\n- **Mobile responsive** with bell + gear icons in mobile nav bar\n- **Dark mode** compatible (osTicketAwesome theme)\n- **Service Worker** based — works even when the browser tab is closed\n- **Zero dependencies** — pure PHP Web Push implementation, no Composer required\n\n## Requirements\n\n- osTicket **1.18+**\n- PHP **8.0+** with `openssl` extension (for VAPID key generation and payload encryption)\n- HTTPS (required by Web Push API)\n\n## Installation\n\n1. Copy the `push-notifications/` folder to `include/plugins/`\n2. In Admin Panel, go to **Manage \u003e Plugins \u003e Add New Plugin**\n3. Click **Install** next to \"Push Notifications\"\n4. Set Status to **Active** and save\n5. Go to **Instances** tab, click **Add New Instance**\n6. Set instance name, status to **Enabled**\n7. In the **Config** tab:\n   - Enter a VAPID Subject (e.g., `mailto:admin@example.com`)\n   - Check **Enable Push Notifications**\n   - Enable desired alert types\n   - Optionally set a custom Notification Icon URL\n   - Save — VAPID keys are auto-generated\n\n## How It Works\n\n### Admin Configuration (Admin Panel \u003e Plugins \u003e Push Notifications)\n\n| Setting | Description |\n|---|---|\n| Enable Push Notifications | Master on/off switch |\n| VAPID Subject | Contact email for push service identification |\n| VAPID Keys | Auto-generated on first save |\n| New Ticket / Message / Assignment / Transfer / Overdue Alerts | Per-event global toggles |\n| Notification Icon URL | Custom icon/logo for push notifications (leave empty for default) |\n\n### Agent Preferences (Gear icon next to bell in nav bar)\n\nEach agent can customize their own notification preferences:\n\n| Setting | Description |\n|---|---|\n| Event toggles | Choose which event types trigger push notifications |\n| Department filter | Only receive notifications from selected departments |\n| Quiet hours | Suppress notifications during a time range (supports overnight spans) |\n\n### Notification Flow\n\n```\nPlugin master switch ON?\n  └─ Plugin event toggle ON? (e.g., alert_new_ticket)\n      └─ Agent has push subscription?\n          └─ Agent event preference ON?\n              └─ Ticket dept in agent's dept filter? (empty = all)\n                  └─ Not in agent's quiet hours?\n                      └─ SEND PUSH ✓\n```\n\n\u003e **Note:** Push notifications are completely independent from osTicket's email alert settings. You can disable all email alerts and push will continue working.\n\n## Architecture\n\n| File | Purpose |\n|---|---|\n| `plugin.php` | Plugin manifest (id, version, name) |\n| `config.php` | Admin config fields + VAPID key generation + DB table creation |\n| `class.PushNotificationsPlugin.php` | Bootstrap, signal hooks, AJAX routes, asset injection |\n| `class.PushNotificationsAjax.php` | AJAX controller (subscribe, unsubscribe, preferences, test) |\n| `class.PushDispatcher.php` | Notification dispatch with recipient logic + preferences filtering |\n| `class.WebPush.php` | Pure PHP Web Push sender (VAPID + ECDH + AES-128-GCM, no Composer) |\n| `assets/push-notifications.js` | Client-side bell/gear UI, preferences modal, service worker registration |\n| `assets/push-notifications.css` | Styles for nav icons, modal, toggles, dark mode |\n| `assets/sw.js` | Service worker for receiving and displaying push notifications |\n\n## Database Tables\n\nThe plugin creates two tables on first config save:\n\n- `ost_push_subscription` — stores browser push subscription endpoints per agent\n- `ost_push_preferences` — stores per-agent notification preferences\n\n## Auto-updater on private repos (v2.16.0+)\n\nIf the plugin's GitHub repository is private, the Update Manager needs a GitHub Personal Access Token (PAT) to fetch releases. Without one, every `/scp/ajax.php/push-notifications/update-check` call returns HTTP 404 and `update-apply` reports \"Release not found on GitHub\".\n\n**Quick setup:**\n\n1. Create a fine-grained PAT at \u003chttps://github.com/settings/personal-access-tokens/new\u003e with `Contents: read` scoped to the plugin repo only.\n2. Paste it into **Admin → Manage → Plugins → Push Notifications → [instance] → GitHub Personal Access Token (optional)**. Save.\n3. Click **Check for updates**. The Update Manager now authenticates to GitHub on your behalf.\n\nPublic-repo deployments leave this field empty — behavior is identical to v2.15.x.\n\nFull walkthrough: [docs/pat-setup.md](docs/pat-setup.md).\n\n## Author\n\nChesnoTech\n\n## License\n\nGPL-2.0 (same as osTicket)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchesnotech%2Fosticket-push-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchesnotech%2Fosticket-push-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchesnotech%2Fosticket-push-notifications/lists"}