# Server Settings FAQ

This document covers all the questions and issues related to Server Settings. These settings are only available to the server admin. Take a look at the walkthrough page to learn more.

# Maintenance

# How to update BTCPay Server?

There are 2 ways to update your BTCPay Server:

  1. Updating in the user interface: Server Settings > Maintenance > Update.
Updating BTCPay Server
  1. Updating using SSH: Login into your virtual machine with ssh, then apply following commands:
sudo su -
cd btcpayserver-docker

# How to restart BTCPay Server?

There are 2 ways to restart your BTCPay Server:

  1. Restarting in the user interface: Server Settings > Maintenance > Restart.
Restarting BTCPay Server
  1. Restarting using SSH: Login into your virtual machine with ssh, then apply following commands:
sudo su -
cd btcpayserver-docker

# How to SSH into my BTCPay running on VPS?

Follow these instructions to SSH via domain or IP:

ssh domainuser@example.com (domain)
ssh domainuser@ (IP)

domainuser@example.com's password:

Press Enter

If this is your first time connecting to the server from this computer, you will see the following output.

The authenticity of host 'example.com (' can't be established.
RSA key fingerprint is 3c:6d:5c:99:5d:b5:c6:25:5a:d3:78:8e:d2:f5:7a:01.
Are you sure you want to continue connecting (yes/no)?


Or see this LunaNode example (opens new window) with PuTTY.

# How to see, as an admin, what's running on my BTCPay Server?

You need to SSH into your BTCPay Server, and run a single line to see the list of apps in the system:

docker exec -ti $(docker ps -a -q -f "name=postgres_1") psql -U postgres -d btcpayservermainnet -c 'select "Name" from "Apps";'

This to see the list of stores and their websites:

docker exec -ti $(docker ps -a -q -f "name=postgres_1") psql -U postgres -d btcpayservermainnet -c 'select "StoreName","StoreWebsite" from "Stores";'

You can also run this to see the users list:

docker exec -ti $(docker ps -a -q -f "name=postgres_1") psql -U postgres -d btcpayservermainnet -c 'select "Id", "Email" from "AspNetUsers";'

# How can I see my BTCPay Server version?

You can see your BTCPay Server version in the bottom right of the page footer when you're logged in as a server admin.

Deployments using v1.0.5.7 and later will automatically receive notifications to alert when a new BTCPay Server version has been released.


Note: This feature will automatically set the BTCPAY_UPDATEURL environment variable in the BTCPay Server container to make a single daily request to this Github endpoint (opens new window). Server admins can disable these notifications by disabling the policy in Server Settings > Policies > Check releases on GitHub.

# How can I check my BTCPay Server version via terminal?

In the btcpayserver-docker folder: bitcoin-cli.sh getnetworkinfo

# What is BTCPay SSH key file?

BTCPay SSH key, enables users to update their server or quickly change the domain name from btcpay website, via the user interface.

# Forgot BTCPay Admin password?

First, register a new user on your BTCPay Server, by clicking "Register", for example: "newadmin@example.com".

If you can't create a new user because registrations are disabled in your Server Settings > Policies, you need to reset the policies settings. Please skip this step if you can create a new user on the front-end home page using the register button. Run the following command (It also deletes any other server settings currently being used):

# In root
sudo su -
cd $BTCPAY_BASE_DIRECTORY/btcpayserver-docker/
# Re-open registrations
./btcpay-admin.sh reset-server-policy

Head back to your BTCPay Server and click on the "Register" button which should now be enabled. In case you don't see the Register link in the menu, that's probably because of the caching. Restart your btcpay with btcpay-restart.sh.

Next, add the newly registered user newadmin@example.com as an admin:

# Set new user as admin
./btcpay-admin.sh set-user-admin newadmin@example.com

Now you can access with newadmin@example.com as admin.

When you apply the changes, you'll notice that the newly created user isn't a member of any stores. In that case, follow this guide (opens new window) to add the new user to all or certain stores.

# How to add a new user by invite?

Server admins can add new users by creating an invite link to share with them. This can allow admins to disable public registration on the server, or to invite specific users by clicking: Server Settings > Add User (do not provide password) > Create account

Invite User

A shareable link will be displayed for the server admin to distribute. An email will be sent (if email is configured on the server to set the password. The new user will create a password upon first visit to the invite link.

# How to disable U2F and 2FA for a user?

Remove U2F and 2FA settings for a registered user, for example user@example.com with the following commands:

# In root
sudo su -
cd $BTCPAY_BASE_DIRECTORY/btcpayserver-docker/
# Disable U2F and 2FA
./btcpay-admin.sh disable-multifactor user@example.com

# How to configure SMTP settings in BTCPay?

SMTP can be configured in settings for each store. It can also be configured for the entire server if you have admin privileges.

Each e-mail provider has different configuration, so we can't provide you with exact setup, but here's the configuration for gmail:

SMTP Host: smtp.gmail.com
SMTP Port: 587
SSL Protocol: ON
TLS Protocol: ON
SMTP Username: (your Gmail username)
SMTP Password: (your Gmail password)

For gmail it's important to allow access from less secure apps. To enable go to: Manage Your Google Account > Security > Allow Less Secure Apps (On). Also note Google may automatically turn off this setting if it’s not being used. If your smtp has stopped working, check this setting is not off.

If by any chance you have 2-step verification added to your gmail account, visit this article (opens new window).

Use the test email feature in BTCPay to verify your emails are being sent properly. If you are seeking a more reliable smtp service for your business needs, consider using a dedicated mail service like Mailgun.

Maintenance feature requires access to SSH properly configured in BTCPayServer configuration

# Error: Maintenance feature requires access to SSH properly configured in BTCPayServer configuration

Sometimes an issue with Docker can temporarily cause your BTCPay Server's maintenance features to be misconfigured. This issue is typically fixed by restarting your BTCPay Server. Unfortunately when this error appears in the interface, the restart button will be disabled. You will need to restart using ssh to resolve the issue.

# Error: Your local changes to the following files would be overwritten by merge

Sometimes, an accidentally edited file can break the update mechanism with the following error:

error: Your local changes to the following files would be overwritten by merge:

To fix the this, ssh into your server and run the following commands:

sudo su -
cd btcpayserver-docker
git reset --hard origin/master

# Error: BTCPAY_SSHKEYFILE is not set when running the docker install, or unable to update through Server Settings / Maintenance

You may see such the following message when you run your docker-compose (either via btcpay-up.sh or btcpay-setup.sh):

WARNING: The BTCPAY_SSHKEYFILE variable is not set. Defaulting to a blank string.
WARNING: The BTCPAY_SSHTRUSTEDFINGERPRINTS variable is not set. Defaulting to a blank string.

BTCPay Server requires SSH access, to allow you to perform the following tasks from the front-end:

  • Updating the server
  • Changing the domain name of the server

You can run the following command line to give access to BTCPay to your server via SSH.

sudo su -

# Checkout latest BTCPay Server version
cd $BTCPAY_BASE_DIRECTORY/btcpayserver-docker
git checkout $(git tag --sort -version:refname | awk 'match($0, /^v[0-9]+\.[0-9]+\.[0-9]+$/)' | head -n 1)

# Setup SSH access via private key
ssh-keygen -t rsa -f /root/.ssh/id_rsa_btcpay -q -P "" -m PEM
echo "# Key used by BTCPay Server" >> /root/.ssh/authorized_keys
cat /root/.ssh/id_rsa_btcpay.pub >> /root/.ssh/authorized_keys
. ./btcpay-setup.sh -i

# Theme / Customization

# How to customize my BTCPay theme style?

There are two ways to customize the theme of your BTCPay. The easy way is to choose or provide custom theme preferences in your BTCPay as explained in the Theme documentation.

For advanced theme changes, you'll most likely need to fork BTCPay repository and apply desired design changes. Build and publish the docker image to Docker Hub. Set the BTCPAY_IMAGE environment variable to your docker image tag(export BTCPAY_IMAGE="your custom btcpay docker image") and run the setup (. ./btcpay-setup.sh -i) as usual from BTCPay Docker (opens new window). Modify generated docker compose to use your custom docker image.


A forked BTCPay Server will need to create a new image manually and follow these steps for EACH BTCPay update so it is advised to stick with the default setup and theme options.

# How to modify the checkout page?

You can easily change the appearance of your BTCPay's checkout page by following the instructions here

# How to add Google Analytics code to BTCPay?

You should be able to do what you want by injecting your GA code to ~/wwwroot/checkout/js/core.js. This might be the easiest way but you have to redo it every time you update BTCPay to the latest version. Then you won’t have the hassle of forking the code, deploying it manually. Every time there is an update. Just do the docker update and add the same lines to the .js file.

# Policies

# How to allow registration on my BTCPay Server?

To allow other users to register and use your server, in Server Settings > Policies enable registration. If you configured SMTP properly, you can request users to provide e-mail confirmation to prevent spam or bots from registering on your instance.

# How to hide my BTCPay Server from Search Engines?

Discouraging search engines from indexing your site in Server Settings > Policies, adds <meta name="robots" content="noindex"> to your server header, which informs search engines not to index your pages.

It is up to search engines to honor this request, and may take time for your pages to disappear completely. Unfortunately, the exact time is beyond our control, it depends on crawl bots of the particular search engine like Google.

# Services

# How to remotely connect to my BTCPay full node?

If you're using an external wallet which allows BTC-P2P connection, you can easily connect it to your BTCPay full node. By doing this, you avoid leaking information to third-party servers and are solely relying on your own full node. To connect to a compatible BTC-P2P wallet, go to Server Settings > Services > Full node P2P Reveal the QR code and scan it with a BTC-P2P compatible wallet, or input it by copy-pasting it.


If you do not see Full node P2P in your Services, you probably have to activate Tor on your server.

# Files

# How to upload files to BTCPay?

To upload files to your BTCPay Server instance, first under Server Settings > Services, enable the External Storage feature and choose which storage service provider you would like to use. Next, go to Server Settings > Files to browse and upload local files. Depending on the limitations of your storage system, you may have difficulty uploading large files.