Adding Bank sync documentation (#126)
Co-authored-by: root <root@L15294> Co-authored-by: Jed Fox <git@jedfox.com>
@@ -4,4 +4,96 @@ Title: 'Conn Bank'
|
||||
|
||||
# Connecting Your Bank
|
||||
|
||||
This will be added in a future release of Actual!
|
||||
:::warning
|
||||
This is an **experimental feature**. That means we’re still working on finishing it. There may be bugs, missing functionality or incomplete documentation, and we may decide to remove the feature in a future release. If you have any feedback, please [open an issue](https://github.com/actualbudget/actual/issues) or post a message in the Discord.
|
||||
:::
|
||||
|
||||
:::note
|
||||
Client Version 23.3.0 and
|
||||
Server Version 23.3.1 or higher are required for this feature.
|
||||
:::
|
||||
|
||||
We are excited to offer this optional bank integration in Actual. Here are a couple of considerations to know about before making the decision to use bank sync in your installation of Actual Budget.
|
||||
|
||||
- This integration relies on you providing your own API credentials that you will need to get by signing up with the service provider and Generate Keys and Secrets that will be used in Actual.
|
||||
|
||||
- The integration only works if you are using actual-server
|
||||
|
||||
- The Secrets and Keys are stored in your Actual installed version so it is highly recommended to turn on End to End encryption and create a strong passphrase to encrypt your files.
|
||||
|
||||
- Bank Sync is part of the Experimental Features in settings and needs to be turned on in order to use this integration
|
||||
|
||||
- You will need to add a config file to your installation
|
||||
|
||||
### Supported Providers
|
||||
Nordigen
|
||||
|
||||
### Nordigen Setup
|
||||
|
||||
**Create SECRET and KEY for Actual**
|
||||
1. Create an account with Nordigen - https://nordigen.com/
|
||||
2. Log into your account dashboard page and select **User secrets** from the left side menu - https://ob.nordigen.com/user-secrets/
|
||||
|
||||

|
||||
|
||||
3. Click on the '+ create new' button at the bottom left or click the 'Create new Secrets' button the top right
|
||||
- Make sure you download your secrets file since the **key** will not be available to you again in the account dashboard
|
||||
- These secrets will be used in Actual to make the bank sync connection
|
||||
|
||||

|
||||
|
||||
4. Enter a name for your secrets and click Create.
|
||||
*This is only for you to easily identify them in the Nordigen User secrets overview*
|
||||
|
||||

|
||||
|
||||
5. Download this file and keep it on your computer.
|
||||
|
||||

|
||||
|
||||
### Setup Config files in Actual
|
||||
*You need to setup env variables or a config.js file before Actual can use the Nordigen integration.*
|
||||
|
||||
Follow the steps provided in the [Configuring the server section](https://actualbudget.github.io/docs/Installing/Configuration)
|
||||
|
||||
### Link Accounts with Nordigen
|
||||
1. Add the link to your accounts in actual (Existing or New)
|
||||
- ***For an existing account, click on that account, select the ... (kebab menu) in the top right, and choose Link Account***
|
||||
|
||||

|
||||
|
||||
- ***To create a new account with bank syncing click on the '+ Add account' link in the left menu at the bottom***
|
||||
|
||||

|
||||
|
||||
2. Select the Link your bank account button
|
||||
|
||||

|
||||
|
||||
3. Select your country and bank from the list and click the Link bank in browser button
|
||||
|
||||

|
||||
|
||||
4. Clicking Link bank in browser will redirect you to a new tab to grant access to your bank for Nordigen
|
||||
|
||||

|
||||
|
||||
5. Select **I agree** to continue with setting up the connection
|
||||
|
||||

|
||||
|
||||
6. If your connection was a success, you will be able to click on the continue button which allows Nordigen to connect
|
||||
|
||||

|
||||
|
||||
7. A progress indicator will display while Nordigen connects to your bank to get a list of your accounts
|
||||
|
||||

|
||||
|
||||
8. Once the connection has been made, there will be a list of your accounts that you can choose from
|
||||
|
||||

|
||||
|
||||
7. The final step is to select the account you want to sync and click Link account
|
||||
|
||||

|
||||
|
||||
@@ -43,3 +43,22 @@ The server will put all the budget files in this directory as binary blobs. If n
|
||||
(Advanced, most people will not need to configure this.) The server will serve the frontend from this directory. If not specified, the server will use the files in the `@actual-app/web` package that it has installed. (environment variable: `ACTUAL_WEB_ROOT`)
|
||||
|
||||
If you’re providing a custom frontend, make sure you provide an `index.html` in the top level of the `webRoot` directory, which will be served from the `/` route.
|
||||
|
||||
## `bank-sync`
|
||||
*config.js or env variables depending on how you are running Actual*
|
||||
|
||||
**Nordigen**
|
||||
- After you have updated your fly.io version or deployed a new version, you will need to add your Nordigen SECRET ID and KEY by running a flyctl command.
|
||||
*Run the following command in your terminal application, making sure to replace xxxxx with your SECRET ID and KEY from what you generated in Nordigen.*
|
||||
`flyctl secrets set ACTUAL_NORDIGEN_SECRET_ID=xxxxx ACTUAL_NORDIGEN_SECRET_KEY=xxxxx`
|
||||
|
||||
- For all other installs you need to add your Nordigen SECRET KEY and ID to a config.json file in actual-server.
|
||||
*If you don't already have this file, you will need to create it and add the following lines replacing xxxxx with your SECRET ID and KEY.*
|
||||
|
||||
`{
|
||||
"nordigen": {
|
||||
"secretId": "xxxx",
|
||||
"secretKey": "xxxxx"
|
||||
}
|
||||
}`
|
||||
|
||||
|
||||
@@ -271,8 +271,7 @@ const sidebars = {
|
||||
items: [
|
||||
'Advanced/Experimental-Features/goal-templates',
|
||||
'Advanced/Experimental-Features/report-budget',
|
||||
//unavailable('Report Budget'),
|
||||
unavailable('Account syncing'),
|
||||
'Accounts/connecting-your-bank',
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
BIN
static/img/connecting-your-bank/connecting-your-bank-01.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-02.png
Normal file
|
After Width: | Height: | Size: 36 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-03.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-04.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-05.png
Normal file
|
After Width: | Height: | Size: 19 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-06.png
Normal file
|
After Width: | Height: | Size: 80 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-07.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-08.png
Normal file
|
After Width: | Height: | Size: 27 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-09.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
static/img/connecting-your-bank/connecting-your-bank-10.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
|
After Width: | Height: | Size: 66 KiB |
|
After Width: | Height: | Size: 72 KiB |
|
After Width: | Height: | Size: 22 KiB |
|
After Width: | Height: | Size: 41 KiB |