Documentation
Learn how to use ntfyme
ntfyme offers a range of advanced features, such as:
- Adding one (free) or more (pro) server configs 💻
- Sending custom messages to multiple topics in one simple send over HTTPS without leaving the page 📤
- Automatically adding the current tab's URL in the message 🔗
- Sending file links/attachments 📁
- Emails (requires SMTP server config via ntfy instance) 📬
- In-depth browser notifications (displaying file image uploads, action buttons, custom click behavior, etc.) over SSE connections 🔄
- A full selection of themes (full access with pro) 🚀
- Dedicated messages page to retrieve cached topic messages 💬
- Extension access lock 🔐
- Encryption (for user configs and settings in local and sync storage) 🔒
- Browser badge indicators for locked and/or notification count 🔔
- Keyboard shortcuts ⌨️
- and more to come! ✅
Features
Navbar
| Feature | Description | Tier | Demo |
|---|---|---|---|
| ntfyme Logo | Opens the extension in a new tab. | Free | |
| Lock Toggle | Locks the extension with the passphrase used during initial setup (auto-locks after 1 hour of inactivity). | Free | |
| Mark Notifications as Read | Clears notifications from the browser system and badge counter. | Free | |
| Back Arrow | Navigates back to the previous route. | Free | |
| Forward Arrow | Navigates forward in the route history. | Free | |
| Menu Toggle | Shows all pages/routes (message box, settings, messages, pro, changelog). | Free |
Message Box
| Feature | Description | Tier | Demo |
|---|---|---|---|
| Message Box | Send messages easily from your current tab. | Free Tier: Priority, Tags, Title Pro Tier: Full options |
Message Box DemoPopup: |
| Send | Sends the current message (hover for shortcut). | Free | |
| Clear | Clears the message only (hover for shortcut). | Free | |
| Defaults | Resets the message and options to configured defaults (hover for shortcut). | Free | |
| Reset All | Resets the entire form as a blank slate (hover for shortcut). | Free | |
| Publishable Topics | Send message to multiple topics. | Free: Up to 6 topics Pro: Unlimited topics |
|
| Priority Slider | Set message priority (1-5). | Free | |
| Tags | Add emoji and/or custom tags. | Pro | |
| Title | Add a custom title to your notification. | Free | |
| Send message to an email (requires SMTP config). | Pro | ||
| Delay | Add a delay to your message (e.g., 10sec, 30min, 2h, 3d). | Pro | |
| Click URL | Customize notification click behavior. | Pro | |
| Icon URL | Customize notification icon via URL. | Pro | |
| File URL | Attach a file via URL (image, document, etc.). | Pro | |
| Custom Filename | Customize filename for the attachment. | Pro | |
| File Attachment | Add a local file attachment (caching must be enabled). | Pro | |
| Enable Caching | Caches the message to the ntfy server. | Free: True Pro: True/False |
|
| Enable Markdown | Add markdown formatting to the message. | Pro | |
| Enable Firebase | Enables Firebase for notifications (mobile/requires server setup). | Pro | |
| Actions | Add custom ntfy actions/triggers to messages/notifications. | Pro |
Settings / Config
| Feature | Description | Tier | Demo |
|---|---|---|---|
| Settings | General settings and configurations. | Settings Demo |
|
| Topics | Multi Topic subscribe / publish. | Free: Up to 6 topics Pro: Unlimited topics |
Topics Demo |
| Themes | Wide range of themes to choose from. | Free: Dark & Light themes Pro: All themes |
Themes Demo |
| Profiles | Multiple profiles for different servers/instances. | Free: 1 profile Pro: Unlimited profiles |
Profiles Demo |
Notifications
Never miss a notification with instant in-depth notifications via SSE connections
| Feature | Description | Tier | Demo |
|---|---|---|---|
| Notifications | Instant, in-depth notifications via SSE connections. | Notifications Demo |
|
| Notification Actions | Trigger actions within your notifications. | Pro | Notification Actions Demo |
| Notification Badges | Notification badges on the extension, cleared from the nav. Badge counter tied to browser notifications. Clearing notifications removes them from browser/system. |
Notification Badges Demo |
Messages Page
| Feature | Description | Tier | Demo |
|---|---|---|---|
| Messages Page | Pull, read, and review cached ntfy notifications within the extension. | Free: One profile Pro: Multiple profiles |
Messages Page Demo |
| Message Options - Refresh Button | Retrieves all cached topics for the current topic only. | ||
| Message Options - Poll All Active Topics | Retrieves all cached topics for the current profile. | ||
| Message Options - Delete Topic Messages | Deletes messages for the current topic (local storage). | ||
| Message Options - Delete Profile Messages | Deletes all messages for all topics in the current profile (local storage). | ||
| Message Options - Delete All Messages | Deletes all messages for all profiles (local storage). |