Skip to content

Commit

Permalink
Merge pull request #1403 from TChukwuleta/GettingStartedDocsUpdate
Browse files Browse the repository at this point in the history
Update the getting started documentation flow
  • Loading branch information
pavlenex authored May 20, 2024
2 parents 378e3f8 + b8632a4 commit a5e1fee
Show file tree
Hide file tree
Showing 12 changed files with 37 additions and 15 deletions.
14 changes: 11 additions & 3 deletions docs/CreateStore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@

## Creating a Store in BTCPay Server

Inside BTCPay Server, an unlimited number of stores can be created. Each store needs to be [connected to a wallet](./WalletSetup.md), can have apps (Point of Sale, Payment Buttons and Crowdfunding) attached to it, or be paired with external e-commerce software through one of many available integrations.
BTCPay Server allows you to create an unlimited number of stores. Each store needs to be [connected to a wallet](./WalletSetup.md), can have apps (Point of Sale, Payment Buttons and Crowdfunding) attached to it, or be paired with external e-commerce software through one of many available integrations.

To **create a store**, make sure you're logged in into your account, and go to > **Stores** in the upper navigation menu. Click on the **create a new store** button. Enter the store name into the text field and click `Create`.
To **create a store**, make sure you're logged in into your account,

![BTCPayRegister2](./img/BTCPayGettingStartedStoreRegistration1.jpg)
- Navigate to **Stores** in the upper navigation menu.
- Click on the **Create Store** button.
- Enter your store name in the text field, and select your default currency and its corresponding provider.
- Click the `Create` button, and you have sucessfully created a new store.

To create more stores on your instance, you can follow the same guide as described above.


![BTCPayRegister2](./img/BTCPayGettingStartedStoreRegistration1.png)

## Customizing your BTCPay Store Settings

Expand Down
20 changes: 10 additions & 10 deletions docs/CreateWallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This type of wallet is also necessary to use features such as [Payjoin](./Payjoi

After creating a store, you'll be able to attach a wallet by first navigating to the sidebar or slide-out menu and clicking/tapping the **Bitcoin** button under the **Wallets** header. Alternatively, you can find the option to **Set up a wallet** on the Dashboard.

![Main Menu](./img/hotwallet/MainMenu.png)
![Main Menu](./img/FirstStoreCreation.png)

You'll focus on the **I don't have a wallet** section for a hot wallet and click the **Create a new wallet** button.

Expand All @@ -23,13 +23,8 @@ There will be two options on the proceeding page, and in this case, we'll select

For most people, the default options, including **Address Type** (Segwit), should work well for most applications, and it's recommended not to change it unless you're sure of what you're doing. The **Payjoin** feature is optional, and you can learn more about it at the link [above](#hot-wallet).

Find out more about advanced settings [here](#advanced-settings).

![Wallet Settings](./img/hotwallet/WalletSettings.png)

#### Recovery Seed

The last step to creating a hot wallet is making sure you document your recovery seed. After you've done so, tick the checkbox that says _I have written down my recovery phrase and stored it in a secure location_ and click the **Done** button.

#### Advanced Settings

Expand All @@ -43,13 +38,18 @@ The last step to creating a hot wallet is making sure you document your recovery

![Advanced Settings](./img/hotwallet/AdvancedSettings.png)

#### Requirements to create wallets

If are using a [third-party host](/Deployment/ThirdPartyHosting.md), this option needs to be explicitly enabled by the server admin. Generating a new wallet in an environment you are not sure is trustworthy, is discouraged.
#### Recovery Seed

The final step in creating a hot wallet is to document your recovery seed. It's crucial to understand that anyone with access to your recovery seed can access and steal all your funds, both current and future, because a private key is derived from the recovery seed. Securely back up your seed by writing it down and keep it in a safe place. Do not photograph it or store it in a digital format. Do not rely solely on your server for storing your recovery seed, always keep a backup copy.

After you've done so, tick the checkbox that says _I have written down my recovery phrase and stored it in a secure location_ and click the **Done** button.

#### Requirements to create wallets

By default, you need to be a server admin to use the create wallet feature. This is because server admins are able to extract the private key easily. If for some reason (such as allowing individuals that trust you enough with their store), you can enable the hot wallet for non-admins from Server Settings > Policies > "Allow non-admins to create hot wallets for their stores".
If are using a [third-party host](/Deployment/ThirdPartyHosting.md), this option must be explicitly enabled by the server admin. Generating a new wallet in an environment you are not sure is trustworthy, is discouraged.

Understand that anyone with access to your recovery seed can also access and steal all your funds (current AND future funds!), since a private key is derived from a recovery seed. Securely back up your seed by writing it down and keep it in a safe place. Do not photograph it or store it in a digital format. Do not rely solely on your server for storing your recovery seed, always keep a backup copy.
By default, only server admins can use the create wallet feature. This is because server admins are able to extract the private key easily. However, if you want other trusted individuals to create and manage their stores, you can enable the hot wallet feature for non-admins. To do this, go to Server Settings > Policies > "Allow non-admins to create hot wallets for their stores".

![BTCPay Server settings](./img/hotwallet/ServerSettings.png)

Expand Down
18 changes: 16 additions & 2 deletions docs/RegisterAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,22 @@ The first step in setting up your BTCPay Server is creating a user account. The

To register, visit your BTCPay Server URL and fill in the account registration form on the right. Input your password, password confirmation, e-mail and click "Register". You will automatically be logged in. If you're using a [third-party host](/Deployment/ThirdPartyHosting.md), you may be asked to verify your e-mail address to confirm the registration.

![BTCPay Server registration](./img/btcpay-registration-page.jpg)
![BTCPay Server registration](./img/btcpay-registration-page.png)


Once your account is successfully created, you'll be redirected to a new page where you can set up your store. Here, you'll need to provide a store name, select the default currency, and choose a currency rate provider.

![BTCPay Server registration](./img/btcpay-registration-store-creation.png)

![First Store Creation](./img/FirstStoreCreation.png)


Congratulations! You've completed the first step: creating your account and store on BTCPay Server.

Next Step: - [Connecting a Wallet](./WalletSetup.md).

If you need to manage multiple stores on your server instance, refer to [Creating a store](./CreateStore.md) for detailed instructions.


### Configuring e-mail

Expand All @@ -26,4 +41,3 @@ To allow other users to access your server, you need to enable registration in S

For further enhancing security and protecting your account, it's recommended to enable two-factor authentication (both 2FA and U2F are supported). To enable 2FA or U2F, click on the user settings icon in the header menu.

**_Proceed to the next step - [Creating a store](./CreateStore.md)._**
Binary file removed docs/img/BTCPayGettingStartedStoreRegistration1.jpg
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/FirstStoreCreation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/btcpay-registration-page.jpg
Binary file not shown.
Binary file added docs/img/btcpay-registration-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/btcpay-registration-store-creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/hotwallet/AdvancedSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/hotwallet/ServerSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/hotwallet/WalletSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a5e1fee

Please sign in to comment.