Getting Started Guidelines. Read this if you're new around here🚀

[pavlenex]

Hello and welcome to BTCPay Server GitHub community 👋
This guide should help you get started and explain our processes around here.

Help and Support

BTCPay Server is a free and open-source software. Contributors around the internet help in their spare time, so please try to be considerate of others time when asking a question.

In case you have a question, face an issue or need a support here are some good resources:

• Official documentation - contains answers to commonly asked questions and provides instructions for almost everything. You're most likely to find what you're looking for here by using a search function there.
• Frequently Asked Question - a list of all questions a beginner may have.
• Official Website - gives a concise information on what BTCPay Server is and how it works.
• Official YouTube - contains a lot of video tutorials
• Community Official Mattermost Chat - where community hangs around. Good place to get real-time assistance.
• Telegram Group - informal community-maintained place to chit-chat in real time

Reporting an issue

If you've fund a bug in software, please open an issue and fill in as much details as you can. The better you explain the issue, the faster we can work on resolving it. Please don't open an issue unless it's a bug report or verified technical problem that needs to be resolved.

If you have a question or need technical support, please use resources in Help and Support section above.

Developers

• The original BTCPay Server API is compatible for the most part with BitPay's API. Be aware it's now considered legacy, but will be maintained.
• In 2020 we launched a new API - Greenfield API. This new API will co-exist with the original API and allow full usage of all BTCPay Server features, without requiring the UI. You can view the current Greenfield API documentation

Difference between issues and discussions

We use discussions to:

• Suggest features
• Ask questions and get technical support

We use issues to:

• Report bugs and problems
• List features that have contributors consensus