.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+# Redirect people to our foundation page
+custom: https://foundation.btcpayserver.org

.github/workflows/build.yml

@@ -0,0 +1,52 @@
+name: Build
+
+on:
+  # Run the build for pushes and pull requests targeting master
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  # Used to trigger the build from external docs repos. Can by kicked off via:
+  # curl -X POST -H "Authorization: token $GH_PAT" -H "Accept: application/vnd.github.everest-preview+json" -H "Content-Type: application/json" https://api.github.com/repos/btcpayserver/btcpayserver-doc/dispatches --data '{"event_type": "build_docs"}'
+  repository_dispatch:
+    types:
+      - build_docs
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout doc repo and its dependencies
+      - uses: actions/checkout@v3
+      # Setup Node
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'npm'
+      # Install, test and build
+      - name: Install
+        run: npm ci
+      # Link the dependencies
+      - name: Setup dependencies
+        run: ./setup-deps.sh
+      # Test and build
+      - name: Test
+        run: npm test
+      - name: Build
+        run: npm run build
+      # Deploy, limited to the master branch
+      - name: Redirects
+        if: success()
+        run: npm run redirects
+      - name: Deploy
+        if: success() && github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_dir: ./docs/.vuepress/dist
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          cname: docs.btcpayserver.org
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

.gitignore

@@ -0,0 +1,47 @@
+/.vscode
+/deps
+/docs/.vuepress/dist
+/node_modules
+
+# External repos
+/docs/BigCommerce
+/docs/Breez
+/docs/Bringin
+/docs/BTCPayServer
+/docs/Configurator
+/docs/Docker
+/docs/Drupal
+/docs/DynamicReports
+/docs/Ecwid
+/docs/Grandnode
+/docs/Ghost
+/docs/LNDhubAPI
+/docs/NBXplorer
+/docs/Nopcommerce
+/docs/Nostr
+/docs/Odoo
+/docs/Payroll
+/docs/PodServer
+/docs/SideShift
+/docs/Smartstore
+/docs/TicketTailor
+/docs/Trocador
+/docs/Vendorpay
+/docs/Wabisabi
+/docs/Wix
+/docs/Vault
+/docs/Xenforo
+/docs/Zapier
+/docs/.vuepress/public/API/Greenfield/**/*.json
+
+# Files copied from external repos
+/docs/img/fastsync
+/docs/img/btcpayexposecloudflare*
+/docs/img/cloudflare*
+/docs/img/Cloudflare*
+/swagger/plugins/btcpay.json
+
+# Constructed docs
+/docs/Development/LocalDevelopment.md
+.idea
+*.Identifier

API/Greenfield/Plugins/swagger.json

@@ -1,241 +0,0 @@
-{
-  "openapi": "3.0.0",
-  "info": {
-    "title": "BTCPay Server Greenfield Plugin API",
-    "version": "Plugins",
-    "description": "Plugin APIs for BTCPay Server",
-    "contact": {
-      "name": "BTCPay Server",
-      "url": "https://btcpayserver.org"
-    },
-    "license": {
-      "name": "MIT",
-      "url": "https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE"
-    }
-  },
-  "servers": [
-    {
-      "url": "/",
-      "description": "BTCPay Server Greenfield API"
-    },
-    {
-      "url": "/",
-      "description": "BTCPay Server Greenfield Plugin API"
-    }
-  ],
-  "externalDocs": {
-    "description": "BTCPay Greenfield API (v1)",
-    "url": "https://docs.btcpayserver.org/API/Greenfield/v1/"
-  },
-  "components": {
-    "parameters": {
-      "StoreId": {
-        "name": "storeId",
-        "in": "path",
-        "required": true,
-        "description": "The store ID",
-        "schema": {
-          "$ref": "#/components/schemas/StoreId"
-        }
-      },
-      "InvoiceId": {
-        "name": "invoiceId",
-        "in": "path",
-        "required": true,
-        "description": "The invoice ID",
-        "schema": {
-          "$ref": "#/components/schemas/InvoiceId"
-        }
-      },
-      "UserIdOrEmail": {
-        "name": "idOrEmail",
-        "in": "path",
-        "required": true,
-        "description": "The user's id or email",
-        "schema": {
-          "type": "string"
-        }
-      }
-    },
-    "schemas": {
-      "BaseUrl": {
-        "type": "string",
-        "description": "Base URL of the BTCPay Server instance.",
-        "example": "https://btcpay.example.com/"
-      },
-      "ValidationProblemDetails": {
-        "type": "array",
-        "description": "An array of validation errors of the request",
-        "items": {
-          "type": "object",
-          "description": "A specific validation error on a json property",
-          "properties": {
-            "path": {
-              "type": "string",
-              "nullable": false,
-              "description": "The json path of the property which failed validation"
-            },
-            "message": {
-              "type": "string",
-              "nullable": false,
-              "description": "User friendly error message about the validation"
-            }
-          }
-        }
-      },
-      "ProblemDetails": {
-        "type": "object",
-        "description": "Description of an error happening during processing of the request",
-        "properties": {
-          "code": {
-            "type": "string",
-            "nullable": false,
-            "description": "An error code describing the error"
-          },
-          "message": {
-            "type": "string",
-            "nullable": false,
-            "description": "User friendly error message about the error"
-          }
-        }
-      },
-      "UnixTimestamp": {
-        "type": "number",
-        "format": "int32",
-        "example": 1592312018,
-        "description": "A unix timestamp in seconds"
-      },
-      "SpeedPolicy": {
-        "type": "string",
-        "description": "This is a risk mitigation parameter for the merchant to configure how they want to fulfill orders depending on the number of block confirmations for the transaction made by the consumer on the selected cryptocurrency.\n`\"HighSpeed\"`: 0 confirmations (1 confirmation if RBF enabled in transaction)   \n`\"MediumSpeed\"`: 1 confirmation   \n`\"LowMediumSpeed\"`: 2 confirmations   \n`\"LowSpeed\"`: 6 confirmations\n",
-        "x-enumNames": [
-          "HighSpeed",
-          "LowMediumSpeed",
-          "LowSpeed",
-          "MediumSpeed"
-        ],
-        "enum": [
-          "HighSpeed",
-          "LowMediumSpeed",
-          "LowSpeed",
-          "MediumSpeed"
-        ]
-      },
-      "TimeSpan": {
-        "type": "number",
-        "format": "int32",
-        "example": 90
-      },
-      "TimeSpanSeconds": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/TimeSpan"
-          }
-        ],
-        "format": "seconds",
-        "description": "A span of times in seconds"
-      },
-      "TimeSpanDays": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/TimeSpan"
-          }
-        ],
-        "format": "days",
-        "description": "A span of times in days"
-      },
-      "TimeSpanMinutes": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/TimeSpan"
-          }
-        ],
-        "format": "minutes",
-        "description": "A span of times in minutes"
-      },
-      "StoreId": {
-        "type": "string",
-        "description": "Store ID of the item",
-        "example": "9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776"
-      },
-      "InvoiceId": {
-        "type": "string",
-        "description": "The invoice ID",
-        "example": "HMprBnL9BTXWuPvpoKBS6e"
-      },
-      "PaymentMethodId": {
-        "type": "string",
-        "description": "Payment method IDs. Available payment method IDs for Bitcoin are:  \n- `\"BTC-CHAIN\"`: Onchain   \n-`\"BTC-LN\"`: Lightning   \n- `\"BTC-LNURL\"`: LNURL",
-        "example": "BTC-CHAIN"
-      },
-      "PayoutMethodId": {
-        "type": "string",
-        "description": "Payout method IDs. Available payment method IDs for Bitcoin are:  \n- `\"BTC-CHAIN\"`: Onchain   \n-`\"BTC-LN\"`: Lightning",
-        "example": "BTC-LN"
-      },
-      "HistogramData": {
-        "type": "object",
-        "description": "Histogram data for wallet balances over time",
-        "properties": {
-          "type": {
-            "type": "string",
-            "description": "The timespan of the histogram data",
-            "x-enumNames": [
-              "Month",
-              "Week",
-              "Year"
-            ],
-            "enum": [
-              "Month",
-              "Week",
-              "Year"
-            ],
-            "default": "Week"
-          },
-          "balance": {
-            "type": "string",
-            "format": "decimal",
-            "description": "The current wallet balance"
-          },
-          "series": {
-            "type": "array",
-            "description": "An array of historic balances of the wallet",
-            "items": {
-              "type": "string",
-              "format": "decimal",
-              "description": "The balance of the wallet at a specific time"
-            }
-          },
-          "labels": {
-            "type": "array",
-            "description": "An array of timestamps associated with the series data",
-            "items": {
-              "type": "integer",
-              "description": "UNIX timestamp of the balance snapshot"
-            }
-          }
-        }
-      }
-    },
-    "securitySchemes": {
-      "API_Key": {
-        "type": "apiKey",
-        "description": "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: `token {token}`. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `btcpay.impersonation.canimpersonate`: Can impersonate users\n* `btcpay.user.candeleteuser`: Delete user\n* `btcpay.user.canmanagenotificationsforuser`: Manage your notifications\n* `btcpay.user.canmodifyprofile`: Manage your profile\n* `btcpay.user.canviewnotificationsforuser`: View your notifications\n* `btcpay.user.canviewprofile`: View your profile\n* `unrestricted`: Unrestricted access\n\nThe following permissions are available if the user is an administrator:\n\n* `btcpay.server.cancreatelightninginvoiceinternalnode`: Create invoices with internal lightning node\n* `btcpay.server.cancreateuser`: Create new users\n* `btcpay.server.canmanageusers`: Manage users\n* `btcpay.server.canmodifyserversettings`: Manage your server\n* `btcpay.server.canuseinternallightningnode`: Use the internal lightning node\n* `btcpay.server.canviewlightninginvoiceinternalnode`: View invoices from internal lightning node\n* `btcpay.server.canviewusers`: View users\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n\n* `btcpay.store.canarchivepullpayments`: Archive your pull payments\n* `btcpay.store.cancreateinvoice`: Create an invoice\n* `btcpay.store.cancreatelightninginvoice`: Create invoices from the lightning nodes associated with your stores\n* `btcpay.store.cancreatenonapprovedpullpayments`: Create non-approved pull payments\n* `btcpay.store.cancreatepullpayments`: Create pull payments\n* `btcpay.store.cancreditsubscribers`: Credit your subscribers\n* `btcpay.store.canmanagepayouts`: Manage payouts\n* `btcpay.store.canmanagepullpayments`: Manage your pull payments\n* `btcpay.store.canmanagesubscribers`: Manage your subscribers\n* `btcpay.store.canmodifyinvoices`: Modify invoices\n* `btcpay.store.canmodifyofferings`: Modify your offerings\n* `btcpay.store.canmodifypaymentrequests`: Modify your payment requests\n* `btcpay.store.canmodifystoresettings`: Modify your stores\n* `btcpay.store.canuselightningnode`: Use the lightning nodes associated with your stores\n* `btcpay.store.canviewinvoices`: View invoices\n* `btcpay.store.canviewlightninginvoice`: View the lightning invoices associated with your stores\n* `btcpay.store.canviewofferings`: View your offerings\n* `btcpay.store.canviewpaymentrequests`: View your payment requests\n* `btcpay.store.canviewpayouts`: View payouts\n* `btcpay.store.canviewpullpayments`: View your pull payments\n* `btcpay.store.canviewreports`: View your reports\n* `btcpay.store.canviewstoresettings`: View your stores\n* `btcpay.store.webhooks.canmodifywebhooks`: Modify stores webhooks\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\nSome permissions may include other permissions, see [this operation](#operation/permissionsMetadata).\n",
-        "name": "Authorization",
-        "in": "header"
-      },
-      "Basic": {
-        "type": "http",
-        "description": "BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission",
-        "scheme": "Basic"
-      }
-    }
-  },
-  "security": [
-    {
-      "API_Key": [],
-      "Basic": []
-    }
-  ],
-  "paths": {}
-}

Accounting/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Reporting/"><script>location="/Reporting/"</script><meta http-equiv="refresh" content="0;url=/Reporting/"><meta name="robots" content="noindex"><a href="/Reporting/">Click here if you are not redirected.</a></html>

CNAME

@@ -1 +0,0 @@
-docs.btcpayserver.org

ChangeDomain/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Deployment/ChangeDomain/"><script>location="/Deployment/ChangeDomain/"</script><meta http-equiv="refresh" content="0;url=/Deployment/ChangeDomain/"><meta name="robots" content="noindex"><a href="/Deployment/ChangeDomain/">Click here if you are not redirected.</a></html>

ConnectWallet/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/WalletSetup/"><script>location="/WalletSetup/"</script><meta http-equiv="refresh" content="0;url=/WalletSetup/"><meta name="robots" content="noindex"><a href="/WalletSetup/">Click here if you are not redirected.</a></html>

Contribute/ContributeDesign/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/Design/"><script>location="/Contribute/Design/"</script><meta http-equiv="refresh" content="0;url=/Contribute/Design/"><meta name="robots" content="noindex"><a href="/Contribute/Design/">Click here if you are not redirected.</a></html>

Contribute/ContributeDev/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/Dev/"><script>location="/Contribute/Dev/"</script><meta http-equiv="refresh" content="0;url=/Contribute/Dev/"><meta name="robots" content="noindex"><a href="/Contribute/Dev/">Click here if you are not redirected.</a></html>

Contribute/ContributeDevCode/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/DevCode/"><script>location="/Contribute/DevCode/"</script><meta http-equiv="refresh" content="0;url=/Contribute/DevCode/"><meta name="robots" content="noindex"><a href="/Contribute/DevCode/">Click here if you are not redirected.</a></html>

Contribute/ContributeDevTest/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/DevTest/"><script>location="/Contribute/DevTest/"</script><meta http-equiv="refresh" content="0;url=/Contribute/DevTest/"><meta name="robots" content="noindex"><a href="/Contribute/DevTest/">Click here if you are not redirected.</a></html>

Contribute/ContributeMisc/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/Misc/"><script>location="/Contribute/Misc/"</script><meta http-equiv="refresh" content="0;url=/Contribute/Misc/"><meta name="robots" content="noindex"><a href="/Contribute/Misc/">Click here if you are not redirected.</a></html>

Contribute/ContributeTranslate/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/Translate/"><script>location="/Contribute/Translate/"</script><meta http-equiv="refresh" content="0;url=/Contribute/Translate/"><meta name="robots" content="noindex"><a href="/Contribute/Translate/">Click here if you are not redirected.</a></html>

Contribute/ContributeWrite/WriteBlog/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/WriteBlog/"><script>location="/Contribute/WriteBlog/"</script><meta http-equiv="refresh" content="0;url=/Contribute/WriteBlog/"><meta name="robots" content="noindex"><a href="/Contribute/WriteBlog/">Click here if you are not redirected.</a></html>

Contribute/ContributeWrite/WriteDocs/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/WriteDocs/"><script>location="/Contribute/WriteDocs/"</script><meta http-equiv="refresh" content="0;url=/Contribute/WriteDocs/"><meta name="robots" content="noindex"><a href="/Contribute/WriteDocs/">Click here if you are not redirected.</a></html>

Contribute/ContributeWrite/WriteSoftware/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/WriteSoftware/"><script>location="/Contribute/WriteSoftware/"</script><meta http-equiv="refresh" content="0;url=/Contribute/WriteSoftware/"><meta name="robots" content="noindex"><a href="/Contribute/WriteSoftware/">Click here if you are not redirected.</a></html>

Contribute/ContributeWrite/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Contribute/Write/"><script>location="/Contribute/Write/"</script><meta http-equiv="refresh" content="0;url=/Contribute/Write/"><meta name="robots" content="noindex"><a href="/Contribute/Write/">Click here if you are not redirected.</a></html>

Deployment/ChangeDomain/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/FAQ/Deployment/#how-to-change-your-btcpay-server-domain-name"><script>location="/FAQ/Deployment/#how-to-change-your-btcpay-server-domain-name"</script><meta http-equiv="refresh" content="0;url=/FAQ/Deployment/#how-to-change-your-btcpay-server-domain-name"><meta name="robots" content="noindex"><a href="/FAQ/Deployment/#how-to-change-your-btcpay-server-domain-name">Click here if you are not redirected.</a></html>

Deployment/RPi3/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Deployment/RaspberryPi4/"><script>location="/Deployment/RaspberryPi4/"</script><meta http-equiv="refresh" content="0;url=/Deployment/RaspberryPi4/"><meta name="robots" content="noindex"><a href="/Deployment/RaspberryPi4/">Click here if you are not redirected.</a></html>

Deployment/RPi4/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Deployment/RaspberryPi4/"><script>location="/Deployment/RaspberryPi4/"</script><meta http-equiv="refresh" content="0;url=/Deployment/RaspberryPi4/"><meta name="robots" content="noindex"><a href="/Deployment/RaspberryPi4/">Click here if you are not redirected.</a></html>

Deployment/RaspberryPi/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><title>Redirect</title><link rel="canonical" href="/Deployment/RaspberryPi4/"><script>location="/Deployment/RaspberryPi4/"</script><meta http-equiv="refresh" content="0;url=/Deployment/RaspberryPi4/"><meta name="robots" content="noindex"><a href="/Deployment/RaspberryPi4/">Click here if you are not redirected.</a></html>