Contact and contributing page

This commit is contained in:
binwiederhier
2026-01-02 07:59:02 -05:00
parent 4ce9508fd3
commit eca1ed4d8d
9 changed files with 137 additions and 19 deletions

View File

@@ -6,5 +6,7 @@ As of today, I only support the latest version of ntfy. Please make sure you sta
## Reporting a Vulnerability ## Reporting a Vulnerability
Please report severe security issues privately via ntfy@heckel.io, [Discord](https://discord.gg/cT7ECsZj9w), Please report security vulnerabilities privately via email to [security@mail.ntfy.sh](mailto:security@mail.ntfy.sh).
or [Matrix](https://matrix.to/#/#ntfy:matrix.org) (my username is `binwiederhier`).
You can also reach me on [Discord](https://discord.gg/cT7ECsZj9w) or [Matrix](https://matrix.to/#/#ntfy:matrix.org)
(my username is `binwiederhier`).

View File

@@ -1013,7 +1013,7 @@ or the root domain:
=== "caddy" === "caddy"
``` ```
# Note that this config is most certainly incomplete. Please help out and let me know what's missing # Note that this config is most certainly incomplete. Please help out and let me know what's missing
# via Discord/Matrix or in a GitHub issue. # via the contact page (https://ntfy.sh/docs/contact/) or in a GitHub issue.
# Note: Caddy automatically handles both HTTP and WebSockets with reverse_proxy # Note: Caddy automatically handles both HTTP and WebSockets with reverse_proxy
ntfy.sh, http://nfty.sh { ntfy.sh, http://nfty.sh {
@@ -1034,7 +1034,7 @@ or the root domain:
``` kdl ``` kdl
// /etc/ferron.kdl // /etc/ferron.kdl
// Note that this config is most certainly incomplete. Please help out and let me know what's missing // Note that this config is most certainly incomplete. Please help out and let me know what's missing
// via Discord/Matrix or in a GitHub issue. // via the contact page (https://ntfy.sh/docs/contact/) or in a GitHub issue.
// Note: Ferron automatically handles both HTTP and WebSockets with proxy // Note: Ferron automatically handles both HTTP and WebSockets with proxy
ntfy.sh { ntfy.sh {

68
docs/contact.md Normal file
View File

@@ -0,0 +1,68 @@
# Contact
This service is run by **Philipp C. Heckel**. There are several ways to get in touch with me and the
ntfy community. Please choose the appropriate channel based on your needs.
## Community support (free)
For general questions, feature discussions, and community help, please use one of these public channels:
| Channel | Link | Description |
|---------|------|-------------|
| **Discord** | [discord.gg/cT7ECsZj9w](https://discord.gg/cT7ECsZj9w) | Real-time chat with the community (I'm `binwiederhier`) |
| **Matrix** | [#ntfy:matrix.org](https://matrix.to/#/#ntfy:matrix.org) | Bridged from Discord, same community (I'm `binwiederhier`) |
| **Matrix Space** | [#ntfy-space:matrix.org](https://matrix.to/#/#ntfy-space:matrix.org) | Matrix space with all ntfy rooms |
| **Lemmy** | [discuss.ntfy.sh/c/ntfy](https://discuss.ntfy.sh/c/ntfy) | Forum-style discussions |
| **GitHub Issues** | [github.com/binwiederhier/ntfy/issues](https://github.com/binwiederhier/ntfy/issues) | Bug reports and feature requests |
!!! info "Why public channels?"
Answering questions in public channels benefits the entire community. Other users can learn from the
discussion, and answers can be referenced later. This is much more scalable than 1-on-1 support.
## Paid support (ntfy Pro subscribers)
If you are subscribed to a [ntfy Pro](https://ntfy.sh/#pricing) plan, you are entitled to priority support
via the following channels:
| Channel | Contact | Description |
|---------|---------|-------------|
| **Discord/Matrix** | Mention your Pro status | Priority responses in community channels |
| **Email** | [support@mail.ntfy.sh](mailto:support@mail.ntfy.sh) | Direct email support for Pro subscribers |
Please include your ntfy.sh username when contacting support so we can verify your subscription status.
## Specific inquiries
### Privacy inquiries
For questions about our [privacy policy](privacy.md), data handling, or to exercise your data rights
(access, deletion, etc.):
- **Email**: [privacy@mail.ntfy.sh](mailto:privacy@mail.ntfy.sh)
### General inquiries
For business inquiries, partnerships, press, or other general questions that don't fit the categories above:
- **Email**: [contact@mail.ntfy.sh](mailto:contact@mail.ntfy.sh)
### Security issues
If you discover a security vulnerability, please report it responsibly:
- **Email**: [security@mail.ntfy.sh](mailto:security@mail.ntfy.sh)
See also: [SECURITY.md](https://github.com/binwiederhier/ntfy/blob/main/SECURITY.md)
## Announcements
Stay up to date with ntfy news and releases:
- **ntfy topic**: Subscribe to [ntfy.sh/announcements](https://ntfy.sh/announcements) for release announcements
- **GitHub Releases**: [github.com/binwiederhier/ntfy/releases](https://github.com/binwiederhier/ntfy/releases)
- **iOS TestFlight**: [Join TestFlight](https://testflight.apple.com/join/P1fFnAm9) for iOS beta testing
## Contributing
Want to contribute to ntfy? See the [contributing page](contributing.md) for details on how to help with
code, translations, documentation, or donations.

51
docs/contributing.md Normal file
View File

@@ -0,0 +1,51 @@
# Contributing
Thank you for your interest in contributing to ntfy! There are many ways to help, whether you're a developer,
translator, or just an enthusiastic user.
## Code contributions
If you'd like to contribute code to ntfy:
1. Check out the [development guide](develop.md) to set up your environment
2. Look at [open issues](https://github.com/binwiederhier/ntfy/issues) for ideas, or propose your own
3. For larger features or architectural changes, please reach out on [Discord/Matrix](contact.md) first to discuss
before investing significant time
4. Submit a pull request on GitHub
All contributions are welcome, from small bug fixes to major features.
## Translations
Help make ntfy accessible to users around the world! We use Hosted Weblate for translations:
- **Weblate**: [hosted.weblate.org/projects/ntfy](https://hosted.weblate.org/projects/ntfy/)
You can start translating immediately without any coding knowledge.
## Documentation
Found a typo? Want to improve the docs? Documentation contributions are very welcome:
- Edit any page directly on GitHub using the edit button
- Submit a pull request with your improvements
## Bug reports and feature requests
- **GitHub Issues**: [github.com/binwiederhier/ntfy/issues](https://github.com/binwiederhier/ntfy/issues)
Please search existing issues before creating a new one to avoid duplicates.
## Donations
If you'd like to support ntfy financially, donations are gratefully accepted:
- **GitHub Sponsors**: [github.com/sponsors/binwiederhier](https://github.com/sponsors/binwiederhier)
Your support helps cover server costs and development time. Even small donations are very much appreciated!
## Code of Conduct
Please be respectful and constructive in all interactions. See the
[Code of Conduct](https://github.com/binwiederhier/ntfy/blob/main/CODE_OF_CONDUCT.md) for details.

View File

@@ -2,7 +2,7 @@
Hurray 🥳 🎉, you are interested in writing code for ntfy! **That's awesome.** 😎 Hurray 🥳 🎉, you are interested in writing code for ntfy! **That's awesome.** 😎
I tried my very best to write up detailed instructions, but if at any point in time you run into issues, don't I tried my very best to write up detailed instructions, but if at any point in time you run into issues, don't
hesitate to **contact me on [Discord](https://discord.gg/cT7ECsZj9w) or [Matrix](https://matrix.to/#/#ntfy:matrix.org)**. hesitate to reach out via one of the channels listed on the [contact page](contact.md).
## ntfy server ## ntfy server
The ntfy server source code is available [on GitHub](https://github.com/binwiederhier/ntfy). The codebase for the The ntfy server source code is available [on GitHub](https://github.com/binwiederhier/ntfy). The codebase for the

View File

@@ -94,11 +94,11 @@ I would be humbled if you helped me carry the server and developer account costs
appreciated. appreciated.
## Can I email you? Can I DM you on Discord/Matrix? ## Can I email you? Can I DM you on Discord/Matrix?
While I love chatting on [Discord](https://discord.gg/cT7ECsZj9w), [Matrix](https://matrix.to/#/#ntfy-space:matrix.org), For community support, please use the public channels listed on the [contact page](contact.md). I generally
[Lemmy](https://discuss.ntfy.sh/c/ntfy), or [GitHub](https://github.com/binwiederhier/ntfy/issues), I generally **do not respond to direct messages** about ntfy, unless you are paying for a [ntfy Pro](https://ntfy.sh/#pricing)
**do not respond to emails about ntfy or direct messages** about ntfy, unless you are paying for a plan (see [paid support](contact.md#paid-support-ntfy-pro-subscribers)), or you are inquiring about business
[ntfy Pro](https://ntfy.sh/#pricing) plan, or you are inquiring about business opportunities. opportunities (see [general inquiries](contact.md#general-inquiries)).
I am sorry, but answering individual questions about ntfy on a 1-on-1 basis is not scalable. Answering your questions I am sorry, but answering individual questions about ntfy on a 1-on-1 basis is not scalable. Answering your questions
in the above-mentioned forums benefits others, since I can link to the discussion at a later point in time, or other users in public forums benefits others, since I can link to the discussion at a later point in time, or other users
may be able to help out. I hope you understand. may be able to help out. I hope you understand.

View File

@@ -189,11 +189,6 @@ For significant changes, we may provide additional notice on Discord/Matrix or t
## Contact ## Contact
If you have questions about this privacy policy or our data practices, you can reach us: For privacy-related inquiries, please email [privacy@mail.ntfy.sh](mailto:privacy@mail.ntfy.sh).
- **GitHub Issues**: [github.com/binwiederhier/ntfy/issues](https://github.com/binwiederhier/ntfy/issues) For all other contact options, see the [contact page](contact.md).
- **Discord**: [discord.gg/cT7ECsZj9w](https://discord.gg/cT7ECsZj9w)
- **Matrix**: [#ntfy:matrix.org](https://matrix.to/#/#ntfy:matrix.org)
- **Email**: [privacy@mail.ntfy.sh](mailto:privacy@mail.ntfy.sh)
For more information about ntfy, visit [ntfy.sh](https://ntfy.sh).

View File

@@ -1,7 +1,7 @@
# Troubleshooting # Troubleshooting
This page lists a few suggestions of what to do when things don't work as expected. This is not a complete list. This page lists a few suggestions of what to do when things don't work as expected. This is not a complete list.
If this page does not help, feel free to drop by the [Discord](https://discord.gg/cT7ECsZj9w) or [Matrix](https://matrix.to/#/#ntfy:matrix.org) If this page does not help, feel free to reach out via one of the channels listed on the [contact page](contact.md).
and ask there. We're happy to help. We're happy to help.
## ntfy server ## ntfy server
If you host your own ntfy server, and you're having issues with any component, it is always helpful to enable debugging/tracing If you host your own ntfy server, and you're having issues with any component, it is always helpful to enable debugging/tracing

View File

@@ -99,6 +99,8 @@ nav:
- "Known issues": known-issues.md - "Known issues": known-issues.md
- "Deprecation notices": deprecations.md - "Deprecation notices": deprecations.md
- "Development": develop.md - "Development": develop.md
- "Contributing": contributing.md
- "Privacy policy": privacy.md - "Privacy policy": privacy.md
- "Contact": contact.md