btcpayserver / btcpayserver-configurator

An easy UI to configure new and existing BTCPay deployments.

BTCPay Server

Accept Bitcoin payments ₿

BTCPay Server is a free and open-source Bitcoin payment processor which allows you to accept bitcoin without fees or intermediaries.

Website | Documentation | API | Contribute | YouTube | Chat

_{"This is lies, my trust in you is broken, I will make you obsolete" 💚}

View Demo · Report a bug · Request a feature · FAQ

💼 Table of Contents

• Features
• Getting Started
• Documentation
• Contributing
• Developing
  • API
• Community
• License
• Supporters

🎨 Features

• Direct, peer-to-peer Bitcoin payments
• No transaction fees (other than the network fee)
• No fees, middleman or KYC
• Non-custodial (complete control over the private key)
• Enhanced privacy & security
• Self-hosted
• SegWit support
• Lightning Network support (LND, Core Lightning (CLN), Eclair)
• Tor support
• Share your instance with friends (multi-tenant)
• Invoice management and Payment requests
• Apps: Point of sale, crowdfunding, donation button
• Full-node reliant wallet with hardware wallet integration and SegWit support
• Bitcoin-only build, separate community-maintained altcoin build (supported altcoins)

🚀 Getting Started

Firstly, decide if you want to host an instance yourself or use a third-party host. If you've chosen to self-host, there are plenty of documented ways to deploy BTCPay Server.

After successful deployment, make sure to check our getting started and walkthrough guides. In case you would like to use Lightning Network, see Lightning guide.

📗 Documentation

Please check out our official website, complete documentation and FAQ for more details.

If you have trouble using BTCPay Server, consider joining communities listed on the official website to get help from other contributors. Only create a GitHub issue for technical issues you can't resolve through other channels or feature requests you've validated with other members of the community.

🤝 Contributing

BTCPay Server is built and maintained entirely by volunteer contributors around the internet. We welcome and appreciate new contributions.

If you're a developer looking to help, but you're not sure where to begin, check the good first issue label, which contains small pieces of work that have been specifically flagged as being friendly to new contributors.

Contributors looking to do something a bit more challenging, before opening a pull request, please join our community chat or start a GitHub discussion to get early feedback, discuss the best ways to tackle the problem, and ensure there is no work duplication.

There are many other ways to get involved with the project. Check our contribution guidelines. To get the big-picture of the project development, visit our evolving roadmap.

🧑‍💻 Developing

To begin developing locally, visit our local development guide. There are also several video-tutorials:

• Setting up development environment on Windows
• Setting up development environment Linux (Ubuntu)
• Setting up development environment MacOS

How to build

While the documentation advises using docker-compose, you may want to build BTCPay Server yourself.

First, install .NET SDK v8.0 as specified by the Microsoft website.

On Powershell:

.\build.ps1

On linux:

./build.sh

How to run

Use the run scripts to run BTCPay Server, this example shows how to print the available command-line arguments of BTCPay Server.

On Powershell:

.\run.ps1 --help

On linux:

./run.sh --help

How to debug

If you want to debug, use Jetbrain's Rider or Visual Studio 2022.

You need to run the development time docker-compose as described in the test guide.

You can then run the debugger by using the Launch Profile Docker-Regtest.

If you need to debug ledger wallet interaction, install the development time certificate with:

# Install development time certificate in the trust store
dotnet dev-certs https --trust

Then use the Docker-Regtest-https debug profile.

Other dependencies

For more information, see the documentation: How to deploy a BTCPay Server instance.

🧪 API

BTCPay Server has two APIs:

• Greenfield API (New)
  • Greenfield API documentation
  • Greenfield API examples with CURL
• Legacy API

The Greenfield API is our brand-new API which is still in development. Once complete, it will allow you to run BTCPay Server headlessly. The Legacy API, is fully compatible with BitPay's API. It has limited features, but allows instant migration from BitPay.

💚 Community

Our community is the ❤️ of the project. To chat with other community members in real-time, join our Mattermost chat. We're also on GitHub discussions.

📝 License

BTCPay Server software, logo and designs are provided under MIT License.

🙏 Supporters

The BTCPay Server Project is proudly supported by these entities through the BTCPay Server Foundation.

If you'd like to support the project, please visit the donation page.

btcpayserver-configurator's Issues

Detect space available in environment

Check if UFW is installed and open ports if needed

Show warning when connecting to a remote node usign ssh credentials

Could not connect with specified SSH details

I'm running the configurator in docker on my desktop ubuntu and try to connect to a VM on a NAS on the same local network. The VM get a dedicated IP address on the localnetwork.
With terminal I can SSH to the server but the configurator cannot and give this error:
fail: BTCPayServerDockerConfigurator.Controllers.ConfiguratorController[0] SSH This machine error Renci.SshNet.Common.SshConnectionException: An established connection was aborted by the server. at Renci.SshNet.Session.WaitOnHandle(WaitHandle waitHandle, TimeSpan timeout) at Renci.SshNet.Session.WaitOnHandle(WaitHandle waitHandle) at Renci.SshNet.Session.Connect() at Renci.SshNet.BaseClient.Connect() at BTCPayServerDockerConfigurator.Models.SSHClientExtensions.<>c__DisplayClass0_0.<ConnectAsync>b__0() in /src/BTCPayServerDockerConfigurator/Models/SSHClientExtensions.cs:line 28 --- End of stack trace from previous location where exception was thrown --- at BTCPayServerDockerConfigurator.Models.SSHClientExtensions.ConnectAsync(SSHSettings sshSettings, CancellationToken cancellationToken) in /src/BTCPayServerDockerConfigurator/Models/SSHClientExtensions.cs:line 44 at BTCPayServerDockerConfigurator.Controllers.ConfiguratorController.TestSSH(SSHSettings ssh) in /src/BTCPayServerDockerConfigurator/Controllers/ConfiguratorController.Deployment.cs:line 123
Any idea why the configurator get a connection aborted by server but not the terminal?

Issue with SSH Remote Deployment

I keep getting this error when I try to do a remote deployment for SSH in the BTCPay Configurator interface.

System.Number.ThrowOverflowOrFormatException(ParsingStatus status, TypeCode type)
System.Number.ParseInt64(ReadOnlySpan value, NumberStyles styles, NumberFormatInfo info)
long.Parse(string s)
BTCPayServerDockerConfigurator.Models.ServerData+DiskFreeResult.Parse(string res) in ServerData.cs
BTCPayServerDockerConfigurator.Models.ServerData.Load(SshClient ssh) in ServerData.cs
BTCPayServerDockerConfigurator.Controllers.ConfiguratorController.LoadSettingsThroughSSH(DeploymentSettings settings) in ConfiguratorController.Deployment.cs
BTCPayServerDockerConfigurator.Controllers.ConfiguratorController.DeploymentDestination(UpdateSettings<DeploymentSettings, DeploymentAdditionalData> updateSettings) in ConfiguratorController.Deployment.cs
Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor+TaskOfIActionResultExecutor.Execute(IActionResultTypeMapper mapper, ObjectMethodExecutor executor, object controller, object[] arguments)
System.Threading.Tasks.ValueTask.get_Result()
System.Runtime.CompilerServices.ValueTaskAwaiter.GetResult()
Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|12_0(ControllerActionInvoker invoker, ValueTask actionResultValueTask)
Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|10_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, object state, bool isCompleted)
Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Rethrow(ActionExecutedContextSealed context)
Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Next(ref State next, ref Scope scope, ref object state, ref bool isCompleted)
Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|13_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, object state, bool isCompleted)
Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|24_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, object state, bool isCompleted)
Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Rethrow(ResourceExecutedContextSealed context)
Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Next(ref State next, ref Scope scope, ref object state, ref bool isCompleted)
Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|19_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, object state, bool isCompleted)
Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker invoker, Task task, IDisposable scope)
Microsoft.AspNetCore.Routing.EndpointMiddleware.g__AwaitRequestTask|6_0(Endpoint endpoint, Task requestTask, ILogger logger)
Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)
Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)
Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)
Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)

Apply BTCPay brand guidelines

Add appropriate disclaimer when people deploy via configuratior

As we agreed on Twitter in January, there needs to be a warning of some sort that's not super-scary but educates people on possible attack vectors.

Blank page when 5GB pruning + no lightning

When you select 5GB pruning and no lightning the configurator gives you a blank page.

Add support for FastSync

https://github.com/btcpayserver/btcpayserver-docker/tree/master/contrib/FastSync

Unhandled Exception: System.IO.FileNotFoundException: Could not find file '/app/docker-fragments/opt-add-configurator.yml'

Attempting manual install based on https://configurator.kukks.org web developed script.

Here is where it stopped. Apologies, I am a noob, a "Test Minion" if you will. Had to rebuild from a crashed BTCpayserver(I set aside that microSD and Flash drive, hoping it can be revived) so thought I would help test this out. I am on a Rpi4 4g, 64g microSD, 1TB SSD.

Generating /app/Generated/docker-compose.generated.yml

Unhandled Exception: System.IO.FileNotFoundException: Could not find file '/app/docker-fragments/opt-add-configurator.yml'.
at Interop.ThrowExceptionForIoErrno(ErrorInfo errorInfo, String path, Boolean isDirectory, Func2 errorRewriter) at Microsoft.Win32.SafeHandles.SafeFileHandle.Open(String path, OpenFlags flags, Int32 mode) at System.IO.FileStream.OpenHandle(FileMode mode, FileShare share, FileOptions options) at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share, Int32 bufferSize, FileOptions options) at System.IO.StreamReader..ctor(String path, Encoding encoding, Boolean detectEncodingFromByteOrderMarks, Int32 bufferSize) at System.IO.StreamReader..ctor(String path, Encoding encoding, Boolean detectEncodingFromByteOrderMarks) at System.IO.File.InternalReadAllText(String path, Encoding encoding) at System.IO.File.ReadAllText(String path) at DockerGenerator.DockerComposeDefinition.ParseDocument(FragmentName fragment) in /source/DockerComposeDefinition.cs:line 273 at DockerGenerator.DockerComposeDefinition.<>c__DisplayClass20_0.<Build>b__9(FragmentName f) in /source/DockerComposeDefinition.cs:line 72 at System.Linq.Enumerable.SelectEnumerableIterator2.ToList()
at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)
at DockerGenerator.DockerComposeDefinition.Build() in /source/DockerComposeDefinition.cs:line 72
at DockerGenerator.Program.Run(DockerComposition composition, String name, String output) in /source/Program.cs:line 88
at DockerGenerator.Program.Main(String[] args) in /source/Program.cs:line 27
Failed to generate the docker-compose
root@raspberrypi:~/btcpayserver-docker#

Cant connect using ssh deployment method

This is the issue I'm getting on the latest version of master. Note: The error doesn't appear for the released version that comes with the opt-add-configurator option in btcpay.

System.InvalidOperationException: Cannot get the value of a token type 'False' as a string.
   at System.Text.Json.Utf8JsonReader.GetString()
   at System.Text.Json.JsonPropertyInfoNotNullable`4.OnRead(ReadStack& state, Utf8JsonReader& reader)
   at System.Text.Json.JsonSerializer.ReadCore(JsonSerializerOptions options, Utf8JsonReader& reader, ReadStack& readStack)
System.Text.Json.JsonException: The JSON value could not be converted to System.String. Path: $.blockdevices[0].rm | LineNumber: 2 | BytePositionInLine: 50.
 ---> System.InvalidOperationException: Cannot get the value of a token type 'False' as a string.
   at System.Text.Json.Utf8JsonReader.GetString()
   at System.Text.Json.JsonPropertyInfoNotNullable`4.OnRead(ReadStack& state, Utf8JsonReader& reader)
   at System.Text.Json.JsonSerializer.ReadCore(JsonSerializerOptions options, Utf8JsonReader& reader, ReadStack& readStack)
   --- End of inner exception stack trace ---

I tried using: different browsers, hostname as domain & IP, existing settings checkbox enabled & disabled.

UX Improvements

I'll keep this issue for small UX related feedback gathered across multiple sources (Twitter, Mattermost, etc)

• Merge steps 3 and 4 (On and off-chain)
• put alts in advanced/geeky
• add CTA for the last step bellow the gif (gif does not have to be CTA/clickable)
• typo c-Lightning instead of CLightning

Make sure to not recreate docker dir for updating an existing environment

Duplicated word "makes" in README.md

This tool makes makes deployment simple. . .