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.

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

Integration/2.0.5 #73

Merged
merged 3 commits into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
FROM btcpayserver/monero:0.18.3.4 AS monero-wallet-rpc
FROM nicolasdorier/nbxplorer:2.5.12 AS nbx-builder
FROM nicolasdorier/nbxplorer:2.5.16 AS nbx-builder

FROM --platform=$BUILDPLATFORM mcr.microsoft.com/dotnet/sdk:8.0-bookworm-slim AS actions-builder
ARG TARGETARCH
Expand All @@ -9,7 +9,7 @@ RUN dotnet restore "utils/actions/actions.csproj" -a $TARGETARCH
WORKDIR "/actions"
RUN dotnet build "utils/actions/actions.csproj" -c Release -a $TARGETARCH -o /actions/build

FROM btcpayserver/btcpayserver:2.0.3-altcoins
FROM btcpayserver/btcpayserver:2.0.5

COPY --from=nbx-builder "/app" /nbxplorer
COPY --from=actions-builder "/actions/build" /actions
Expand Down
26 changes: 14 additions & 12 deletions docs/instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Key Information

The instance of BTCPay Server running on your Start9 server is your *own*, self-hosted payment processor for Bitcoin, including Bitcoin over the Lightning Network. The interface is served from your server alone - you are not trusting a third party to store your data and serve content. All information lives on your server.
The instance of BTCPay Server running on your Start9 server is your _own_, self-hosted payment processor for Bitcoin, including Bitcoin over the Lightning Network. The interface is served from your server alone - you are not trusting a third party to store your data and serve content. All information lives on your server.

This service provides an enormous amount of functionality surrounding creating stores, generating invoices, and accepting payments. Please visit the visit the official [documentation](https://docs.btcpayserver.org/Guide/) for details on the full capabilities.

Using the Shopify plugin will only work over Tor (ie. Shopify users will be redirected to an onion address when submitting payment) unless you set up a reverse proxy to Tor. See more details in the Advanced section below.
Using the Shopify plugin will only work over Tor (ie. Shopify users will be redirected to an onion address when submitting payment) unless you set up a reverse proxy to Tor. See more details in the Advanced section below.

## Creating your Account

When you visit your BTCPay Server for the first time, you will be asked to create an account - this will be the admin user account. Note, *you are creating an account with yourself* - there are no third parties involved storing your password on a remote server. The password is stored on your server in the BTCPay Server database and is not editable from the service config page. Please save this password in a password manager, such as Bitwarden.
When you visit your BTCPay Server for the first time, you will be asked to create an account - this will be the admin user account. Note, _you are creating an account with yourself_ - there are no third parties involved storing your password on a remote server. The password is stored on your server in the BTCPay Server database and is not editable from the service config page. Please save this password in a password manager, such as Bitwarden.

By default, additional registrations are disabled. This means that once you create an account, no one else will be permitted to create an account on your instance. The admin user can add additional accounts under `Server settings > Users`.

Expand All @@ -30,7 +30,7 @@ Since you are running your own instance, if you want to receive email notificati

If you forget your BTCPay Server admin password and you have email configured, please follow the "Forgot password" flow when attempting to login.

If you forgot your BTCPay Server admin password and you *do not* have email configured, please use the "Reset Admin Password" StartOS action on your service details page to create a temporary password. **Do not forget** to change your password once logged in!
If you forgot your BTCPay Server admin password and you _do not_ have email configured, please use the "Reset Admin Password" StartOS action on your service details page to create a temporary password. **Do not forget** to change your password once logged in!

If you forgot your BTCPay Server password and you are not an admin user, please attempt to use the "Forgot password" flow when attempting to login. If you do not receive an email, reach out to your account admin so they can check or setup the email configuration.

Expand All @@ -44,27 +44,29 @@ Please follow the instructions below to enable lightning using the nodes running

First, connect your **Start9 server's lightning node** to BTCPay Server:

1. Open your BTCPay Server service details page and select `Config`.
1. Open your BTCPay Server service details page and select `Config`.
1. Navigate to `Lightning Node` and select the installed lightning implementation type you would like to use for BTCPay (ie. LND or CLN).
1. Save this setting.

Next, **enable lightning** for a particular store's wallet using the connection to your server's lightning node:

1. Select a store from the top of the menu.
1. Navigate to `Wallets > Lightning`.
1. Navigate to `Wallets > Lightning`.
1. On the page entitled "Connect to a Lightning node", select "Use internal node"
1. Click "Save".
1. That's it!

<!-- MD_PACKER_INLINE BEGIN -->

![internal node connection](./assets/internal-node-connection.png)

<!-- MD_PACKER_INLINE END -->

If you would like to connect to an external lightning node, select "Use custom node" when on the page above and follow the instructions.

## Enabling Altcoins

In config, find `Altcoin Integrations` and set the desired altcoin implemtation to "Enabled".
In config, find `Altcoin Integrations` and set the desired altcoin implementation to "Enabled".

### Monero

Expand All @@ -87,24 +89,24 @@ If you enable / disable RPC credentials in Monero, you will need to restart BTC

## Setting up BTCPayServer Vault

BTCPayServer Vault supports hardware wallet integrations for stores. To use, you must [install Vault](https://github.com/btcpayserver/BTCPayServer.Vault/releases) and run it on a laptop/desktop machine. Then, access your BTCPay Server service in a browser on the same device.
BTCPayServer Vault supports hardware wallet integrations for stores. To use, you must [install Vault](https://github.com/btcpayserver/BTCPayServer.Vault/releases) and run it on a laptop/desktop machine. Then, access your BTCPay Server service in a browser on the same device.

To reconfigure an existing store, open the BTCPay Server UI, select the store, navigate to `Wallets > Bitcoin`, and select the settings gear in the top right corner. Under `BTC Wallet Settings`, select `Actions > Replace Wallet`, confirm the action, and click "Setup new wallet". Finally, follow the on-screen instructions to "Connect an existing wallet".

When creating a new store, select `Wallets > Bitcoin > Set up a wallet > Connect an existing wallet > Connect hardware wallet` and follow the on-screen instructions.
When creating a new store, select `Wallets > Bitcoin > Set up a wallet > Connect an existing wallet > Connect hardware wallet` and follow the on-screen instructions.

Check out the official [documentation](https://docs.btcpayserver.org/Vault/) and [blog post](https://blog.btcpayserver.org/btcpay-vault/) for more information.
Check out the official [documentation](https://docs.btcpayserver.org/Vault/) and [blog post](https://blog.btcpayserver.org/btcpay-vault/) for more information.

## Updates

Manual maintenance updates are disabled. Updates for BTCPay Server will be delivered through the Start9 Marketplace.

## Advanced

The BTCPay Server documentation can recommend `ssh` or `docker-compose` commands for resolving issues. The way BTCPay Server is configured for your Start9 server is different than the default installation, which is meant to run on a standalone server instance. Start9 has consolidated BTCPay Server to run in an optimal way, so please reach out to the Start9 team for support in these circumstances. Adding an SSH key to your device to manually debug voids the warranty and Start9 cannot assure that operations will continue to function as intended.
The BTCPay Server documentation can recommend `ssh` or `docker-compose` commands for resolving issues. The way BTCPay Server is configured for your Start9 server is different than the default installation, which is meant to run on a standalone server instance. Start9 has consolidated BTCPay Server to run in an optimal way, so please reach out to the Start9 team for support in these circumstances. Adding an SSH key to your device to manually debug voids the warranty and Start9 cannot assure that operations will continue to function as intended.

### Setting up a reverse proxy

Clearnet support for BTCPay Sever will be made accessible in a future release of StartOS. In the meantime, you can configure a reverse TOR proxy by following the official guide [here](https://docs.btcpayserver.org/Deployment/ReverseProxyToTor/#reverse-proxy-to-tor).

Enabling this functionality allows external applications and plugins to use a hosted clearnet address to access the BTCPay Server instance running on your device. This is useful if an external application requires a clearnet address to operate. Please only attempt this setup if you know what you are doing.
Enabling this functionality allows external applications and plugins to use a hosted clearnet address to access the BTCPay Server instance running on your device. This is useful if an external application requires a clearnet address to operate. Please only attempt this setup if you know what you are doing.
9 changes: 4 additions & 5 deletions manifest.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
id: btcpayserver
title: BTCPay Server
version: 2.0.3.1
version: 2.0.5
release-notes: |
* Updates to the latest upstream [release](https://github.com/btcpayserver/btcpayserver/releases/tag/v2.0.3)
* Includes major upstream release of [v2.0.0](https://github.com/btcpayserver/btcpayserver/releases/tag/v2.0.0)! This release introduces many new features and some breaking changes. Please see the [blog post](https://blog.btcpayserver.org/btcpay-server-2-0/) for more details.
* Please note: large instances may experience a few minutes of database migration.
* Adds optional Monero integration for payment processing
* Updates to the latest upstream [release](https://github.com/btcpayserver/btcpayserver/releases/tag/v2.0.5), which includes various bugfixes and improvements
* Includes the upstream release of [2.0.4](https://github.com/btcpayserver/btcpayserver/releases/tag/v2.0.4) as well.
* Updates NBXplorer to the latest version
license: mit
wrapper-repo: "https://github.com/Start9Labs/btcpayserver-wrapper"
upstream-repo: "https://github.com/btcpayserver/btcpayserver"
Expand Down
2 changes: 1 addition & 1 deletion scripts/procedures/migrations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ export const migration: T.ExpectedExports.migration = async (
},
},
},
"2.0.3.1"
"2.0.5"
)(effects, version, ...args);
};
Loading