btcpayserver / btcpayserver-doc Goto Github PK
View Code? Open in Web Editor NEWBTCPay Server Official Documentation
Home Page: https://docs.btcpayserver.org
BTCPay Server Official Documentation
Home Page: https://docs.btcpayserver.org
Document accounting in BTCPay:
Unfortunately due to differences in countries/jurisdictions doc can only cover technical and not the legal aspect of accounting in BTCPay.
@JeffVandrewJr if you at any point want to tackle any of these before I do, just let me know. Leaving this on a to-do so that anyone can tackle it in the meanwhile.
I found a way to leave all docs intact on GitHub, but have a good structure on GitBook
We need to create summary.md and manually add the structure, if GitBook recognizes that a repo has a summary.md it will structure the docs that way and ignore folders.
Providing a summary is optional. If you don't specify a summary, and GitBook does not find a SUMMARY.md file at the root of your docs, GitBook will infer the table of contents from the folder structure and the Markdown files below. (
https://docs.gitbook.com/integrations/github/content-configuration#summary
)
This document that should cover concisely describe the the features and functions of UI found in BTCPay Server. It should be added into ''Getting Started" Section.
The goal of the document is to introduce users to all the settings and features and explain them concisely.
Server settings
Stores
Apps
Wallets
Invoices
My Settings
Video that explains how to create and customize PoS app in BTCPay.
Does this issue effect btcpayserver? The BitPay Copay wallet was/is vulnerable.
dominictarr/event-stream#116
Is the BitPay Payouts API supported by BTCPayServer? Specifically, this functionality:
https://bitpay.com/api#resource-Payouts
I can’t find the documentation for the REST api of BTCPayServer, so I’m assuming it’s an exact match?
Thanks for the help!
Make a video that will teach people how to create and embed donation buttons on their website with BTCPay.
It's very important to have a document in > Deployment section which will describe how a user can:
If @ketominer and @normandmickey or anyone else can help with documenting this that would be great.
Docker repo has amazing documentation.
I think we need somehow to clone that repo into doc repo and then add that to GitBook section > Development.
I have setup this extension but it does not seem to to pair with Btcpayserver using Magento 2.2.6
I think we should document differences between self-hosting and third-party hosting more in depth and include possible pros and cons together with attach vectors.
Related
While we can't protect users who use third-party hosts from potentially malicious hosts, we can educate them on potential attack vectors and pros/cons of using third-party hosts in general.
Of course, this is by no means attack on third-party hosts, I think they are one of the most important part of the ecosystem in adoption, we just need to explain the trade-offs better.
I'm not even sure where this can be put. @britttttk any ideas?
Troubleshooting md needs to be updated with BTCPay and Bitcoin Core logs once this PR is merged
It's obvious that in order to solve the issue for the users, we need to educate them towards steps they need to do in order to troubleshoot their instance.
There are people who don't know how to SSH login and find logs, so we need to cover that.
I was thinking that we need to create a document that will guide the user step by step on how to properly define the issue, try to solve it and if that fails, how to ask for help and where.
This should include an explanation on how to pull the logs from different directories. Since my knowledge on this is not the best, I may require some assistance from the devs.
The document can include technical issues from the FAQ.
We need to document that 503 and SSL errors a bit better somewhere and explain clearly why it happens when it happens and how to fix it.
@NicolasDorier help with this is appreciated
Requesting support for ERC20 coins such as USDC and DAI. DAI is currently supported on the Dappos App, can it be replicated here? https://github.com/Dappos/Dappos
Proposal to add a general deployment document: Deployment.md
Reference to #87
Although someone has forked it and listed it as an option, the fork doesn't appear to contain even a simple search and replace to change bitpay to btcpayserver. Additionally, there is no issue tracker enabled on this fork. It would be nice to see at least one commit on this "fork". It's basically useless right now -- it's 6 commits behind and 0 ahead of the original... and not even a document suggesting what the purpose of it is.
Currently the derivation scheme settings are not very clear. I am familiar with the different types of HD wallets, but no derivation path I use as input seems to be valid. I've tried xpub
like in the table, and m/44'/0'/0'/0
which is the BIP44 scheme. I'm sure this works for Ledger, but I can't quite figure out what to do in the text field.
Also, there is no Check ExtPubKey
(on a Ledger only?)
Ah I see now - BTCPay format memo
is a table where you insert your xpub(s) instead of the token xpub
(or xpub1
or xpub2
) - and it gives you a followup prompt to confirm addresses.
I think it would be good to have a guide / link to information about generating an offline xprv/xpub, even if they dont have a Ledger
I saw that someone wrote the article on how to deploy BTCPay Srever on Linux manually.
We should find the place for it. Should we just put a link to it on manual deployment
It's a great guide and should to be added.
As we develop more options for implementing BTCPayServer, I think it could be helpful for new users to have a way to determine which solution is best for them. Lately people have been asking questions in the Slack where they are using multiple tutorials at once that can't be used together.
I was thinking we could create an infographic decision tree that shows which deployment methods will be best suited for the user depending on their needs and links? to skip to different parts in the process. If any one has ideas about how to organize the info, feel free to change/add. Since developers can make these decisions on their own, I think it should be more Newbie friendly...
Some of these could be:
-You need to build a website
-You already have a website
-You care about price / hosting Providers
-You want to use a 3rd Party BTCPay Host
-You want to make a simple donation page
-Hardware deployment options
-You want developer capability / manual builds
-You want to use the Lightning Network
Not sure if it will look good or if it's doable, but I'm gonna give this one a try. Leaving it here as a reminder.
We need to create a file where we can dump all of BTCPay logos, infographics and graphic design work, so that merchants,media and other members who want to advertise and spread the word can can use it.
Imho /img is a bit to crowded, but we can create a subfolder inside /img as /graphics or /logos /branding or whatever you guys want us to call that folder, ideas welcome.
Create some sort of quick start guide that can be easily printed out and handed to people at conferences.
Emphasizing the basic concept, features, integrations, pros, etc.
Where can i write the configuration of database server?
Right now we have lots of good information scattered around and it would be a good idea to consolidate and categorize them.
My suggestion is to have three types of documents:
The 3. document will potentially take time and we'll need to think of the "categories" for the issues. The easiest is to just take a look at NBitstack Wiki and try to group similar issues.
Thoughts?
One more deployment method should be added to the docs - BTCPayServer Google Cloud. - GoogleCloudDeployment.md
After that is done, we need to update:
I haven't seen much instructions on how to use Magento integration with BTCPay.
It would be handy if users using this integration can help with writing a concise document on how to install and configure Magento BTCPay plugin.
Leaving this as a public promise that I'll do a video series once Lightning Network Apps aka lapps are integrated.
Plan is to record an introductory video explaining lapps, how they work in BTCPay and then do short setup video and explanation for each of the lapps.
Proposal to add 2 new documents : Translation.md and Contribute.md inside the Contribute folder.
There are many non tech-savvy users who want to contribute to BTCPay but they just don't know how.
Currently it's only possible to translate the checkout. Until we figure out the system how to do handle front-end translations, I believe it would be beneficial to create Translation.md and teach these users how to help with translations step by step.
## Contribute.md
Build on this and expand to other use-cases.
How can I contribute to BTCPay? The easiest way is to use the software for your business, provide feedback and report any bugs or issues you or your customers encounter. Translating BTCPay, helping us with documentation are also ways in which you can help, even if you're not a developer or tech-savvy.
Docs main page, the readme, needs to be worked on a bit. Let's talk about the structure of it. It should provide easy to understand information and links to everything important in docs.
I like how Bisq handles their docs, the structure of the intro is:
What it is
Why it exists
How it works
In a nutshell
How is it different
How it keeps funds secure
How it keeps data private
How it resists censorship
It requires minor cleanup and adding clarity and making navigation easier.
Create documentation to help merchants troubleshoot common user experience issues during the checkout/payment process and how to solve them. The information should also be available (possibly infographic) for merchants to print and keep on hand for quick employee reference in physical stores where POS is used.
Explain customer payment issues such as:
MERCHANT FEEDBACK & INPUT IS REQUESTED in order to make this document. Please comment any customer payment issues and questions commonly experienced during checkout process.
(Related to: #433 & #434)
Documentation needs to be categorized and put in folders for it to appear in a structured way on GitBook. This can mess the structure of the links/images, but it's a necessary step toward better-organized resources. This change will be applied when the new user influx calms down, as we don't want to break links for the new users possibly.
While folders are no longer a necessity, we still need a structure for #51
The proposed structure is just a start and tries to use already created documentation.
Feel free to make suggestions and kudos to @BobleChinois for helping out with the structure.
Proposal to document possible use-cases of BTCPay.
A good starting point is this
Who can use BTCPay?
Add heading for each category of users and explain concisely what problem BTCPay solves for them and what tools are available. Clearly emphasizing advantages over other tools.
Dear BTCPay maintainers,
I have been tasked with setting up a standalone BTCPay server. I chose to do it under Linux, with .Net Core 2.0.2 and Postgres.
I am slightly confused as to the benefits of such an installation. It looks like my client wants to use the features listed in:
https://btcpay-server-testnet.azurewebsites.net/
In that case, I am slightly confused as to the setup procedure for Linux. I am following the steps given for "local development", and would like any clarification you could provide.
Perhaps:
And a docs section about the Theme part of the settings
Create a "what is BTCPay video" animated.
Video can be embedded at the front page.
Think of a concise storyline.
Ideas welcome.
I remember @NicolasDorier had an idea of having a chart comparing different payment processors to BTCPay.
I think it can be really helpful to have such a document for the upcoming users. The biggest problem is figuring out what to compare and what features to include.
If anyone has an idea or wants to tackle this, feel free to comment.
Record a video that will show people how to use LN. We now have a technical video, but there are no videos beyond installation. I'd like to show users how to use Zap and maybe even c-lightning command line, but in two separate videos.
Explain wallet re-scan and add it to
In Getting-Started.md , the link for testnet website is outdated.
Document drupal integration on https://github.com/btcpayserver/btcpayserver-doc/blob/master/Integration.md ping @ndeet .
Will also try drupal myself a bit later.
Allow anyone to create invoice
You should enable this option if you want to enable users to create invoices themselves. This option is only useful if you're using POS App or the payment button.
Maybe something like this:
Allow registered users of your store (store - settings - users) to create invoices themselves.
On top of that, this option needs to be enabled if you will be using the payment button or generating invoices through third party HTML or API. POS app does not need this enabled as it is preauthorised.
something like that maybe would be more clear
to-do:
Hi Guys,
Is there a recommended set up if I want high availability / clustering?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.