Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Correct some typos in docs/Development/README.md #1328

Merged
merged 2 commits into from
Sep 1, 2023
Merged

Correct some typos in docs/Development/README.md #1328

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd92bae
Correct some typos in docs/Development/README.md
ai-oleynikov Aug 31, 2023
2f7b38d
Apply suggestions from code review
dennisreimann Sep 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions docs/Development/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Architecture

BTCPayServer is a project which ties together **several Bitcoin-related components** into a coherent user experience for installing and managing your own payment processor.
BTCPay Server is a project which ties together **several Bitcoin-related components** into a coherent user experience for installing and managing your own payment processor.

![Architecture](../img/Architecture.png)

The minimal setup involves:

- [BTCPayServer](https://github.com/btcpayserver/btcpayserver)
- [BTCPay Server](https://github.com/btcpayserver/btcpayserver)
- [NBXplorer](https://github.com/dgarage/NBXplorer) (Lightweight block explorer, responsible for tracking payments)
- Bitcoin Core
- (Optional) PostgreSQL

By default, it uses SqlLite, but all production deployments use Postgres.
- PostgreSQL

Additionally, if you need Lightning Network access, NBXplorer supports connections to:

Expand All @@ -24,7 +22,7 @@ Video below shows **BTCPay Architecture** in-depth.

---

We provide several ways of deploying BTCPayServer, depending on whether you favor flexibility or ease-of-use.
We provide several ways of deploying BTCPay Server, depending on whether you favor flexibility or ease-of-use.

From the easiest way to the hardest:

Expand All @@ -33,6 +31,6 @@ From the easiest way to the hardest:
- [Docker deployment](https://docs.btcpayserver.org/Docker/) (Using a `docker-compose.yml` file which bundle all the dependencies together, in almost any environment)
- [Manual deployment](/Deployment/ManualDeployment.md) (Downloading, building and running all the dependencies by yourself)

Some community members also offer [third-party hosting](/Deployment/ThirdPartyHosting.md) (Having someone else manage BTCPayServer for you).
Some community members also offer [third-party hosting](/Deployment/ThirdPartyHosting.md) (Having someone else manage BTCPay Server for you).

Remember the **huge value** of having **direct control** of your wallet and web service; for this reason we recommend you use [Azure deployment](/Deployment/Azure.md) or [Web-Interface deployment](/Deployment/LunaNode.md) and **do the setup yourself** - it is pretty easy!