A local-first personal finance app
whitespace fixes (#522)
Matt Fiddaman1faead2732a8
diff --git a/blog/2023-12-15-automate.md b/blog/2023-12-15-automate.mdindex 01d841b717..274da7346e 100644--- a/blog/2023-12-15-automate.md+++ b/blog/2023-12-15-automate.md@@ -105,7 +105,7 @@ Okay, so you understand the templates pretty well now.Now for, in my opinion, the most useful part of templates.We can set priorities!Setting a priority to the templates does two things for us-1. It tells Actual to not budget more money then shows in your `To Budget`. This is not the case by default.+1. It tells Actual to not budget more money then shows in your `To Budget`. This is not the case by default.2. It tells Actual in what order to apply the templates.So now, if we use priorities, we can entirely automate the distribution of funds both in a set order, and only what we have.@@ -225,7 +225,7 @@ Or you could drop the remaining funds into your savings category to save even moAnother strategy that you could employ with leftover funds is to circle back to a previously budgeted category and add more to it.For example I have a sinking fund that I would like to budget more to if I have leftover funds available after my base fun money is budgeted.-To do this I have two template lines at different priorities.+To do this I have two template lines at different priorities.It looks like:* `#template-30 100 up to 1500`* `#template-60 100 up to 1500`diff --git a/blog/2024-03-25-automate-twist.md b/blog/2024-03-25-automate-twist.mdindex 39a85fec8f..243f50ec27 100644--- a/blog/2024-03-25-automate-twist.md+++ b/blog/2024-03-25-automate-twist.md@@ -8,29 +8,29 @@ hide_table_of_contents: falseHello budgeters!-I hope you all enjoyed the last blog post focused on how to use goal templates. If you haven't read it yet, you might want to start [here](/blog/2023-12-15-automate.md). While we always recommend embracing the envelope system and [getting a month ahead](/blog/2023-12-15-automate.md#month-ahead) on your budget, there are some situations where that just isn't possible right away. I'm going to introduce a method here that uses the goal template system that uses your income as you receive it throughout the month using priorities.+I hope you all enjoyed the last blog post focused on how to use goal templates. If you haven't read it yet, you might want to start [here](/blog/2023-12-15-automate.md). While we always recommend embracing the envelope system and [getting a month ahead](/blog/2023-12-15-automate.md#month-ahead) on your budget, there are some situations where that just isn't possible right away. I'm going to introduce a method here that uses the goal template system that uses your income as you receive it throughout the month using priorities.<!--truncate--># The Scenario-Goal templates are an experimental feature within Actual that allow you to auto-budget categories. You can set goals that can be once off or repeating with scheduling options that are very flexible. To see more about this feature in detail, you can check out the [documentation](../../docs/experimental/goal-templates) page. To enable this feature, navigate to the settings page and scroll down and click the link to expose Experimental features within the Advanced settings area. In the mean time, you can read more about a specific use case using goal templates for weekly budgeting.+Goal templates are an experimental feature within Actual that allow you to auto-budget categories. You can set goals that can be once off or repeating with scheduling options that are very flexible. To see more about this feature in detail, you can check out the [documentation](../../docs/experimental/goal-templates) page. To enable this feature, navigate to the settings page and scroll down and click the link to expose Experimental features within the Advanced settings area. In the mean time, you can read more about a specific use case using goal templates for weekly budgeting.-In this scenario, my income will be $500 per week, starting on the first of the month. I have certain priorities that need to be met. For example, I like to eat so I'm going to prioritize food for the first pay period. I'm going to set up my mortgage to be paid at the end of the month, saving a little each week. I'm going to budget for several bills that happen throughout the month where I know which week they'll need to be paid. I'm also going to use a simple template with priorities to illustrate this method. Feel free to use other template types.+In this scenario, my income will be $500 per week, starting on the first of the month. I have certain priorities that need to be met. For example, I like to eat so I'm going to prioritize food for the first pay period. I'm going to set up my mortgage to be paid at the end of the month, saving a little each week. I'm going to budget for several bills that happen throughout the month where I know which week they'll need to be paid. I'm also going to use a simple template with priorities to illustrate this method. Feel free to use other template types.-Priorities allow you to decide which goals are funded first. Check out our last [blog post](/blog/2023-12-15-automate.md#how-priorities-work) or the section in the [documentation](../../docs/experimental/goal-templates#template-priorities) that explains in much greater detail on how to use them. In this example, I've decided to use the following priority levels+Priorities allow you to decide which goals are funded first. Check out our last [blog post](/blog/2023-12-15-automate.md#how-priorities-work) or the section in the [documentation](../../docs/experimental/goal-templates#template-priorities) that explains in much greater detail on how to use them. In this example, I've decided to use the following priority levels- Week 1: 10-19-- Week 2: 20-29-- Week 3: 30-39-- Week 4: 40-49-- 50+ for any additional priorities that can be funded after my monthly priorities are satisfied. This includes long term goals like vacation savings, investments, or holiday spending.+- Week 2: 20-29+- Week 3: 30-39+- Week 4: 40-49+- 50+ for any additional priorities that can be funded after my monthly priorities are satisfied. This includes long term goals like vacation savings, investments, or holiday spending.-In week 1, level 10 will run first, level 11 second, level 12 third, and so on. This strategy allows me to have different priorities within each week if I want. Since I've decided week 2 priorities will start at 20, all week 1 goals will be funded before week 2, and all of week 2 will be funded before week 3.+In week 1, level 10 will run first, level 11 second, level 12 third, and so on. This strategy allows me to have different priorities within each week if I want. Since I've decided week 2 priorities will start at 20, all week 1 goals will be funded before week 2, and all of week 2 will be funded before week 3.|Category|How much I need per week, and when|Template used for the category||:---|:---:|:---:||**Food**|$50 per week, every week|#template-10 50<br/> #template-20 50<br/> #template-30 50<br/> #template-40 50|-|**Restaurants**|$25 per week, every week. I've decided the Food category is more important so I'm using the x5 priority levels to run after Foods x0.|#template-15 25<br/>#template-25 25<br/>#template-35 25<br/>#template-45 25|+|**Restaurants**|$25 per week, every week. I've decided the Food category is more important so I'm using the x5 priority levels to run after Foods x0.|#template-15 25<br/>#template-25 25<br/>#template-35 25<br/>#template-45 25||**Entertainment**|$10 per week, every week|#template-13 10<br/>#template-23 10<br/>#template-33 10<br/>#template-43 10||**Clothing**|$20 per week for first two weeks, then $5 per week|#template-11 20<br/>#template-21 20<br/>#template-31 5<br/>#template-41 5||**General**|$30 in the first week, but all other first week categories are more important|#template-19 30|@@ -43,15 +43,15 @@ In week 1, level 10 will run first, level 11 second, level 12 third, and so on.|**Water**|$130 due in the third week|#template-30 130||**Power**|$150 due in the second week|#template-20 150|-You'll notice I used different priorities for different categories. When the goal templates are applied, the categories will be filled in the following order. I've bolded the categories that will only be filled for certain periods. When the templates are applied, the categories will be filled in order. Week 1 priorities will be filled first, followed by week 2 and so forth. The lower the priority number in the template from the table above, the earlier that goal will be filled.+You'll notice I used different priorities for different categories. When the goal templates are applied, the categories will be filled in the following order. I've bolded the categories that will only be filled for certain periods. When the templates are applied, the categories will be filled in order. Week 1 priorities will be filled first, followed by week 2 and so forth. The lower the priority number in the template from the table above, the earlier that goal will be filled.|First week|Second week|Third week|Fourth week|Leftovers||:---|:---|:---|:---|:---||1. Food<br/>2. Mortgage<br/>3. Clothing<br/>**4. Cell**<br/>5. Entertainment<br/>6. Restaurants<br/>**7. General**<br/>|1. Food<br/>2. Mortgage<br/>**3. Power**<br/>4. Clothing<br/>5. Entertainment<br/>6. Restaurants<br/>|1. Food<br/>2. Mortgage<br/>**3. Water**<br/>4. Clothing<br/>5. Entertainment<br/>6. Restaurants<br/>|1. Food<br/>2. Mortgage<br/>**3. Internet**<br/>4. Clothing<br/>5. Entertainment<br/>6. Restaurants|**1. Medical**<br/>**2. Savings**|-Here's my budget as I step through week by week. For each week I receive new income, I reapply the templates. You'll see that each of my categories gets filled a little more each time. If I have a little extra from one week, it will start filling up the categories for the next weeks goals. When I receive my final pay in the fourth week, my final two categories receive some funding.+Here's my budget as I step through week by week. For each week I receive new income, I reapply the templates. You'll see that each of my categories gets filled a little more each time. If I have a little extra from one week, it will start filling up the categories for the next weeks goals. When I receive my final pay in the fourth week, my final two categories receive some funding.-This approach fills your budget categories as your income arrives by prioritizing your needs and allows you to spend from your categories along the way.+This approach fills your budget categories as your income arrives by prioritizing your needs and allows you to spend from your categories along the way.### Week 1, Receive first income depositNow that we have our first deposit for the month, we're ready to start budgeting using templates.@@ -60,30 +60,30 @@ Now that we have our first deposit for the month, we're ready to start budgeting### Week 1, Apply budget templates-Use the **Apply budget template** menu option in the monthly menu. Open the menu by clicking on the three vertical dots to the right of the month.+Use the **Apply budget template** menu option in the monthly menu. Open the menu by clicking on the three vertical dots to the right of the month.-Notice that both Food, Power, and Cell categories have received funding greater than expected this week. The templates are already funding goals for week 2! Only half ($75) of the desired power budget ($150) is satisfied and was the last category to receive funding. It'll be the first category in the next pay period to be filled. Feel free to refer back to the table above to see which categories are being filled. There is a lot happening here.+Notice that both Food, Power, and Cell categories have received funding greater than expected this week. The templates are already funding goals for week 2! Only half ($75) of the desired power budget ($150) is satisfied and was the last category to receive funding. It'll be the first category in the next pay period to be filled. Feel free to refer back to the table above to see which categories are being filled. There is a lot happening here.### Receive second week's income and 'Overwrite with budget templates'-For each time going forward, we're going to use the **Overwrite with budget template** button in the month's menu. We do this because we already have a budget filled out. This will force the templates to replace any budgeted values already filled.+For each time going forward, we're going to use the **Overwrite with budget template** button in the month's menu. We do this because we already have a budget filled out. This will force the templates to replace any budgeted values already filled.-Notice that week 3 goals are already being funded. Most of the categories still show a yellow indicator. This means that they still need more funding this month to reach all of your goals. If they have turned green, like General, Cell, and Power, the target goal has been reached.+Notice that week 3 goals are already being funded. Most of the categories still show a yellow indicator. This means that they still need more funding this month to reach all of your goals. If they have turned green, like General, Cell, and Power, the target goal has been reached.### Receive third week's income and 'Overwrite with budget templates'-More green category balances! Keep in mind, you can spend from these categories along the way. I simply didn't show any spending in these graphics.+More green category balances! Keep in mind, you can spend from these categories along the way. I simply didn't show any spending in these graphics.### Receive fourth week's income and 'Overwrite with budget templates'-This is the final pay period for the month. I was successful in reaching all of my target goals. There was even a little extra for the savings category! Amazing!+This is the final pay period for the month. I was successful in reaching all of my target goals. There was even a little extra for the savings category! Amazing!# Conclusion-Thanks for following along. This may be an unconventional way to use goal templates, but this shows the power of priorities in Actual and how they could be used effectively for weekly budgeting.+Thanks for following along. This may be an unconventional way to use goal templates, but this shows the power of priorities in Actual and how they could be used effectively for weekly budgeting.diff --git a/blog/2024-07-01-ynab_v_actual.md b/blog/2024-07-01-ynab_v_actual.mdindex 54353270bf..3ce21f3287 100644--- a/blog/2024-07-01-ynab_v_actual.md+++ b/blog/2024-07-01-ynab_v_actual.md@@ -12,7 +12,7 @@ Hello budgeters!This is the start of the series **Actual Versus**!Today we will be comparing Actual Budget to YNAB (You Need a Budget).-YNAB is the longstanding heavyweight in the envelope budgeting space. It was one of the originals.+YNAB is the longstanding heavyweight in the envelope budgeting space. It was one of the originals.Lets see how Actual stacks up!<!--truncate-->@@ -25,7 +25,7 @@ Along with this blog post you can look around at our [documentation](../../docs)### tl;dr* Actual uses **envelope budgeting**, same as YNAB.-* Actual is **free** for the base app and all updates. Hosting or optional bank syncing may have a fee depending on how you set up Actual.+* Actual is **free** for the base app and all updates. Hosting or optional bank syncing may have a fee depending on how you set up Actual.* Actual can run on all devices **online or offline**, and can sync between devices if you set up a sync server.* Your **data is yours** if you use Actual Budget, where with YNAB you have no control over your data@@ -33,7 +33,7 @@ Along with this blog post you can look around at our [documentation](../../docs)This may be the place were Actual and YNAB are the most different.YNAB is a service. This means that the user has minimal control over the application and data.-This also means that YNAB owns your budget data. They say that they keep it safe, but that could change any time they want to.+This also means that YNAB owns your budget data. They say that they keep it safe, but that could change any time they want to.Because of this service model YNAB also has a continuing fee.Your budgets are not available offline since you need to access YNAB's web page to see your budget.@@ -43,7 +43,7 @@ If you don't want to use bank syncing, or it is not available in your region, thNo cost to download, no cost to use, no cost for updates.You are also free to modify the application in any way you want.-Because Actual is not a service we never see your budget data.+Because Actual is not a service we never see your budget data.It is controlled by you and it lives entirely on your devices and your server if you host one.This makes the data available offline since it is always on your device.@@ -51,11 +51,11 @@ This makes the data available offline since it is always on your device.Actual has a few options for running the software.The easiest to start is to install the desktop application or try [the web demo](https://app.actualbudget.org).-Long term you should consider also hosting your own sync server. Considerations for the sync server are added below.+Long term you should consider also hosting your own sync server. Considerations for the sync server are added below.#### Desktop ApplicationThe desktop application can be found at our [github release page](https://github.com/actualbudget/actual/releases/latest).-Download the file that matches your operating system.+Download the file that matches your operating system.The `.exe` for Windows, the `.dmg` for Mac, or one of the Linux options.#### Web version@@ -86,7 +86,7 @@ Both use envelope style budgeting, sometimes referred to zero-sum budgeting.This means that all your funds are assigned to categories, or "jobs" in YNAB vernacular.The budgeting styles are so similar you can [import your YNAB data into Actual](../../docs/migration) and move on like almost nothing changed.-How accounts and transactions are handled is very similar. There are transactions with payees, notes, categories, etc.+How accounts and transactions are handled is very similar. There are transactions with payees, notes, categories, etc.Just like you are used to.Here is a snippet of what Actual looks like in the budgeting view.@@ -97,7 +97,7 @@ Its similar to YNAB, but each have a unique style.#### Credit CardsThis is the one place where YNAB and Actual differ in budgeting.YNAB automagically handles credit cards for you.-Some users prefer this approach while others find it annoying.+Some users prefer this approach while others find it annoying.The way YNAB handles this can make it a bit too easy to hold onto credit card debt and let it build up.Actual needs some more deliberate handling of that debt.@@ -142,7 +142,7 @@ They are all a flavor of "save X funds every Y time period".This can cover many different situations pretty well.YNAB does also have indicator bars to show if the goal has been met, or progress towards that goal.-Actual currently is developing a feature that is similar to YNAB's targets we refer to as goal templates.+Actual currently is developing a feature that is similar to YNAB's targets we refer to as goal templates.Goal templates is more flexible and has more options than YNAB's targets.A full write up of how they work can be found in the [Goal Templates Documentation](../../docs/experimental/goal-templates).Some notable goals that Actual has would be: goals based on scheduled expenses, percentage goals, remainder goals, and much more!@@ -165,12 +165,12 @@ Goal templates is under active development so expect it to be even better as tim### Other Features-This will be a rapid fire view of feature comparison. For a full view of these features you can read up [in our documentation](../../docs).+This will be a rapid fire view of feature comparison. For a full view of these features you can read up [in our documentation](../../docs).Don't worry the docs aren't too long to read. I will also be including the already mentioned features.|Feature | Actual | YNAB | Notes ||:---|:---:|:---:|:---:|-| Cost | FREE | $109/yr |The base application of Actual is free. This does not include if you choose to use a hosting service or bank sync provider |+| Cost | FREE | $109/yr |The base application of Actual is free. This does not include if you choose to use a hosting service or bank sync provider || Works On All Devices | ✅ | ✅ | Actual is still in the process of reaching full feature parity between mobile and desktop, but it is nearly there || Desktop App |✅ |❌ |Actual includes automated backups in the desktop app || You Own Your Data |✅ |❌ |Actual can't see your data since it never leaves you devices or server|@@ -179,7 +179,7 @@ Don't worry the docs aren't too long to read. I will also be including the alrea| Envelope Budgeting |✅ |✅ | || Traditional Budgeting |✅ |❌ | Actual does have the option for a non-envelope style budget, but we think you should stick with envelope budgeting || Multiple budget files |✅ |✅ | |-| Dark Theme |✅ |✅ | Actual has two dark themes. A regular "Dark", and "Midnight" for those who love black |+| Dark Theme |✅ |✅ | Actual has two dark themes. A regular "Dark", and "Midnight" for those who love black || Scheduled Transactions |✅ |✅ | || Bank Sync |✅ |✅ | May not be free for Actual. YNAB only supports North America while Actual supports both North America and Europe and requires a sync server || Open Source |✅ |❌ | |diff --git a/docs/accounts/index.md b/docs/accounts/index.mdindex f67bb2c67a..858618bc38 100644--- a/docs/accounts/index.md+++ b/docs/accounts/index.md@@ -60,7 +60,7 @@ Click the account name in the sidebar of Actual-Hovering your cursor close to the account name at the top will reveal two icons.+Hovering your cursor close to the account name at the top will reveal two icons.The page icon allows you to write a note about this account, and the pencil icon allows you to rename the account.After editing a note for the account or its name, hit 'Enter' to save your changes.diff --git a/docs/accounts/reconciliation.md b/docs/accounts/reconciliation.mdindex a49a498b05..8e09888b7a 100644--- a/docs/accounts/reconciliation.md+++ b/docs/accounts/reconciliation.md@@ -26,11 +26,11 @@ When the cleared amount of the Actual account ledger and the value you entered i-Upon pressing done, all cleared transactions will receive a lock icon. This represents the fact that they were included in a reconciliation and makes it harder to accidentally change.+Upon pressing done, all cleared transactions will receive a lock icon. This represents the fact that they were included in a reconciliation and makes it harder to accidentally change.-Of course, there's always the possibility you need to change a locked transaction. You can click on the lock of any transaction to open a dialog to unlock it.+Of course, there's always the possibility you need to change a locked transaction. You can click on the lock of any transaction to open a dialog to unlock it.diff --git a/docs/advanced/bank-sync.md b/docs/advanced/bank-sync.mdindex a6a0a0b5fb..237467ec89 100644--- a/docs/advanced/bank-sync.md+++ b/docs/advanced/bank-sync.md@@ -1,6 +1,6 @@# Connecting Your Bank-We are excited to offer optional bank integration in Actual.+We are excited to offer 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.diff --git a/docs/advanced/bank-sync/gocardless.md b/docs/advanced/bank-sync/gocardless.mdindex 7301b8c684..499afba096 100644--- a/docs/advanced/bank-sync/gocardless.md+++ b/docs/advanced/bank-sync/gocardless.md@@ -127,5 +127,5 @@ To achieve this:8. Add a release note in `upcoming-release-notes/` describing your change (see [writing good release notes](/docs/contributing/#writing-good-release-notes)).9. Commit your changes and push to your fork.-Once reviewed, the maintainers will comment on the pull request and merge it if acceptable. The change would then be available in the next release of the software.+Once reviewed, the maintainers will comment on the pull request and merge it if acceptable. The change would then be available in the next release of the software.diff --git a/docs/advanced/bank-sync/simplefin.md b/docs/advanced/bank-sync/simplefin.mdindex 71187bcf49..00f3499b5b 100644--- a/docs/advanced/bank-sync/simplefin.md+++ b/docs/advanced/bank-sync/simplefin.md@@ -17,7 +17,7 @@ Server Version 24.10.0 or higher are required for this feature.-3. Accept the terms, on first login, and then you will be taken to "My Account".+3. Accept the terms, on first login, and then you will be taken to "My Account".4. Link any banks that you wish.- You will need to add your accounts first, through "Financial Institutions" > New Connection@@ -78,7 +78,7 @@ Server Version 24.10.0 or higher are required for this feature.Actual does not automatically perform syncs.You will need to manually request a sync to pull new transactions from SimpleFIN.-To sync all accounts, click on "All Accounts" in the side menu, and then click "Sync", below the "All Accounts" header.+To sync all accounts, click on "All Accounts" in the side menu, and then click "Sync", below the "All Accounts" header.If you wish to only sync one account, view the desired account and click the sync button.diff --git a/docs/advanced/http-header-auth.md b/docs/advanced/http-header-auth.mdindex 98014cd35f..8b02f5ed3b 100644--- a/docs/advanced/http-header-auth.md+++ b/docs/advanced/http-header-auth.md@@ -9,10 +9,10 @@ This feature will allow Actual to use an HTTP header to automatically authentica## Setup-This feature needs to be enabled on the server, it is not configured to work out of the box. In the Actual config, set the value `loginMethod` or env `ACTUAL_LOGIN_METHOD` to `"header"`. This will enable header authentication, but the normal password authentication will still work as a fallback.+This feature needs to be enabled on the server, it is not configured to work out of the box. In the Actual config, set the value `loginMethod` or env `ACTUAL_LOGIN_METHOD` to `"header"`. This will enable header authentication, but the normal password authentication will still work as a fallback.:::warning-Be careful! A misconfiguration on this next step could make your instance available to the whole internet.+Be careful! A misconfiguration on this next step could make your instance available to the whole internet.:::The SSO provider then needs to be configured to pass an extra HTTP header to Actual. The details on how to do this are unique to the SSO provider, but the header `x-actual-password` needs to be set to your actual password.diff --git a/docs/budgeting/categories.md b/docs/budgeting/categories.mdindex 4756a9b258..f4d4dc9197 100644--- a/docs/budgeting/categories.md+++ b/docs/budgeting/categories.md@@ -2,7 +2,7 @@You can manage your categories in the budget page. Actual supports both expense and income categories.-Get some background information and recommendations on budget categories in our+Get some background information and recommendations on budget categories in our[starting fresh](/docs/getting-started/starting-fresh#2-setting-up-your-budget-categories) guide.## Add a category@@ -61,7 +61,7 @@ You can see in the budget that our categories have now been successfully mergedCategory groups can be *expanded or collapsed* by clicking on the arrow to the left of the Category group name. All category groups can be expanded or collapsed at once by using the three-dot menu at the top of the category list.-Categories that are not currently needed can be *hidden* by using the down arrow by each category name. An example is budgeting savings for a large cost (e.g. washing machine). After the purchase is made, the category can be hidden. Hidden categories still impact your budget. When needed, hidden categories can be viewed by clicking on the three dots at the top of the category list.+Categories that are not currently needed can be *hidden* by using the down arrow by each category name. An example is budgeting savings for a large cost (e.g. washing machine). After the purchase is made, the category can be hidden. Hidden categories still impact your budget. When needed, hidden categories can be viewed by clicking on the three dots at the top of the category list.diff --git a/docs/budgeting/credit-cards/carrying-debt.md b/docs/budgeting/credit-cards/carrying-debt.mdindex 8b1f746e6c..48152f25cb 100644--- a/docs/budgeting/credit-cards/carrying-debt.md+++ b/docs/budgeting/credit-cards/carrying-debt.md@@ -1,9 +1,9 @@# Carrying Debt-Carrying debt on a credit card refers to the situation where you have an outstanding negative balance on the card and do not have the money set aside for paying it off in full when the next bill arrives. We highly recommend you to _not_ do this for any new spending as it becomes super easy to accidentally fall into deeper debt and that you instead follow the [Within the Budget](./index.md) strategy for any new credit card purchases, but in case you're already carrying a negative balance on a credit card we will on this page outline how to safely manage the debt without having to worry about going more into debt.+Carrying debt on a credit card refers to the situation where you have an outstanding negative balance on the card and do not have the money set aside for paying it off in full when the next bill arrives. We highly recommend you to _not_ do this for any new spending as it becomes super easy to accidentally fall into deeper debt and that you instead follow the [Within the Budget](./index.md) strategy for any new credit card purchases, but in case you're already carrying a negative balance on a credit card we will on this page outline how to safely manage the debt without having to worry about going more into debt.-If you have an existing credit card debt that you need to track and gradually pay off then it's very important that any new purchases you make with the credit card are pre-funded following the [Within the Budget](./index.md) strategy as there is no point in paying off 100 extra on the credit card if you will then have to put another -100 on the card to pay for groceries the week after. Instead you should prioritize making sure that your actual expense categories are funded before allocating money to paying down the debt, which will allow you to ensure that you're paying it off in a sustainable manner without accidentally incurring more of it over time.+If you have an existing credit card debt that you need to track and gradually pay off then it's very important that any new purchases you make with the credit card are pre-funded following the [Within the Budget](./index.md) strategy as there is no point in paying off 100 extra on the credit card if you will then have to put another -100 on the card to pay for groceries the week after. Instead you should prioritize making sure that your actual expense categories are funded before allocating money to paying down the debt, which will allow you to ensure that you're paying it off in a sustainable manner without accidentally incurring more of it over time.-The simplest way to track preexisting credit card debt in Actual is to create a **Credit Card** category and set it to **Rollover overspending**. When you add your existing starting balance and any preexisting transactions to your credit card account you need to ensure that the category of those transactions is set to **Credit Card**. That way you can at any time look at the **Credit Card** category balance to see the status of your preexisting debt, and you can ensure that it's getting smaller over time.+The simplest way to track preexisting credit card debt in Actual is to create a **Credit Card** category and set it to **Rollover overspending**. When you add your existing starting balance and any preexisting transactions to your credit card account you need to ensure that the category of those transactions is set to **Credit Card**. That way you can at any time look at the **Credit Card** category balance to see the status of your preexisting debt, and you can ensure that it's getting smaller over time.-Each month when you do your budgeting, _after_ you've accounted for all other necessary expense categories, you allocate however much you want to pay down on that debt into the **Budgeted** column of the **Credit Card** category. Then when you go to pay your credit card bill you can easily find out how much you should actually pay by taking the **Credit Card** account balance and turning it positive and then adding the current **Credit Card** category balance to it. If your account balance is -5500 and your category balance is -4500 then you know that you need to pay off 5500 - 4500 = 1000. This amount will be greater than what you had put into the **Budgeted** column in case you're simultaneously following the [Within the Budget](./index.md) strategy of pre-funding new credit card purchases, and you can without worries pay off the calculated amount knowing that the money has already been explicitly set aside for this specific bill.+Each month when you do your budgeting, _after_ you've accounted for all other necessary expense categories, you allocate however much you want to pay down on that debt into the **Budgeted** column of the **Credit Card** category. Then when you go to pay your credit card bill you can easily find out how much you should actually pay by taking the **Credit Card** account balance and turning it positive and then adding the current **Credit Card** category balance to it. If your account balance is -5500 and your category balance is -4500 then you know that you need to pay off 5500 - 4500 = 1000. This amount will be greater than what you had put into the **Budgeted** column in case you're simultaneously following the [Within the Budget](./index.md) strategy of pre-funding new credit card purchases, and you can without worries pay off the calculated amount knowing that the money has already been explicitly set aside for this specific bill.diff --git a/docs/budgeting/credit-cards/index.md b/docs/budgeting/credit-cards/index.mdindex 7e58114095..1793e9ff93 100644--- a/docs/budgeting/credit-cards/index.md+++ b/docs/budgeting/credit-cards/index.md@@ -1,29 +1,29 @@# Managing Credit Cards-Using a credit card in any budgeting software can be confusing, and Actual is no different. Of all the questions that are asked about budgeting, credit card usage is near the top of the list so don't feel bad if you're a little confused.+Using a credit card in any budgeting software can be confusing, and Actual is no different. Of all the questions that are asked about budgeting, credit card usage is near the top of the list so don't feel bad if you're a little confused.-On this page we will walk you through how to manage a credit card "within the budget" which is the strategy of using a credit card that we highly recommend that you follow. If you already have a preexisting credit card balance that you haven't budgeted for then we also have you covered, see the [Carrying Debt](./carrying-debt.md) page to find out how to track this debt in a safe and sustainable manner, and try to follow what we describe down below for any future credit card purchases.+On this page we will walk you through how to manage a credit card "within the budget" which is the strategy of using a credit card that we highly recommend that you follow. If you already have a preexisting credit card balance that you haven't budgeted for then we also have you covered, see the [Carrying Debt](./carrying-debt.md) page to find out how to track this debt in a safe and sustainable manner, and try to follow what we describe down below for any future credit card purchases.-Using a credit card within the budget means that for every purchase you make on the credit card, the transaction is added to Actual with a category for which money was already set aside. This means that as long as you do not overspend in any category you're not incurring any more debt and are able to pay the credit card bill in full whenever it arrives.+Using a credit card within the budget means that for every purchase you make on the credit card, the transaction is added to Actual with a category for which money was already set aside. This means that as long as you do not overspend in any category you're not incurring any more debt and are able to pay the credit card bill in full whenever it arrives.## Scenario-Below we're going to describe a scenario showing you how you can safely use a credit card without racking up any debt. There's a lot of text in the following sections but don't worry, actually implementing this strategy is very easy.+Below we're going to describe a scenario showing you how you can safely use a credit card without racking up any debt. There's a lot of text in the following sections but don't worry, actually implementing this strategy is very easy.### Setup {#scenario-setup}-To start with we're going to be creating two accounts, **Checking** and **Credit Card**, both with a starting balance of 0. We're also going to say that we're receiving 250 in income on the 1st of every month.+To start with we're going to be creating two accounts, **Checking** and **Credit Card**, both with a starting balance of 0. We're also going to say that we're receiving 250 in income on the 1st of every month.-In this scenario we're going to say that we're planning on buying a new laptop for 500. Since we don't have any savings set aside for making this purchase at once we're instead going to create a category called **New Laptop** into which we will budget the money we're saving for this purchase.+In this scenario we're going to say that we're planning on buying a new laptop for 500. Since we don't have any savings set aside for making this purchase at once we're instead going to create a category called **New Laptop** into which we will budget the money we're saving for this purchase.### Month 1 {#scenario-month-1}It's the first day of the month and we've just received our salary into our checking account, and so we create a transaction depositing 250 into the Income category.-Since we don't have any other expenses this month we know that we're able to put aside the full 250 that we have available to budget this month into the **New Laptop** category. Since the category balance is so far only 250 we know that we don't yet have enough money set aside to buy the laptop for 500, and so the purchase will have to wait until another month.+Since we don't have any other expenses this month we know that we're able to put aside the full 250 that we have available to budget this month into the **New Laptop** category. Since the category balance is so far only 250 we know that we don't yet have enough money set aside to buy the laptop for 500, and so the purchase will have to wait until another month.At the end of the month our budget looks like this:- **New Laptop** category has a balance of 250.@@ -35,7 +35,7 @@ At the end of the month our budget looks like this:The first of the second month rolls around and we've just received our salary again, and just as last month we create a deposit of 250 into the Income category.-Our expenses are unchanged and we yet again budget 250 into the **New Laptop** category. This means that we finally have a balance of 500 in the **New Laptop** category and are now able to make the purchase we were looking forward to. So we buy the laptop using our credit card and put the transaction in the **New Laptop** category, since that's the category holding the money we set aside for this very purchase.+Our expenses are unchanged and we yet again budget 250 into the **New Laptop** category. This means that we finally have a balance of 500 in the **New Laptop** category and are now able to make the purchase we were looking forward to. So we buy the laptop using our credit card and put the transaction in the **New Laptop** category, since that's the category holding the money we set aside for this very purchase.Our budget now looks like this:- **New Laptop** category has a balance of 0 since we just used the whole balance for the purchase.@@ -56,4 +56,4 @@ Since we made sure to only spend money that we already had budgeted we were ableHopefully after reading this example scenario you've seen that managing credit card spending safely can be pretty easy with a little bit of planning.-On the other hand if some emergency comes up where you need to "borrow" some of the money you had set aside for paying the credit card bill then you've overspent your money and are now in debt. This is perfectly okay, but it means that you need to switch over to following the [Carrying Debt](./carrying-debt.md) strategy for managing this debt. Following this scenario you'd substitute the **New Laptop** category for the **Credit Card** category.+On the other hand if some emergency comes up where you need to "borrow" some of the money you had set aside for paying the credit card bill then you've overspent your money and are now in debt. This is perfectly okay, but it means that you need to switch over to following the [Carrying Debt](./carrying-debt.md) strategy for managing this debt. Following this scenario you'd substitute the **New Laptop** category for the **Credit Card** category.diff --git a/docs/budgeting/index.md b/docs/budgeting/index.mdindex 06b5b0f1ea..af178d93b8 100644--- a/docs/budgeting/index.md+++ b/docs/budgeting/index.md@@ -42,12 +42,12 @@ When you add income for a month, it becomes immediately available to budget. YouMost likely, a common workflow will be to "hold" income you make this month for next month's budget. **Optionally, to hold money instead of budgeting it for a month:**-1. Click the **To Budget** amount.-2. Select **Hold for next month** in the menu.+1. Click the **To Budget** amount.+2. Select **Hold for next month** in the menu.-3. Press <Key k="enter" /> to hold all available money, or enter a custom amount to hold.+3. Press <Key k="enter" /> to hold all available money, or enter a custom amount to hold.This doesn't do anything except take out money from the **To Budget** amount for that month, allowing you to "zero it out" and mark it to be used for later. That money will appear in next month's **To Budget**.@@ -55,7 +55,7 @@ Using Hold for Next Month will ensure that the funds are no longer available toYou can also just leave the **To Budget** amount alone.-It is possible to hold money multiple months ahead. If you do this, those dollars will be taken out of the current month's To Budget, and made available in the next month's To Budget. This can be done for multiple months in a row, if you want to hold the income for 2 or more months. If you need to use that money in the current month to cover over spending, use the **Reset Next Months Buffer** button to bring that money to the current month. This needs to be done for each month there is a hold.+It is possible to hold money multiple months ahead. If you do this, those dollars will be taken out of the current month's To Budget, and made available in the next month's To Budget. This can be done for multiple months in a row, if you want to hold the income for 2 or more months. If you need to use that money in the current month to cover over spending, use the **Reset Next Months Buffer** button to bring that money to the current month. This needs to be done for each month there is a hold.:::noteIf you enter a new month and have a negative "To Be Budgeted" amount and you're sure it should be positive, try resetting next month's buffer to bring money that may be held back to the current month.diff --git a/docs/budgeting/rules/custom.md b/docs/budgeting/rules/custom.mdindex 574b61697a..e187498ab8 100644--- a/docs/budgeting/rules/custom.md+++ b/docs/budgeting/rules/custom.md@@ -4,7 +4,7 @@ This page has examples of custom rules that some of our users have found useful### Q: How do I set the payee when the payee name changes between transactions-**A:** Sometimes the payee shows up slightly differently from transaction to transaction. To set the same payee every time and not create a new one every time a new transaction is imported, use a **Pre** rule that reads the imported payee field and finds the merchant name using a "contains" condition.+**A:** Sometimes the payee shows up slightly differently from transaction to transaction. To set the same payee every time and not create a new one every time a new transaction is imported, use a **Pre** rule that reads the imported payee field and finds the merchant name using a "contains" condition.@@ -20,7 +20,7 @@ This page has examples of custom rules that some of our users have found useful-### Q: I use bank sync. How do I create transfers and not make duplicates?+### Q: I use bank sync. How do I create transfers and not make duplicates?**A:** Rules can be used to automatically create transfers.Under the hood, Actual creates payees for each of your accounts.diff --git a/docs/community-repos.md b/docs/community-repos.mdindex b9e6670afe..2e4720f17b 100644--- a/docs/community-repos.md+++ b/docs/community-repos.md@@ -1,12 +1,12 @@# Community Projects-The following community projects are not maintained by the Actual Budget project but integrate with it.+The following community projects are not maintained by the Actual Budget project but integrate with it.They are for special use cases or for developing features that have not yet been integrated into Actual.These and other projects can be discussed in the #community-projects channel on the Actual Discord server.-If you want your project listed here, notify people in the #documentation Discord channel. Before you can ask+If you want your project listed here, notify people in the #documentation Discord channel. Before you can askfor it to be added, your project must have a proper Readme file.@@ -25,7 +25,7 @@ The following are implementations of bank syncing using the Actual API. For inst## Budget Migration-Actual currently has official support for migrating budgets from YNAB4 and nYNAB. The following are available for migrating from other budget apps.+Actual currently has official support for migrating budgets from YNAB4 and nYNAB. The following are available for migrating from other budget apps.* **Mint.com** - https://github.com/youngcw/actual_mint_importer* **MoneyMoney** - https://github.com/NikxDa/actual-moneymoneydiff --git a/docs/config/https.md b/docs/config/https.mdindex c7fc5e8176..61d6a8debc 100644--- a/docs/config/https.md+++ b/docs/config/https.md@@ -14,16 +14,16 @@ Use a self-signed certificate. This is the easiest way to get HTTPS working, but- A command line tool like [mkcert](https://github.com/FiloSottile/mkcert) can automate this process.- Alternately, you can manually generate the certificates. Install OpenSSL for your operating system, then run `openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout selfhost.key -out selfhost.crt` in a terminal to generate the certificate and private key. You’ll need to enter a two-letter country code to get the `.crt` file to be generated, but you can leave the rest of the fields blank (just hit enter at each prompt). Move the `selfhost.key` and `selfhost.crt` files to a location accessible to the Actual server.-### Obtain a certificate without exposing to the internet+### Obtain a certificate without exposing to the internetUse a service like [Tailscale](https://tailscale.com/kb/1153/enabling-https/) or [Caddy](https://caddyserver.com/docs/automatic-https#dns-challenge) that allows you to create a valid HTTPS certificate without having to expose your server to the wider internet.## 2. Configure Actual to use the certificateOnce you have the certificate, you’ll need to configure Actual to use it. There are two methods to do this:-### Configuring with `config.json`:-Create a `config.json` file in the same folder where you run Actual. Put the paths to the `.key` and `.crt` files in the file. Note: if you’re using Docker or a similar container environment, make sure the paths are accessible to the container.+### Configuring with `config.json`:+Create a `config.json` file in the same folder where you run Actual. Put the paths to the `.key` and `.crt` files in the file. Note: if you’re using Docker or a similar container environment, make sure the paths are accessible to the container.-If using a Docker container, this folder is `/data` within the container. If you mounted a volume for the container, the folder on the host where `/data` is mounted is where you can place the `config.json` file.+If using a Docker container, this folder is `/data` within the container. If you mounted a volume for the container, the folder on the host where `/data` is mounted is where you can place the `config.json` file.`config.json`:@@ -35,12 +35,12 @@ If using a Docker container, this folder is `/data` within the container. If you}}```--### Configuring with environment variables:++### Configuring with environment variables:If you can’t easily create new files, you can also configure HTTPS using environment variables. Set the `ACTUAL_HTTPS_KEY` and `ACTUAL_HTTPS_CERT` environment variables to the contents of the `.key` and `.crt` files, respectively. If you’re unable to include newlines in the environment variable values, you can replace any newlines with `\n` and Actual will automatically convert them back to newlines.-### Configuring the Desktop App:-To configure the desktop app, follow these steps on the _Where's the server?_ screen.+### Configuring the Desktop App:+To configure the desktop app, follow these steps on the _Where's the server?_ screen.1. Enter your server URL and click OK.2. If you see an error message asking you to select your certificate, choose the appropriate certificate and try again.diff --git a/docs/config/index.md b/docs/config/index.mdindex 198509f83f..2cc04c0e55 100644--- a/docs/config/index.md+++ b/docs/config/index.md@@ -54,9 +54,9 @@ If you’re providing a custom frontend, make sure you provide an `index.html` i## `loginMethod`-Change the authentication method for Actual (environment variable: `ACTUAL_LOGIN_METHOD`). The valid values are:+Change the authentication method for Actual (environment variable: `ACTUAL_LOGIN_METHOD`). The valid values are:* `"password"` (default) - This is standard password authentication-* `"header"` - Use the HTTP header `x-actual-password` to automatically login. This is for advanced use and if not done correctly could have security implications.+* `"header"` - Use the HTTP header `x-actual-password` to automatically login. This is for advanced use and if not done correctly could have security implications.## `trustedProxies`diff --git a/docs/contributing/project-details/architecture.md b/docs/contributing/project-details/architecture.mdindex 2778bf1281..f7a0712683 100644--- a/docs/contributing/project-details/architecture.md+++ b/docs/contributing/project-details/architecture.md@@ -1,8 +1,8 @@# Architecture Notes-If you wish to contribute to actual, these details are not essential but can be useful for navigating the structure of the code.+If you wish to contribute to actual, these details are not essential but can be useful for navigating the structure of the code.-When actual runs, it runs the front-end react based web app, as well as a local in-browser database server. You may see these informally referred to as 'frontend' and 'backend' - not to be confused with the sync-server or some other type of remote 'backend' (which doesn't exist).+When actual runs, it runs the front-end react based web app, as well as a local in-browser database server. You may see these informally referred to as 'frontend' and 'backend' - not to be confused with the sync-server or some other type of remote 'backend' (which doesn't exist).In the web app, this background server runs in a [web worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers), and in the electron app it spins up a [background process](https://nodejs.org/dist/latest-v16.x/docs/api/child_process.html#child_processforkmodulepath-args-options) which communicates over [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API).diff --git a/docs/contributing/project-details/electron.md b/docs/contributing/project-details/electron.mdindex 1555420802..f7f46c597a 100644--- a/docs/contributing/project-details/electron.md+++ b/docs/contributing/project-details/electron.md@@ -4,7 +4,7 @@* Details of the motivation behind the usage of WebSockets in the electron app can be found in the [Pull Request](https://github.com/actualbudget/actual/pull/1003) where the changes were made.-* Due to Electron security requirements there are some restrictions on what can be passed from front-end to (local) back-end. Generally limited to strings/ints via the `ipcRenderer`+* Due to Electron security requirements there are some restrictions on what can be passed from front-end to (local) back-end. Generally limited to strings/ints via the `ipcRenderer`* Making changes to the `global.Actual` object MUST happen inside the preload script. Due to electron security requirements this object is siloed and can only pass messages via `ipcRenderer`diff --git a/docs/contributing/project-details/migrations.md b/docs/contributing/project-details/migrations.mdindex 7b45ff2178..5caf4814e6 100644--- a/docs/contributing/project-details/migrations.md+++ b/docs/contributing/project-details/migrations.md@@ -12,4 +12,4 @@ There are some important considerations to make when adding a feature with a db* It is strongly discouraged to try to remove columns and tables, This makes reverting changes impossible and introduces unnecessary risk when we can simply stop using them in code.-* You should be very deliberate with your migration. When adding a feature, try to think about future scenarios and options that may be desired later, so we can minimise the number of migrations.+* You should be very deliberate with your migration. When adding a feature, try to think about future scenarios and options that may be desired later, so we can minimise the number of migrations.diff --git a/docs/contributing/writing-docs.md b/docs/contributing/writing-docs.mdindex 276f6db4cc..bb2c332f5f 100644--- a/docs/contributing/writing-docs.md+++ b/docs/contributing/writing-docs.md@@ -248,7 +248,7 @@ Place the content inside the details-tags.Using images to accompany the description makes the documentation more accessible, thus improving its readability.-The way to do this is to take good screenshots. When taking screenshots, there are a few things to keep in mind:+The way to do this is to take good screenshots. When taking screenshots, there are a few things to keep in mind:* It is crucial to ensure that the image is crystal clear and directly relevant.Blurry or muddled images can detract from the user's understanding and confidence in the documentation.diff --git a/docs/experimental/goal-templates.md b/docs/experimental/goal-templates.mdindex 84a9a5dc87..a10956464d 100644--- a/docs/experimental/goal-templates.md+++ b/docs/experimental/goal-templates.md@@ -42,8 +42,8 @@ You are welcome to have other lines in your note, but the #template/#goal line m|#template 12% of available funds|Budget 12% of your "To Budget" funds available at the current priority level| ||#template schedule {SCHEDULE NAME}|Fund upcoming scheduled transactions over time|Monthly schedules, or larger non-monthly scheduled transactions||#template schedule full {SCHEDULE NAME}|Fund upcoming scheduled transaction only on needed month| Small schedules that are non-monthly|-|#template average 6 months | Budget the average amount spent over the last 6 months. Can set the number to any number > 0. Matches the existing option on the budget page but with flexible month ranges |-|#template copy from 12 months ago | Budget the same amount as was budgeted 12 months ago. Number of months is adjustable | Your power bill fluctuates throughout the year, but is about the same in equivalent months between years. |+|#template average 6 months | Budget the average amount spent over the last 6 months. Can set the number to any number > 0. Matches the existing option on the budget page but with flexible month ranges |+|#template copy from 12 months ago | Budget the same amount as was budgeted 12 months ago. Number of months is adjustable | Your power bill fluctuates throughout the year, but is about the same in equivalent months between years. ||#template remainder | Add all remaining funds to this category| See the [Remainder Template](#remainder-template) Section for info ||#goal 1000 | Set a long term goal instead of a monthly goal | See the [Goal Directive](#goal-directive) Section for info |@@ -56,7 +56,7 @@ You are welcome to have other lines in your note, but the #template/#goal line m- By default templates do not consider available funds when being applied. Use template priorities to not budget more than is available.- The `hold` flag can be added to any goal that uses the `up to` key word.- A single category with two templates that use `up to` is not supported.-- If any single template contains an `up to`, the whole category will be subject to that limit even if there are later templates and priorities. This excludes remainders which will run after the limit is applied.+- If any single template contains an `up to`, the whole category will be subject to that limit even if there are later templates and priorities. This excludes remainders which will run after the limit is applied.### Multiple Template Lines@@ -93,17 +93,17 @@ Templates can be given a priority flag to change the order that the templates ge- Lower priority values get run first. EX 0 is run first, then 1, then 2, etc.- No priority flag defaults to priority 0 and is the same as a standard template.- Negative priorities are not allowed and will result in the template being skipped.-- Template application order is based on the database order, not the view order. To guarantee a specific fill order use separate priorities for each category.+- Template application order is based on the database order, not the view order. To guarantee a specific fill order use separate priorities for each category.- If you have multiple `schedule` or `by` template lines in a single category, they will be forced to match the same priority level as the line run first.- It is recommended to use the "overwrite with budget template" option when applying templates if you use priorities.- - **Expected budgeted amount is 200**+ - **Expected budgeted amount is 200****Expected maximum category balance is 200**#template 300#template-1 150 up to 200-- - **Expected budgeted amount is 450**++ - **Expected budgeted amount is 450****No maximum category balance exists**#template 150 up to 500@@ -154,13 +154,13 @@ All the examples below use the case of $100 leftover when the remainder pass is## Goal DirectiveThis option is unique enough to warrant its own directive `goal` instead of the standard `template` option.-The `goal` option overrides how the goal indicator typically functions.+The `goal` option overrides how the goal indicator typically functions.In the standard templates, the goal indication colors are based on the current month's budgeted value.-When using the `goal` option, the indication is based on the total balance.-This shifts the indication to a long-term goal you are saving up to instead of just the current monthly portion.+When using the `goal` option, the indication is based on the total balance.+This shifts the indication to a long-term goal you are saving up to instead of just the current monthly portion.A few examples have been given to illustrate this difference.-### Notes+### Notes* The `goal` templates are run the same way as the other templates but using the month options or the category budget options.* If there is a `goal` directive in a category, the indicator for that category will be based on the total balance compared to the amount set in the template line.* The `goal` directive will not budget any funds, and funds budgeted by hand will not get reset by running templates.@@ -214,6 +214,6 @@ To apply the goal templates you create, enable the feature in the Settings exper**Overwrite with budget template** will fill in all budget cells using the templates.### Goal Indicators-After having run the templates in a given month the status of a respective category goal will be indicated as a text color of the category balance. The image below shows an example of categories in the following states: normal (no goal set), zero (no goal set), goal met, goal not met, and a negative balance.+After having run the templates in a given month the status of a respective category goal will be indicated as a text color of the category balance. The image below shows an example of categories in the following states: normal (no goal set), zero (no goal set), goal met, goal not met, and a negative balance.diff --git a/docs/experimental/monthly-cleanup.md b/docs/experimental/monthly-cleanup.mdindex ca50d9ae0d..4d0cacc84d 100644--- a/docs/experimental/monthly-cleanup.md+++ b/docs/experimental/monthly-cleanup.md@@ -41,11 +41,11 @@ The feature works sequentially in the following manner after pressing the **End-1. Local groups are applied first. Overspent categories are not automatically filled at this step and the group source funds will be distributed.-1. Any `#cleanup source` entries will be found and all extra money in those categories will be returned to **To Budget**.+1. Local groups are applied first. Overspent categories are not automatically filled at this step and the group source funds will be distributed.+1. Any `#cleanup source` entries will be found and all extra money in those categories will be returned to **To Budget**.- A source category that has a negative balance will be ignored.-2. **Overspent** categories that do NOT use **Rollover Overspending** will be found and will attempt to cover the overspending from **To Budget**.-3. Any `#cleanup sink` entries will be found and redistribute the remaining **To Budget** amounts based on the weight given.+2. **Overspent** categories that do NOT use **Rollover Overspending** will be found and will attempt to cover the overspending from **To Budget**.+3. Any `#cleanup sink` entries will be found and redistribute the remaining **To Budget** amounts based on the weight given.## Calculating the weights of 'sink' categories@@ -99,19 +99,19 @@ YES!The script will remove all of your buffer funds, cover your overspending, and put your buffer funds back into the buffer for next time. You can also add a `#template` goal to this category so you can fill it back up next month!-**My utility bills fluctuate from month to month, but are always less than $500. Can I shift that $500 around in just the utility categories?**+**My utility bills fluctuate from month to month, but are always less than $500. Can I shift that $500 around in just the utility categories?**Yes.Method 1:-One way to do this is to have a Utilities holding category with $500 budgeted. Within that category, use `#cleanup utilities source` and `#cleanup utilities sink`. Within all of the remaining utilities categories (power, gas, water, etc), use `#cleanup utilities`. This adds the remaining categories to the `utilities` group. The script will fill any overspending from the holding category and return any remaining money to the holding category.+One way to do this is to have a Utilities holding category with $500 budgeted. Within that category, use `#cleanup utilities source` and `#cleanup utilities sink`. Within all of the remaining utilities categories (power, gas, water, etc), use `#cleanup utilities`. This adds the remaining categories to the `utilities` group. The script will fill any overspending from the holding category and return any remaining money to the holding category.-Method 2:+Method 2:Another way to accomplish this is to budget what you think you will spend for each of the utilities in each category. For example:* Power - $200* Water - $150* Gas - $150-In each category use `#cleanup utilities source` and `#cleanup utilities sink`. When the script is run, all of the remaining funds from each utilities category will be used to fund your overspent categories within the group and the leftover money will be evenly distributed to the utilities to carry over for the next month. Add a weight to the end of any of the categories if you would like to fund more.+In each category use `#cleanup utilities source` and `#cleanup utilities sink`. When the script is run, all of the remaining funds from each utilities category will be used to fund your overspent categories within the group and the leftover money will be evenly distributed to the utilities to carry over for the next month. Add a weight to the end of any of the categories if you would like to fund more.diff --git a/docs/experimental/tracking-budget.md b/docs/experimental/tracking-budget.mdindex 55ed2a2367..e9514f3276 100644--- a/docs/experimental/tracking-budget.md+++ b/docs/experimental/tracking-budget.md@@ -6,7 +6,7 @@ This is an **experimental feature**. That means we’re still working on finishi## Enabling the Tracking Budget-The **Tracking Budget** feature can be switched on from the Experimental features section within the Settings page by enabling "Budget mode toggle".+The **Tracking Budget** feature can be switched on from the Experimental features section within the Settings page by enabling "Budget mode toggle".Then scroll up in the settings menu and click "Switch to tracking budgeting".diff --git a/docs/getting-started/envelope-budgeting.md b/docs/getting-started/envelope-budgeting.mdindex e7cb9faf4a..d4885f668f 100644--- a/docs/getting-started/envelope-budgeting.md+++ b/docs/getting-started/envelope-budgeting.md@@ -16,65 +16,65 @@ utility bills, and other regular payments. These fixed costs are crucial and muscomplete picture of your finances. Actual Budget ensures that every fixed or variable expense isconsidered. This comprehensive approach makes Actual Budget much more effective than the traditional cash-stuffing method.-A significant advantage of using Actual Budget is increased awareness of expenses.+A significant advantage of using Actual Budget is increased awareness of expenses.Knowing where every penny of your money is spent is a decisive step towards financial control and stability.## Zero-Sum Budgeting-Zero-Sum budgeting[^1] is a key principle in electronic envelope budgeting systems like Actual Budget.-This approach means that all income is assigned to a specific category, leaving no money unallocated.+Zero-Sum budgeting[^1] is a key principle in electronic envelope budgeting systems like Actual Budget.+This approach means that all income is assigned to a specific category, leaving no money unallocated.This gives every unit of currency a purpose, ensuring that income is used efficiently and intentionally.-A popular saying is all your money should have a "job".+A popular saying is all your money should have a "job".-One dollar (or whatever your currency is) may be used for Netflix while the next dollar may be for savings.-Giving every dollar a job forces you to be honest about where your money is going because each dollar can+One dollar (or whatever your currency is) may be used for Netflix while the next dollar may be for savings.+Giving every dollar a job forces you to be honest about where your money is going because each dollar canonly have one job.Here’s what Zero-Sum Budgeting involves:-- **Total Allocation**: All your income is allocated to specific categories, resulting in a+- **Total Allocation**: All your income is allocated to specific categories, resulting in azero balance.-- **Goal-Oriented Planning**: It encourages you to assign funds with specific goals, such as saving for+- **Goal-Oriented Planning**: It encourages you to assign funds with specific goals, such as saving foremergencies, paying off debts, or investing. This aligns your spending with your overall financial objectives.-- **Flexibility**: This method allows flexibility as your priorities change. It requires regular evaluation+- **Flexibility**: This method allows flexibility as your priorities change. It requires regular evaluationand adjustment, making it suitable for those with dynamic financial situations.-By following Zero-Sum Budgeting, you can maintain control over your finances and ensure that every income+By following Zero-Sum Budgeting, you can maintain control over your finances and ensure that every incomeis working towards your financial goals.## Zero-Sum Budgeting Strategies you can use-Every one has a different situation so there isn't a once size fits all way to assign your available funds.+Every one has a different situation so there isn't a once size fits all way to assign your available funds.Detailed below are a few strategies you can use.### The Basics of Zero-Sum Budgeting-A basic idea with zero-sum budgeting is that you can only budget what you have, and all you have should be-budgeted. If you budget more than you have one month, the over budgeted amount will be deducted from what-you have available the next month. So to start, decide what your most important categories are. Those-important categories might be rent, food, and utilities. Assign what you need for those categories, then-repeat the process for the next most important categories until your to budget amount for the month reaches+A basic idea with zero-sum budgeting is that you can only budget what you have, and all you have should be+budgeted. If you budget more than you have one month, the over budgeted amount will be deducted from what+you have available the next month. So to start, decide what your most important categories are. Those+important categories might be rent, food, and utilities. Assign what you need for those categories, then+repeat the process for the next most important categories until your to budget amount for the month reacheszero. When you get a paycheck, or other income, continue filling in where the funds are needed.-As you go along you will start to get a good view of where your money is going. If you don't like how things+As you go along you will start to get a good view of where your money is going. If you don't like how thingsare going, make changes. If you're happy, great! Keep budgeting to keep track of your progress on your goals.A more detailed breakdown of how budgeting in Actual works is provided in the [budgeting page](/docs/budgeting/).### Credit Cards-If you currently are carrying credit card debt in an on budget account you will need to capture that debt in a category.+If you currently are carrying credit card debt in an on budget account you will need to capture that debt in a category.A guide on how to handle that can be found in [the credit card guide](/docs/budgeting/credit-cards/).### The Month Ahead Method-It can be hard to know where to budget your funds when you get paid in the middle of the month, or get multiple-paychecks per month. One way to handle this is called the *month ahead* method. This consists of holding everything-you make this month and only budgeting it next month. The goal is to not need any of this month's income for this-month's bills, but pay all of this month's bills with last month's income. Actual makes this easy by allowing you-to hold your available funds for the next month by clicking the To Budget amount at the top of the budgeting screen+It can be hard to know where to budget your funds when you get paid in the middle of the month, or get multiple+paychecks per month. One way to handle this is called the *month ahead* method. This consists of holding everything+you make this month and only budgeting it next month. The goal is to not need any of this month's income for this+month's bills, but pay all of this month's bills with last month's income. Actual makes this easy by allowing you+to hold your available funds for the next month by clicking the To Budget amount at the top of the budgeting screenand selecting the "Hold for next month" option. You can read more about this on the budgeting page### Shared accounts@@ -88,21 +88,21 @@ You can read more about these in the [returns and reimbursements guides](/docs/b## How to set up and use an envelope system with Actual Budget-Learning to budget using Actual Budget is straightforward, even-if you're new to budgeting. Here's a checklist for getting started:+Learning to budget using Actual Budget is straightforward, even+if you're new to budgeting. Here's a checklist for getting started:### 1. Establish budget categories-The first step is deciding which expense and income [categories to include in your budget](/docs/budgeting/categories).-Tailor each category to fit your specific budget and spending habits, giving you the power to customize+The first step is deciding which expense and income [categories to include in your budget](/docs/budgeting/categories).+Tailor each category to fit your specific budget and spending habits, giving you the power to customizethe system to your needs for the most accurate tracking.-Common categories might include general areas such as groceries, gas, clothing, entertainment, and savings.-Additionally, you can use Actual Budget for managing debt payments and long-term savings goals,+Common categories might include general areas such as groceries, gas, clothing, entertainment, and savings.+Additionally, you can use Actual Budget for managing debt payments and long-term savings goals,ensuring all aspects of your financial life are comprehensively covered.-Review the last three months of your bank statements to identify your categories. Look for recurring-expenses and income sources to determine which categories are necessary. This will give you a clear+Review the last three months of your bank statements to identify your categories. Look for recurring+expenses and income sources to determine which categories are necessary. This will give you a clearpicture of where your money goes and help you create a budget that reflects your spending patterns and financial goals.@@ -110,13 +110,13 @@ picture of where your money goes and help you create a budget that reflects your### 2. Allocate amounts to each category-Once you have identified the categories for your expenses and incomes, the next step is-to decide how much money to allocate to each category. This allocation ensures that+Once you have identified the categories for your expenses and incomes, the next step is+to decide how much money to allocate to each category. This allocation ensures thatevery part of your financial life is accounted for and helps you manage your money effectively.-A practical way to determine these amounts is to use the average of at least the last-three months' bank statements. Better yet, it is using the previous six months.-This average provides a realistic estimate of your spending and income patterns, allowing+A practical way to determine these amounts is to use the average of at least the last+three months' bank statements. Better yet, it is using the previous six months.+This average provides a realistic estimate of your spending and income patterns, allowingyou to set initial budget values that reflect your financial habits.@@ -124,23 +124,23 @@ For example, if you have € 1 200 to allocate for the month, your budget might| Categories | Allocated (budgeted) funds | Explanation ||-----------------|-----------------|---------------------------------------------------------------------|-| Groceries | € 300 | This covers your monthly food and household supplies. |-| Gas | € 100 | Allocated for fuel and transportation costs. |-| Dining Out | € 150 | Money set aside for eating out at restaurants or cafes. |-| Clothing | € 100 | Funds for purchasing new clothes or accessories. |-| Entertainment | € 150 | Budget for movies, hobbies, or other leisure activities. |-| Gifts | € 50 | Savings for birthdays, holidays, or special occasions. |+| Groceries | € 300 | This covers your monthly food and household supplies. |+| Gas | € 100 | Allocated for fuel and transportation costs. |+| Dining Out | € 150 | Money set aside for eating out at restaurants or cafes. |+| Clothing | € 100 | Funds for purchasing new clothes or accessories. |+| Entertainment | € 150 | Budget for movies, hobbies, or other leisure activities. |+| Gifts | € 50 | Savings for birthdays, holidays, or special occasions. || Personal Care | € 150 | Allocated for health and beauty products or services like haircuts. |-| Savings | € 200 | Money set aside for future needs or emergencies. |+| Savings | € 200 | Money set aside for future needs or emergencies. || **TOTAL** | **€ 1 200** | |-By carefully allocating amounts to each category, you create a clear and realistic budget to help you manage+By carefully allocating amounts to each category, you create a clear and realistic budget to help you manageyour finances more effectively and achieve your financial goals.-Remember, these initial values are not set in stone. As you start tracking your expenses, you might-find that some categories need more or less money. This flexibility empowers you to adjust your+Remember, these initial values are not set in stone. As you start tracking your expenses, you might+find that some categories need more or less money. This flexibility empowers you to adjust yourbudget as needed, putting you in control of your financial situation.@@ -149,60 +149,60 @@ budget as needed, putting you in control of your financial situation.### 3. Track your spending for each category-With your budget now allocated, the next step is to track your spending diligently.+With your budget now allocated, the next step is to track your spending diligently.This is essential for making the envelope system work effectively.-Each time you make a purchase, add the spending to Actual Budget. While this might seem-like a lot of work initially, it will significantly increase your awareness of your spending habits,+Each time you make a purchase, add the spending to Actual Budget. While this might seem+like a lot of work initially, it will significantly increase your awareness of your spending habits,enabling you to make informed decisions about what and how much to spend.-As you become more accustomed to this budgeting method, you can update Actual Budget less frequently,-such as once a week. This flexibility allows you to adapt the system to your lifestyle. Additionally,+As you become more accustomed to this budgeting method, you can update Actual Budget less frequently,+such as once a week. This flexibility allows you to adapt the system to your lifestyle. Additionally,if supported, you can set up automatic syncing with your bank to streamline the process.Here’s how to do it:-1. **Record every transaction**: Every time you spend money, whether it's buying groceries or paying for gas,- immediately enter the amount into Actual Budget under the appropriate category. This ensures that your budget+1. **Record every transaction**: Every time you spend money, whether it's buying groceries or paying for gas,+ immediately enter the amount into Actual Budget under the appropriate category. This ensures that your budgetis always up to date.-2. **Analyze spending habits**: Take time each week to review your spending. This will help you identify patterns and make+2. **Analyze spending habits**: Take time each week to review your spending. This will help you identify patterns and makeadjustments as needed. This proactive approach can prevent overspending and help you stay on track with your financial goals.-> **Tip**: You don't have to spend each category down to zero each month. If you have money left over, it-means you spent less than planned. Use any leftover funds to pay down debt or add to your emergency fund.+> **Tip**: You don't have to spend each category down to zero each month. If you have money left over, it+means you spent less than planned. Use any leftover funds to pay down debt or add to your emergency fund.Giving any extra money a purpose is key to ensuring the money doesn't go to waste.-By consistently tracking your spending and adjusting your budget as necessary, you'll maintain better control over+By consistently tracking your spending and adjusting your budget as necessary, you'll maintain better control overyour finances and work more effectively towards your financial goals.### 4. Adjust and adapt-Life is full of unexpected twists and turns; your budget should be just as flexible. When you overspend in a-budget category for the month, it’s crucial to adjust and adapt rather than feel defeated. As you adapt your plans+Life is full of unexpected twists and turns; your budget should be just as flexible. When you overspend in a+budget category for the month, it’s crucial to adjust and adapt rather than feel defeated. As you adapt your plansin real life, you can do the same with your budget.-Maybe an unexpected event arose, or you underestimated your expenses. The key is to remain flexible and make+Maybe an unexpected event arose, or you underestimated your expenses. The key is to remain flexible and makenecessary adjustments.**How to Adjust Your Budget**1. **Review your spending**: First, identify where you overspent. Look at your budget categories to see where adjustments are needed.-2. **Reallocate funds**: Move money from categories with surplus funds to cover the overspending. For example, if you budgeted € 100- for *Eating Out* but spent € 140, find another category with extra funds, like *Clothing* or *Entertainment,* and shift some+2. **Reallocate funds**: Move money from categories with surplus funds to cover the overspending. For example, if you budgeted € 100+ for *Eating Out* but spent € 140, find another category with extra funds, like *Clothing* or *Entertainment,* and shift someof that money to cover the difference.-3. **Stay calm and flexible**: Remember, the goal of budgeting is to manage your finances effectively, not to be perfect.+3. **Stay calm and flexible**: Remember, the goal of budgeting is to manage your finances effectively, not to be perfect.Flexibility is key. Adjusting your budget is a normal part of the process.-You can also set up Actual Budget to+You can also set up Actual Budget to[automatically deduct the overspending](/docs/budgeting/#rollover-negative-category-balances) from next month’s funds. Be aware thateven if you *can* do something, it does not mean that you *should* do it.-You maintain control over your budget by reallocating funds and avoiding unnecessary stress. This process helps+You maintain control over your budget by reallocating funds and avoiding unnecessary stress. This process helpsyou understand that budgets are not rigid constraints but flexible tools that can adapt to your changing needs.@@ -213,7 +213,7 @@ you understand that budgets are not rigid constraints but flexible tools that ca### 4. Prepare for the unexpected-There’s no such thing as a "normal" month when it comes to expenses. Your costs fluctuate throughout the year,+There’s no such thing as a "normal" month when it comes to expenses. Your costs fluctuate throughout the year,often unpredictably. Envelope budgeting helps you prepare for these irregular expenses by adding funds toyour categories.@@ -225,72 +225,72 @@ Many people face financial stress because of large, infrequent expenses that cat* Medical expenses* Home repairs-Without planning, these expenses can lead to financial crises, forcing you to dip into savings or debt.+Without planning, these expenses can lead to financial crises, forcing you to dip into savings or debt.Envelope budgeting encourages proactive saving, so you’re never caught off guard.-Some regular expenses you already know about. You can plan for those and set aside a smaller amount of money each-month to cover these rather than having to put up the larger amount when the bill comes.+Some regular expenses you already know about. You can plan for those and set aside a smaller amount of money each+month to cover these rather than having to put up the larger amount when the bill comes.**How to plan for irregular expenses**-1. **Identify Irregular Expenses**: Make a list of all large, infrequent expenses you expect throughout the year.+1. **Identify Irregular Expenses**: Make a list of all large, infrequent expenses you expect throughout the year.These could be anything from insurance premiums to holiday gifts.-2. **Break Down Annual Costs**: Calculate the total annual cost for each expense.-3. **Divide into Monthly Savings**: Divide the annual cost by 12 to determine how much you need to save each month.+2. **Break Down Annual Costs**: Calculate the total annual cost for each expense.+3. **Divide into Monthly Savings**: Divide the annual cost by 12 to determine how much you need to save each month.4. **Create Specific Categories**: For each irregular expense, set up specific categories in Actual Budget.Label them clearly, such as “Car Insurance,” “Holiday Gifts,” or “Home Repairs.”-5. **Allocate Funds Monthly**: Allocate the calculated amount to these categories each month. Treat this allocation+5. **Allocate Funds Monthly**: Allocate the calculated amount to these categories each month. Treat this allocationas a fixed expense to ensure you consistently save for these future costs.-**Example:** Let’s say your annual insurance costs are € 2 400. Instead of scrambling to find this amount when the bill-arrives, you can set aside € 200 each month. By the time the bill is due, you’ll have the total amount saved and ready,+**Example:** Let’s say your annual insurance costs are € 2 400. Instead of scrambling to find this amount when the bill+arrives, you can set aside € 200 each month. By the time the bill is due, you’ll have the total amount saved and ready,avoiding the need to dip into savings or incur debt.## Using Actual Budget with debit cards is better than using cash-While the traditional envelope system relies on cash, using Actual Budget with debit and credit+While the traditional envelope system relies on cash, using Actual Budget with debit and creditcards offers significant advantages. Here's why using cards can be more effective:-**Ease of tracking**: When you use debit or credit cards, all your transactions are automatically recorded-in your bank statement. Bank and credit card statements provide a detailed history of your-transactions, including the date, amount, and merchant. This makes it much easier to track your spending without-having (to remember) to manually enter each transaction whenever you make a purchase or get income.-Most financial institutions will let you export your transactions as CSV files,+**Ease of tracking**: When you use debit or credit cards, all your transactions are automatically recorded+in your bank statement. Bank and credit card statements provide a detailed history of your+transactions, including the date, amount, and merchant. This makes it much easier to track your spending without+having (to remember) to manually enter each transaction whenever you make a purchase or get income.+Most financial institutions will let you export your transactions as CSV files,which can be [imported into Actual Budget](/docs/transactions/importing). Using cards will save you time and reduce the risk of errors.-**Automatic import**: Actual Budget can [sync directly with your bank accounts](/docs/advanced/bank-sync).-Every time you use your debit or credit card, the transaction details are automatically imported into+**Automatic import**: Actual Budget can [sync directly with your bank accounts](/docs/advanced/bank-sync).+Every time you use your debit or credit card, the transaction details are automatically imported intoyour budget categories. You no longer need to keep physical receipts or manually log each expense.Read more about [managing credit cards](/docs/budgeting/credit-cards) with Actual Budget.-## A detailed example of how to do Zero-Sum budgeting+## A detailed example of how to do Zero-Sum budgeting-Let's say your total monthly income of January is € 1 200. You get your money on the 1st. Using Zero-Based Budgeting,-you will allocate every unit of this income to different categories, ensuring that nothing is left unassigned. This is known as+Let's say your total monthly income of January is € 1 200. You get your money on the 1st. Using Zero-Based Budgeting,+you will allocate every unit of this income to different categories, ensuring that nothing is left unassigned. This is known asthe *Total Allocation*.Here's an example of how you could split the € 1 200:| Categories | Income | Explanation ||-----------------|-----------------|---------------------------------------------------------------------|-| Groceries | € 300 | This covers your monthly food and household supplies. |-| Gas | € 100 | Allocated for fuel and transportation costs. |-| Dining Out | € 150 | Money set aside for eating out at restaurants or cafes. |-| Clothing | € 100 | Funds for purchasing new clothes or accessories. |-| Entertainment | € 150 | Budget for movies, hobbies, or other leisure activities. |-| Gifts | € 50 | Savings for birthdays, holidays, or special occasions. |+| Groceries | € 300 | This covers your monthly food and household supplies. |+| Gas | € 100 | Allocated for fuel and transportation costs. |+| Dining Out | € 150 | Money set aside for eating out at restaurants or cafes. |+| Clothing | € 100 | Funds for purchasing new clothes or accessories. |+| Entertainment | € 150 | Budget for movies, hobbies, or other leisure activities. |+| Gifts | € 50 | Savings for birthdays, holidays, or special occasions. || Personal Care | € 150 | Allocated for health and beauty products or services like haircuts. |-| Savings | € 200 | Money set aside for future needs or emergencies. |+| Savings | € 200 | Money set aside for future needs or emergencies. || **TOTAL** | **€ 1 200** | |-We now see that all € 1 200 are assigned to specific categories, ensuring that every unit of your income has a purpose.+We now see that all € 1 200 are assigned to specific categories, ensuring that every unit of your income has a purpose.### Week 1 budget tracking@@ -307,13 +307,13 @@ Let's track the expenses in Week 1 and calculate the available amounts for Week| Gifts | € 50 | € 45 | € 5 || Personal Care | € 150 | € 75 | € 75 |-In this table, the "Available in Week 2" column shows the remaining budget after subtracting the Week 1-spending from the initial budget. This helps you see how much you have left to spend in each category for+In this table, the "Available in Week 2" column shows the remaining budget after subtracting the Week 1+spending from the initial budget. This helps you see how much you have left to spend in each category forthe next week.### Week 2 budget tracking-In week 2 you, are invited to a housewarming party, and you want to bring a gift. In the *Available in Week 2* we+In week 2 you, are invited to a housewarming party, and you want to bring a gift. In the *Available in Week 2* wesaw that you only had € 5 to spend. This does not go a long way - but you found a gift costing only € 10.Let's track the expenses in Week 2 and calculate the available amounts for Week 3.@@ -328,15 +328,15 @@ Let's track the expenses in Week 2 and calculate the available amounts for Week| Gifts | € 5 | € 10 | € -5 || Personal Care | € 75 | € 40 | € 35 |-Now you are in deficit in the *Gift* category.+Now you are in deficit in the *Gift* category.-You should not really have a deficit in your budget, so you exercise the **Flexibility** principle by reducing money-from one of the other categories. You do not want to use your savings - as this is a **Goal**. *Dining out* is-not essential so you move 5 from *Available Week 2* into *Gifts*.+You should not really have a deficit in your budget, so you exercise the **Flexibility** principle by reducing money+from one of the other categories. You do not want to use your savings - as this is a **Goal**. *Dining out* is+not essential so you move 5 from *Available Week 2* into *Gifts*.### Updated week 3 availability-After adjusting the budget to address the deficit in the Gifts category by reallocating funds from Dining Out,+After adjusting the budget to address the deficit in the Gifts category by reallocating funds from Dining Out,here is the new available budget in Week 3:| Categories | Available Week 2 | Spending Week 2 | Available in Week 3 |@@ -344,7 +344,7 @@ here is the new available budget in Week 3:| Dining Out | € 135 | € 30 | € 105 || Gifts | € 5 | € 10 | € 0 |-This updated table reflects the reallocation of € 5 from the *Dining Out* category to cover the deficit in the *Gifts*+This updated table reflects the reallocation of € 5 from the *Dining Out* category to cover the deficit in the *Gifts*category, ensuring that all budgets remain positive in Week 3.### Week 3 budget tracking@@ -363,11 +363,11 @@ Let's track the expenses in Week 3 and calculate the available amounts for WeekNote that Personal Care is in deficit, so you must reallocate funds from another category to cover this deficit.-Luckily, this week, we won € 37 at the lottery. We will allocate all of these € 37 wisely. The most important thing is to take+Luckily, this week, we won € 37 at the lottery. We will allocate all of these € 37 wisely. The most important thing is to takecare of the deficit. We now exercise both the *Flexibility* and the *Total Allocation* principles.-What do we do with the rest of the money we won? We can add them to the Savings category. We see that we are-probably going to spend more than 16 on Groceries - and there are no more parties which requires Gifts in the coming week.+What do we do with the rest of the money we won? We can add them to the Savings category. We see that we are+probably going to spend more than 16 on Groceries - and there are no more parties which requires Gifts in the coming week.We decide to split the rest of the money between Groceries and Savings.@@ -382,10 +382,10 @@ We decide to split the rest of the money between Groceries and Savings.| Personal Care | € 35 | € 38 | € +3 | € 0 || Savings | € 200 | € 0 | € +10 | € 210 |-In this revised table, the deficit in Personal Care has been addressed, and the remaining lottery money has been allocated+In this revised table, the deficit in Personal Care has been addressed, and the remaining lottery money has been allocatedto Groceries and Savings to better prepare for the coming week.-### Week 4 budget tracking+### Week 4 budget trackingLet's track the expenses in Week 4 and calculate the available amounts for next month@@ -402,11 +402,11 @@ Let's track the expenses in Week 4 and calculate the available amounts for next### Preparing for February: Learnings About Our Spending Habits in January-- We had to adjust the Groceries budget when we won the lottery. Without this, we would have had a deficit in this category.+- We had to adjust the Groceries budget when we won the lottery. Without this, we would have had a deficit in this category.Therefore, we need to increase next month's budget for Groceries.- We used more money than was allocated for gifts, so we should increase the budget for this category next month.- We spent much less on Dining Out than we allocated, so we can reduce this budget for February.-- We will also increase the Gas budget by € 10 because if we had to fill gas in week 4, we would have faced a+- We will also increase the Gas budget by € 10 because if we had to fill gas in week 4, we would have faced adeficit and need to cover it from other categories.The rest we put into our Savings category@@ -421,22 +421,22 @@ The rest we put into our Savings category| Gifts | € 0 | € 75 | € 75 || Personal Care | € 0 | € 150 | € 150 |-The sum of to be allocated is € 975. The monthly income for February is € 1200.-€ 1200 - € 975 = € 225 is added to the Savings category. This is € 25 more than last month.+The sum of to be allocated is € 975. The monthly income for February is € 1200.+€ 1200 - € 975 = € 225 is added to the Savings category. This is € 25 more than last month.A job well done of not overspending more than necessary!-This revised budget considers the adjustments based on our spending habits in January,+This revised budget considers the adjustments based on our spending habits in January,ensuring a more accurate and adequate budget for February| Categories | Available at the start of February ||-----------------|------------------------|-| Groceries | € 350 |-| Gas | € 110 |-| Dining Out | € 150 |-| Clothing | € 100 |-| Entertainment | € 150 |-| Gifts | € 75 |+| Groceries | € 350 |+| Gas | € 110 |+| Dining Out | € 150 |+| Clothing | € 100 |+| Entertainment | € 150 |+| Gifts | € 75 || Personal Care | € 150 |diff --git a/docs/getting-started/roadmap-for-new-users.md b/docs/getting-started/roadmap-for-new-users.mdindex 008b30f03b..b0f036a63b 100644--- a/docs/getting-started/roadmap-for-new-users.md+++ b/docs/getting-started/roadmap-for-new-users.md@@ -14,20 +14,20 @@ Please take a look at our [Tour of Actual](/docs/tour/).## I want to test out Actual without committing to any work or installations.-It's as simple as [trying our demo](https://demo.actualbudget.org/budget).+It's as simple as [trying our demo](https://demo.actualbudget.org/budget).There are no strings attached; it's just a chance to explore Actual.## I want to run Actual on my computer.-If you plan to use Actual on a single computer and don't need it on your mobile or tablet,+If you plan to use Actual on a single computer and don't need it on your mobile or tablet,you can [download the stand-alone software](https://github.com/actualbudget/actual/releases).## I want the complete package but do not know how to run a server.-In this case, you can use a service provider called PikaPods. Setup only takes a few minutes.-We have written a thorough [step-by-step guide for PikaPods](/docs/install/pikapods).+In this case, you can use a service provider called PikaPods. Setup only takes a few minutes.+We have written a thorough [step-by-step guide for PikaPods](/docs/install/pikapods).However, if you are adventurous or somewhat technical, please go directly to the [Actual Budget setup in PikaPod](https://www.pikapods.com/pods?run=actual).diff --git a/docs/getting-started/starting-fresh.md b/docs/getting-started/starting-fresh.mdindex 62a3017e4f..163cd48c92 100644--- a/docs/getting-started/starting-fresh.md+++ b/docs/getting-started/starting-fresh.md@@ -3,11 +3,11 @@ title: 'Starting Fresh'---For most users it's best to start fresh with a blank file.This guide will walk through setting up a budget file fresh without migrating from a previous budget software export.-Before continuing, it might be a good idea to read about the [envelope method](/docs/getting-started/envelope-budgeting), or zero-sum+Before continuing, it might be a good idea to read about the [envelope method](/docs/getting-started/envelope-budgeting), or zero-sumbudgeting as it's also called.## 1. Setting up Accounts-It is recommended to add all accounts you have to Actual.+It is recommended to add all accounts you have to Actual.This includes all savings, checking, and investment accounts.These accounts should match what shows up in your Bank or Credit Union.For example, if you have a savings, checking, and credit card account with Bank of America, add each as a separate account in Actual.@@ -29,9 +29,9 @@ It is usually easier, and more flexible, to place them on budget.#### Considerations for Off Budget Savings* Your savings is less tempting to borrow from since it is not visible in your budget-* Any time you transfer to/from your savings, you need to categorize that transaction. This sometimes causes confusion since the money wasn't spent+* Any time you transfer to/from your savings, you need to categorize that transaction. This sometimes causes confusion since the money wasn't spent-In some situations it may make sense to put a credit card account off budget.+In some situations it may make sense to put a credit card account off budget.This is generally not recommended unless you are not using that card for any spending and are exclusively paying it off.### How to Setup Accounts@@ -59,7 +59,7 @@ The process of reconciling your account can be found on [the reconciliation page## 2. Handling cash-Suppose you do not exclusively use debit and credit cards but also need to keep some cash around. In that case,+Suppose you do not exclusively use debit and credit cards but also need to keep some cash around. In that case,you manage this by creating an account called Cash, which you treat as any other bank account.@@ -78,7 +78,7 @@ If you aren't sure what categories you need, Actual will start you with a few ba* **Savings**: Funds you have saved, or are going to transfer to an off budget savings account* **General**: Everything else-Some other common categories you could add would be rent/mortgage, taxes, eating out, specific utilities,+Some other common categories you could add would be rent/mortgage, taxes, eating out, specific utilities,subscription services, charitable donations, child care, gifts, fun money, or debt payment.:::tip@@ -98,51 +98,51 @@ Maybe you have multiple income streams, make a category for each one.You may also want a category for interest and dividends.### Group your expense categories-Actual has a nifty and useful feature where you can organize your expense categories into groups.-This not only provides more visibility and control over your spending but also empowers you+Actual has a nifty and useful feature where you can organize your expense categories into groups.+This not only provides more visibility and control over your spending but also empowers youto make informed financial decisions.-When using the [envelope method](/docs/getting-started/envelope-budgeting), one will move available funds between categories when-needed. However, there are some categories that you should be very wary about moving funds away+When using the [envelope method](/docs/getting-started/envelope-budgeting), one will move available funds between categories when+needed. However, there are some categories that you should be very wary about moving funds awayfrom. By grouping, you'll get an extra visual indication that moving funds from the Electricity-category, for instance, may not be the wisest choice. Another reason is to have a more convenient+category, for instance, may not be the wisest choice. Another reason is to have a more convenientway of reporting your spending habits.-1. **Crucial or really important**. As the name suggests, these expenses are-difficult or impossible to reduce or remove from your daily life. Most of these are reoccurring-bills, either monthly, quarterly or yearly. Many of the categories in this group have fixed amounts,-or the amount does not fluctuate too much over the course of a year. Example of spending categories-in this group are Rent, Mortgage, Insurance, Internet, Electricity, Property tax, etc. You can not-stop paying your rent, mortgage or property taxes - because you'll be out of a place to live.+1. **Crucial or really important**. As the name suggests, these expenses are+difficult or impossible to reduce or remove from your daily life. Most of these are reoccurring+bills, either monthly, quarterly or yearly. Many of the categories in this group have fixed amounts,+or the amount does not fluctuate too much over the course of a year. Example of spending categories+in this group are Rent, Mortgage, Insurance, Internet, Electricity, Property tax, etc. You can not+stop paying your rent, mortgage or property taxes - because you'll be out of a place to live.Stopping paying insurance is dumb. It is near impossible to live without electricity, or Internet.-2. **Debt**. Create a separate category group if you have more than one kind of debt. Typical-categories in this group are Mortgage, Car Payments, Student Loans, Short Term Credit.-Should you put your credit card debts in this category?+2. **Debt**. Create a separate category group if you have more than one kind of debt. Typical+categories in this group are Mortgage, Car Payments, Student Loans, Short Term Credit.+Should you put your credit card debts in this category?The answer is *it depends*. For some input on this, please read our article on-[Carrying Debt](/docs/budgeting/credit-cards/carrying-debt).+[Carrying Debt](/docs/budgeting/credit-cards/carrying-debt).-3. **Daily expenses**. Group your everyday expenses for a more organised and convenient way-of tracking. This makes it easy to report on expenditures that fluctuate from month to month.-Examples of spending categories in this group are Groceries, Household Items, Fuel, Eating Out, Clothing,+3. **Daily expenses**. Group your everyday expenses for a more organised and convenient way+of tracking. This makes it easy to report on expenditures that fluctuate from month to month.+Examples of spending categories in this group are Groceries, Household Items, Fuel, Eating Out, Clothing,Personal Care, Gifts, Entertainment, Streaming services, News (paper) subscriptions, and Charities.-4. **For a rainy day**. Certain expenses you know will happen in the future, but you don't know when.-You should have at least one category named *Emergency Fund*. Other examples may be Car Maintenance,-Replacing Stove, and Replacing Washing Machine.+4. **For a rainy day**. Certain expenses you know will happen in the future, but you don't know when.+You should have at least one category named *Emergency Fund*. Other examples may be Car Maintenance,+Replacing Stove, and Replacing Washing Machine.-5. **Savings goals**. This is where you keep your savings goals categorised *on budget*. What we-mean by on budget is that if you need to reallocate money, you may settle for a cheaper Vacation or-postpone the Car Replacement or the Bathroom Renovation for a few months. If you are saving for a-long view, like your retirement, we suggest you create an *off budget* account for those kind of-savings. Money allocated in off budget accounts takes more effort to reallocate as you need to-move the actual funds from your savings account or sell your stocks or global+5. **Savings goals**. This is where you keep your savings goals categorised *on budget*. What we+mean by on budget is that if you need to reallocate money, you may settle for a cheaper Vacation or+postpone the Car Replacement or the Bathroom Renovation for a few months. If you are saving for a+long view, like your retirement, we suggest you create an *off budget* account for those kind of+savings. Money allocated in off budget accounts takes more effort to reallocate as you need to+move the actual funds from your savings account or sell your stocks or globalindex funds (a few examples of long term saving methods).-The main difference between For a Rainy Day and Savings goals is that rainy day categories are *a must*.+The main difference between For a Rainy Day and Savings goals is that rainy day categories are *a must*.In contrast, savings categories are *nice to have or wants*.Of course, your own experiences and approach to saving for a rainy day or longer-term savings may vary.@@ -156,29 +156,29 @@ When making categories remember that it is easier to merge categories later than## 4. Assigning Available Funds-The big question everybody struggles with when using the envelope budgeting method for the first-time is *how much money to assign to each category*. Fear not; this part of our Starting Fresh+The big question everybody struggles with when using the envelope budgeting method for the first+time is *how much money to assign to each category*. Fear not; this part of our Starting Freshguide will help you with this.-The best way of bootstrapping your budget is to rely on how you have spent your money and what-income you have had in the last three months. It's even better if you can do this for the last six+The best way of bootstrapping your budget is to rely on how you have spent your money and what+income you have had in the last three months. It's even better if you can do this for the last sixor twelve months.-If you use cash for your daily spending, the available funds in those categories will be-challenging to assess. You can get some ideas on how much by looking at cash withdrawals on your-bank statements.+If you use cash for your daily spending, the available funds in those categories will be+challenging to assess. You can get some ideas on how much by looking at cash withdrawals on your+bank statements.For bills, your bank or credit card statements are good sources to establish your budget numbers.### Use a spreadsheet to find your initial budget numbers-You enter all your expenses in a spreadsheet, summarise them per month, and then calculate the average.-Now, you know what you need to budget per-month. Having the budgeted numbers somewhat higher than the calculated average might be a good idea.+You enter all your expenses in a spreadsheet, summarise them per month, and then calculate the average.+Now, you know what you need to budget per+month. Having the budgeted numbers somewhat higher than the calculated average might be a good idea.-This way, you add small buffers in each category as prices rise; the same goes for your rent and mortgage.-Adding some extra, albeit small, paddings along the way means you are better suited when this happens.+This way, you add small buffers in each category as prices rise; the same goes for your rent and mortgage.+Adding some extra, albeit small, paddings along the way means you are better suited when this happens.The only certainty we have in this day and age is that price increases will occur.@@ -189,10 +189,10 @@ We can now see the budget numbers to be used for the month of August in the Aver### Using Actual to find your initial budget numbers-It's important to note that this method only works correctly if you use a debit or credit card for all your purchases.+It's important to note that this method only works correctly if you use a debit or credit card for all your purchases.As a result, your actual *start date* for your budget is in the past. We will reiterate our warning on[how to set up accounts](#how-to-setup-accounts): going too far back might make your budget completely-out of wack. It's crucial to avoid this, as you can easily spend more time trying to find out what's+out of wack. It's crucial to avoid this, as you can easily spend more time trying to find out what'swrong with your budget and spent numbers because "nothing adds up" anymore.@@ -204,13 +204,13 @@ If you have a lot of cash withdrawals during a month, you will be better off usi1. You start the budget by entering or importing your transactions.-2. In the Budget view, you enter the same amount in the *Budgeted* columns as found in the *Spent* columns+2. In the Budget view, you enter the same amount in the *Budgeted* columns as found in the *Spent* columnsfor all the months you have entered or imported your data.-You have two easy ways to populate the various budget values when this is done.+You have two easy ways to populate the various budget values when this is done.You can apply the last three months' average on all budget categories:@@ -224,7 +224,7 @@ You can also set specific categories to various averages:### What to do if you do not want to, or can't, use historical data-Budgeting, even without historical data, can help you gain control over your+Budgeting, even without historical data, can help you gain control over yourfinances, reduce stress, and achieve your financial goals. It just takes alittle bit of effort to get going.@@ -232,32 +232,32 @@ You can start using Actual without actually assigning your available funds beforbudgeting.-1. Record every transaction you make daily. If you do it weekly, the chances are that you will have- forgotten some cash transactions. One way to avoid forgetting transactions is, of course,+1. Record every transaction you make daily. If you do it weekly, the chances are that you will have+ forgotten some cash transactions. One way to avoid forgetting transactions is, of course,to keep all receipts.-2. Take special notice of when you use cash. Petty cash transactions are easy to overlook,- but all those daily chocolates for "only" 0.50 and all those coffees for "only" 10 add up- over a month. If you repeatedly make cash withdrawals and do not know what you are spending+2. Take special notice of when you use cash. Petty cash transactions are easy to overlook,+ but all those daily chocolates for "only" 0.50 and all those coffees for "only" 10 add up+ over a month. If you repeatedly make cash withdrawals and do not know what you are spendingyour money on, then no expense and budget tracking tools in the world will be able to help you.-3. At the end of each week, set the *Budgeted* column in the Budget view to the same value- as what you see in the *Spent* column. If done correctly, the sum under *To Budget* should+3. At the end of each week, set the *Budgeted* column in the Budget view to the same value+ as what you see in the *Spent* column. If done correctly, the sum under *To Budget* shouldcorrectly tell you how much money you have left.-4. Set aside time to analyse your spending and income at the end of the month. Based on this,+4. Set aside time to analyse your spending and income at the end of the month. Based on this,you can add values to the upcoming months' Budgeted column.-Remember, this process is challenging, and it's okay if you don't get everything right-in the first few months. The key is to keep going, keep learning, and keep adjusting.+Remember, this process is challenging, and it's okay if you don't get everything right+in the first few months. The key is to keep going, keep learning, and keep adjusting.With persistence, you will reach your budgeting goals.## 5. Keep Budgeting-Now that you've set your accounts, categories, and budget values, it's time for the fun part of budgeting!+Now that you've set your accounts, categories, and budget values, it's time for the fun part of budgeting!Actual uses a style of budgeting called Zero-Sum Budgeting, or the more common name*envelope budgeting*.@@ -265,8 +265,8 @@ Actual uses a style of budgeting called Zero-Sum Budgeting, or the more common nShortly this method goes like this:1. Allocate all available funds (income) into your categories whenever you get income.-2. Track your spending in each category. Every time a new transaction is entered into Actual- (either manually or by importing from your bank statements), your process should+2. Track your spending in each category. Every time a new transaction is entered into Actual+ (either manually or by importing from your bank statements), your process shouldlook something like this:1. Give that transaction a category.2. If you have enough money budgeted for that category, you're done!@@ -286,9 +286,9 @@ This topic is so important on how to actually use Actual, that we have devoted a## The next step in your budgeting journey-A good next step is to read through the "Using Actual" section of the documentation. This section has detailed explainers on the-features of Actual and how to use them. Some of the most useful features are [Rules](/docs/budgeting/rules/index.md),-[Schedules](/docs/schedules.md), [Reconciliation](/docs/accounts/reconciliation.md),+A good next step is to read through the "Using Actual" section of the documentation. This section has detailed explainers on the+features of Actual and how to use them. Some of the most useful features are [Rules](/docs/budgeting/rules/index.md),+[Schedules](/docs/schedules.md), [Reconciliation](/docs/accounts/reconciliation.md),and [Reports](/docs/reports/index.md).diff --git a/docs/getting-started/sync.md b/docs/getting-started/sync.mdindex c7e3792f5c..6da3eb9a6a 100644--- a/docs/getting-started/sync.md+++ b/docs/getting-started/sync.md@@ -1,6 +1,6 @@# Syncing Across Devices-Actual is a different kind of app. It stores all of your data on your installed Actual server by default AND it stores all of your data on your local device. That means it works regardless of your network connection, and you always have direct access to your data. Your data never goes to any external servers that you don't choose. It's your data, and you're in control.+Actual is a different kind of app. It stores all of your data on your installed Actual server by default AND it stores all of your data on your local device. That means it works regardless of your network connection, and you always have direct access to your data. Your data never goes to any external servers that you don't choose. It's your data, and you're in control.We don't want to throw away the internet though. It's too useful. You can set up your server to access it through a VPN or through the wider internet. The choice is yours. You can access it from any device easily, and you never have to worry about losing your data in case you drop your laptop or phone into a lake.diff --git a/docs/getting-started/tips-tricks.md b/docs/getting-started/tips-tricks.mdindex e93f44a8ac..175e0bef1f 100644--- a/docs/getting-started/tips-tricks.md+++ b/docs/getting-started/tips-tricks.md@@ -14,7 +14,7 @@ Firstly, a few global shortcuts for the Electron App that is still in developmen- <Key mod="cmd" k="1" /> will show the budget- <Key mod="cmd" k="2" /> will show reports- <Key mod="cmd" k="3" /> will show all accounts-+BUT here is one that WILL work in the web app as well:- <Key mod="cmd" k="O" /> (O not zero) this will close the file and list other available files to opendiff --git a/docs/index.md b/docs/index.mdindex 8925d08eed..ef1661e391 100644--- a/docs/index.md+++ b/docs/index.md@@ -4,16 +4,16 @@ sidebar_position: 1title: 'Introduction'----Welcome to Actual’s documentation! This page provides you a quick introduction to Actual Budget and will help you navigate to the documentation to learn more about Actual.+Welcome to Actual’s documentation! This page provides you a quick introduction to Actual Budget and will help you navigate to the documentation to learn more about Actual.## Where to Begin?-If you're new to Actual, but do not know where to start, please consult the [roadmap for new users](/docs/getting-started/roadmap-for-new-users.md).+If you're new to Actual, but do not know where to start, please consult the [roadmap for new users](/docs/getting-started/roadmap-for-new-users.md).-You can also try to [install Actual](./install/index.md) on a computer to start.-After installation, check out the [Tour of Actual](./tour/index.md) for a-high-level overview of how Actual works. The next step is to read our-[Starting Fresh](/docs/getting-started/starting-fresh) guide.+You can also try to [install Actual](./install/index.md) on a computer to start.+After installation, check out the [Tour of Actual](./tour/index.md) for a+high-level overview of how Actual works. The next step is to read our+[Starting Fresh](/docs/getting-started/starting-fresh) guide.Then we suggest dive into the more detailed documentation, check out the “Using Actual” section in the left menu.For help and support, [reach out to the maintainers and community](/contact).diff --git a/docs/install/index.md b/docs/install/index.mdindex 9f71a689d3..b7cdf9d746 100644--- a/docs/install/index.md+++ b/docs/install/index.md@@ -1,6 +1,6 @@# Installing Actual-The Actual Budget project is made up of two parts: the client and the server. A server is not required for Actual to function but it is strongly recommended as it provides increased functionality. Below is a table of features of Actual and if those features work with just a client or if a server is needed.+The Actual Budget project is made up of two parts: the client and the server. A server is not required for Actual to function but it is strongly recommended as it provides increased functionality. Below is a table of features of Actual and if those features work with just a client or if a server is needed.| Feature | Without Server | Needs Server ||:-|:-:|:-:|@@ -13,13 +13,13 @@ The Actual Budget project is made up of two parts: the client and the server. A| Use bank syncing (GoCardless or SimpleFIN)| | X || Use the Actual API | | X |-The standard way of using Actual is to set up a personal server and use a web browser for the application. For quick testing or getting to know Actual before setting up a server, the [demo](https://demo.actualbudget.org) or a [desktop application](https://github.com/actualbudget/actual/releases) are a good place to start.+The standard way of using Actual is to set up a personal server and use a web browser for the application. For quick testing or getting to know Actual before setting up a server, the [demo](https://demo.actualbudget.org) or a [desktop application](https://github.com/actualbudget/actual/releases) are a good place to start.## Using Actual locally in the browser-If you are okay with not having sync, auto-save, or backups then the easiest and fastest way to get started is by using the Actual [web app](https://app.actualbudget.org). This solution requires less setup but more maintenance.+If you are okay with not having sync, auto-save, or backups then the easiest and fastest way to get started is by using the Actual [web app](https://app.actualbudget.org). This solution requires less setup but more maintenance.-All data is saved to your local browser. The Actual web app never has access to any of your personal data. It is recommended that you save your data (from the [settings](../backup-restore/backup) menu) after every session. If your browser memory is cleared, your data will be lost, so a backup is crucial.+All data is saved to your local browser. The Actual web app never has access to any of your personal data. It is recommended that you save your data (from the [settings](../backup-restore/backup) menu) after every session. If your browser memory is cleared, your data will be lost, so a backup is crucial.Using a new device or browser requires you to [import](../migration/actual-import#import-backup-file) the saved file for each new device or browser. Remember that these new devices and browsers will not sync without a server set up, so anything you modify on one browser will not appear on others.@@ -31,14 +31,14 @@ This solution is not recommended for long-term use due to the maintenance requir## Server-Optional Client Options-Desktop applications are available for Windows, Mac, and Linux. These can be [downloaded from GitHub](https://github.com/actualbudget/actual/releases). The desktop apps have the following benefits:+Desktop applications are available for Windows, Mac, and Linux. These can be [downloaded from GitHub](https://github.com/actualbudget/actual/releases). The desktop apps have the following benefits:* Can connect to a server (this gives them the ability to use the server-based features)* Automated backups-* Offline use is ready out of the box+* Offline use is ready out of the box## Server-Based Client Options-The server provides a web-based version of Actual. This web app can be used in a browser as a standard web page to view and edit your budget. The web page can also be installed on your device. For mobile devices, an installed web page will work offline.+The server provides a web-based version of Actual. This web app can be used in a browser as a standard web page to view and edit your budget. The web page can also be installed on your device. For mobile devices, an installed web page will work offline.## Running a Server@@ -70,4 +70,4 @@ Content contained on external links is not managed or maintained by the Actual B- [UnRAID SSL Setup](https://discord.com/channels/937901803608096828/1158941114603155477) - this guide is found at our Discord[^1]: You technically don't need a server instance for this. You need to run either a web-based client or a server, but a server is the same effort.-[^2]: A portion of the cost to host on PikaPods is donated to the Actual Budget Project. With that said, PikaPods is a very simple, and cost-effective way to host your server.+[^2]: A portion of the cost to host on PikaPods is donated to the Actual Budget Project. With that said, PikaPods is a very simple, and cost-effective way to host your server.diff --git a/docs/install/local.md b/docs/install/local.mdindex 571aa35146..8cf4877bfe 100644--- a/docs/install/local.md+++ b/docs/install/local.md@@ -1,12 +1,12 @@# Local Installation-The easiest way to get Actual running locally is to use [actual-server](https://github.com/actualbudget/actual-server).+The easiest way to get Actual running locally is to use [actual-server](https://github.com/actualbudget/actual-server).Actual server is used for syncing changes across devices. It comes with the latest version of the [Actual web client](https://github.com/actualbudget/actual).## Prerequisites-- The Actual server requires Node.js v18 or greater. You can download and install the latest version of Node.js from [Node.js website](https://nodejs.org/en/download) (we recommend downloading the “LTS” version).+- The Actual server requires Node.js v18 or greater. You can download and install the latest version of Node.js from [Node.js website](https://nodejs.org/en/download) (we recommend downloading the “LTS” version).- If you're on Windows, during installation of Node.js, be sure to select _Automatically install the necessary tools_ from the _Tools for Native Modules_ page. This is required to build better-sqlite3. If you missed this when you installed Node.js, double-click ```C:\Program Files\nodejs\install_tools.bat``` from the File Explorer or run it in a terminal.- Consider using a tool like [nvm](https://github.com/nvm-sh/nvm) or [asdf](https://asdf-vm.com) to install and manage multiple versions of Node.js.- You’ll also need to have Git installed. The Git website has [instructions for downloading and working with Git for all supported operating systems](https://git-scm.com/download).@@ -42,7 +42,7 @@ Note that if you restart your computer, you’ll have to run this command again## Accessing Actual-After the server has been started, you can access Actual using your browser at [http://localhost:5006](http://localhost:5006).+After the server has been started, you can access Actual using your browser at [http://localhost:5006](http://localhost:5006).When accessing Actual for the first time, you may be prompted to provide a URL for the server. For a local installation, click the **Use localhost:5006** button to use the server you've [configured](https://actualbudget.org/docs/config/).diff --git a/docs/install/pikapods.md b/docs/install/pikapods.mdindex 297b255195..c331d4d923 100644--- a/docs/install/pikapods.md+++ b/docs/install/pikapods.md@@ -6,10 +6,10 @@ title: 'PikaPods'[PikaPods](https://www.pikapods.com/) offers one click "instant open source app hosting", allowingyou to run Actual for less than $ 1.50 per month (as of July 2024).-Using PikaPods is also a simple way to support the development of Actual Budget, as PikaPods will+Using PikaPods is also a simple way to support the development of Actual Budget, as PikaPods willshare some of its revenues with Actual for customers using their Actual Budget pods.-You get a $ 5.00 credit when you sign up, which means that you should be able to run Actual for+You get a $ 5.00 credit when you sign up, which means that you should be able to run Actual forover 3 months before your credit runs out.For web clients, Pikapods will automatically update anywhere from a couple of days to a week after the latest monthly release is deployed. This is because Pikapods tests each new release before deploying it.@@ -19,19 +19,19 @@ We suggest first checking on the web client if Pikapods has updated, then reinst## Deploying Actual on PikaPods-If you are technically inclined, just [Click here to create an account and run Actual on PikaPods](https://www.pikapods.com/pods?run=actual).+If you are technically inclined, just [Click here to create an account and run Actual on PikaPods](https://www.pikapods.com/pods?run=actual).You can leave the resources at their lowest setting (although you will need a non-zero amount of storage for your budget files)._Actual does almost all of its computation in your browser, so purchasing more resources for the server won’t necessarily result in a better experience_-After you have set up your Pod, head over to our [Starting Fresh](/docs/getting-started/starting-fresh) guide to get started with+After you have set up your Pod, head over to our [Starting Fresh](/docs/getting-started/starting-fresh) guide to get started withActual Budget.## A step by step guide to setting up Actual Budget with PikaPods-[Click here to go to PikaPods setup for Actual](https://www.pikapods.com/pods?run=actual).+[Click here to go to PikaPods setup for Actual](https://www.pikapods.com/pods?run=actual).You will be greeted with the following screen.@@ -44,7 +44,7 @@ Click on the **register** link inside the blue banner, which will take you to th## The user registration screenThis screen is self-explanatory, but a kind reminder is to use a password only you know.-You will need to use a working email address, as you will receive an email with a link you need+You will need to use a working email address, as you will receive an email with a link you needto click on to complete the signup process.@@ -52,7 +52,7 @@ to click on to complete the signup process.## Verification email-By clicking the green button saying **Activate and Login**, you are now registered as+By clicking the green button saying **Activate and Login**, you are now registered asa PikaPods customer. You will be returned to the login screen.@@ -65,7 +65,7 @@ Enter the email address and password you registered yourself with.-## Naming your Pod+## Naming your PodA simplistic explanation of a Pod in layperson's terms is that *a Pod is a very tiny computer running in the cloud*.Typically, a Pod only runs one application - like Actual Budget.@@ -88,10 +88,10 @@ Pod.## Assigning storage to your Pod-The minimum storage you can assign to your Pod is 10 GB (gigabytes). We promise you+The minimum storage you can assign to your Pod is 10 GB (gigabytes). We promise youthat this is more than enough for your budget purposes.-Example: With around 1,200 transactions, 18 months of budgeting, and approximately 200 rules and payees,+Example: With around 1,200 transactions, 18 months of budgeting, and approximately 200 rules and payees,it takes around 33 megabytes of storage. 10 gigabytes equals 10,000 megabytes, equivalent to 303 18-month budgets.Your Pod will be created when you click on the green **ADD POD* button. This step takes less than one minute.@@ -102,7 +102,7 @@ Your Pod will be created when you click on the green **ADD POD* button. This ste## Your pod is now ready to be used-When you click on the green **OPEN POD** button you will be taken to your Pod.+When you click on the green **OPEN POD** button you will be taken to your Pod.The address for your Actual Budget is found in the Domain field. In the screenshot example, this is`https://berserk-bullmastiff.pikapod.net/budget/`. Yours will be something completely different.@@ -113,10 +113,10 @@ The address for your Actual Budget is found in the Domain field. In the screensh## Setting a password for your Actual Budget-Before you can start using Actual, you need to set a password for your server. This password is used+Before you can start using Actual, you need to set a password for your server. This password is usednext time you log into your server - and should never be the same as your PikaPods account password.-Keep this password safe, as it cannot be retrieved. If you forget your server password, you will not+Keep this password safe, as it cannot be retrieved. If you forget your server password, you will notbe able to retrieve your budget.@@ -125,6 +125,6 @@ be able to retrieve your budget.## Getting started with using Actual Budget-Go to our [Starting Fresh](/docs/getting-started/starting-fresh) guide to get started with+Go to our [Starting Fresh](/docs/getting-started/starting-fresh) guide to get started withActual Budget.diff --git a/docs/migration/nynab.md b/docs/migration/nynab.mdindex bf5b623728..5b56fc6689 100644--- a/docs/migration/nynab.md+++ b/docs/migration/nynab.md@@ -80,7 +80,7 @@ This is affectively the same thing nYNAB does, but in a manual form.To `hold` the leftover funds for the next month follow these steps:1. Click on your `To Budget` value for the month.2. Select `Hold for next month`.-3. Fill in how much you would like to reserve for the future. By default the current `To Budget` value is filled in. Using this value will bring your `To Budget` to zero.+3. Fill in how much you would like to reserve for the future. By default the current `To Budget` value is filled in. Using this value will bring your `To Budget` to zero.4. Click `Hold`.4. Repeat for all desired months.diff --git a/docs/reports/custom-reports.md b/docs/reports/custom-reports.mdindex 3fe9c20355..bb39244e6f 100644--- a/docs/reports/custom-reports.md+++ b/docs/reports/custom-reports.md@@ -1,6 +1,6 @@# Custom Reports-Custom reports allow analyzing transaction data by using charts or a data table with summary statistics. The following types of reports are available:+Custom reports allow analyzing transaction data by using charts or a data table with summary statistics. The following types of reports are available:1. Table View2. Bar Graph@@ -31,7 +31,7 @@ Under Options, reports behavior can be changed* Show hidden categories will enable Categories marked as hidden in the Budget page* Show empty rows will show items chosen in Split with 0 value-* Show off budget enables two categories:+* Show off budget enables two categories:* Transfers: include all transfer across For budget account. Transfer from For budget to Off budget are not counted.* Off budget: include all transactions in Off budget accounts. Transfers from For budget to Off budget are not counted.* Show uncategorized will show transactions which have not been assigned a category@@ -41,7 +41,7 @@ Greyed out options in dropdown menus are not yet available for the chosen report## Center Menu-Icons in the first group of the center menu are used to select the displayed report, the second group is used to show graph legends, summary and labels. The funnel icon can be used to [filter transactions](/docs/transactions/filters.md). Finally, the menu on the right-hand side is used to Save a Custom Report to the Reports page.+Icons in the first group of the center menu are used to select the displayed report, the second group is used to show graph legends, summary and labels. The funnel icon can be used to [filter transactions](/docs/transactions/filters.md). Finally, the menu on the right-hand side is used to Save a Custom Report to the Reports page.@@ -51,7 +51,7 @@ A custom report can be saved by using the menu on the right-hand side. If a save-Saved reports will be shown in the Report page in alphabetical order.+Saved reports will be shown in the Report page in alphabetical order.@@ -60,7 +60,7 @@ Saved reports will be shown in the Report page in alphabetical order.Custom Reports are really powerful and can provide unique insights. We now highlight a complex example that uses most features. Our goal is to have a stacked bar chart broken down by group with month on X axis, in a certain time frame, excluding a certain category and payee.* Select Bar Graph and set Time Mode-* Select Split by Group+* Select Split by Group* Use the Live Date filter and set Year to date as a Range* Click on the checkbox next to Savings to exclude from the sum* Click on the Filter icon, select Payee is not "Movies"diff --git a/docs/schedules.md b/docs/schedules.mdindex 9164130a02..f511258e31 100644--- a/docs/schedules.md+++ b/docs/schedules.md@@ -4,11 +4,11 @@Schedules can be used to enter anticipated transactions early. Some of the available options to tailor schedules to your needs are:-1. Set to be recurring or only entered once-2. Set to be automatically entered into the account register or choose to manually approve entries-3. Options for recurring entries for multiple specific days of the month.+1. Set to be recurring or only entered once+2. Set to be automatically entered into the account register or choose to manually approve entries+3. Options for recurring entries for multiple specific days of the month.1. A single schedule can be created for a Cell phone plan that has multiple users and different payment cycles for each phone. If you have 3 cell phones that all get paid on different days of the month, each day can be defined in a single schedule for each phone.-4. Options to determine frequency of payments, such as every month, every 2 months, every 2 years, etc.+4. Options to determine frequency of payments, such as every month, every 2 months, every 2 years, etc.Once a schedule is started, Actual will search the transaction history for entries that match the schedule, select the matches, and the option to link those transactions to the schedule is given. You can click to the **Find missing transactions** button to have Actual look for matches.diff --git a/docs/tour/accounts.md b/docs/tour/accounts.mdindex f84a21d55f..595696f150 100644--- a/docs/tour/accounts.md+++ b/docs/tour/accounts.md@@ -1,4 +1,4 @@-# The Account Register+# The Account RegisterThis view lets you manage your transactions for an account. Consult the [Accounts & Transaction](/docs/accounts/) section inthe manual for detailed information on how to work with this view.@@ -10,15 +10,15 @@ the manual for detailed information on how to work with this view.To rename the account, click on the pencil icon that appears when you hover over the account name. Clicking on the note icon lets you add a note. Actual fully supports Markdown and the note will be rendered according to your Markdown when the cursor is hovering over the note.-Below the account name, you'll see the current balance. Green indicates a positive account balance, and red indicates a-negative balance. A chevron will appear if you hover over the balance with the cursor. Clicking on this will reveal+Below the account name, you'll see the current balance. Green indicates a positive account balance, and red indicates a+negative balance. A chevron will appear if you hover over the balance with the cursor. Clicking on this will revealthe values for both cleared and uncleared totals. See the[reconciliation topic](/docs/accounts/reconciliation) in the manual for more information.-The top section also gives you access to several functions like importing transactions, manually adding new transactions,-and filtering what transactions you see. On the right side you'll find the _Search_ field which lets you quickly search all fields.+The top section also gives you access to several functions like importing transactions, manually adding new transactions,+and filtering what transactions you see. On the right side you'll find the _Search_ field which lets you quickly search all fields.-It is possible to split a transaction into more than one category. By clicking on the expand/contract arrows, seen in the yellow box,+It is possible to split a transaction into more than one category. By clicking on the expand/contract arrows, seen in the yellow box,you will be able to show or hide split transactions.The three horizontal dots, shown in the blue box, will allow you to perform various manipulations on the account. These range from@@ -44,7 +44,7 @@ Clicking on the **Filter** lets you filter on all the fields. In the screenshot,_Springfield Clothes and food_ and the Category equals just _Clothing_.If you are filtering for the same things over and over, you can save your filter by clicking on the _Unsaved filter_ dropdown-on the right side in the header. Provide a name to save the filter under for future use.+on the right side in the header. Provide a name to save the filter under for future use.Consult [filtering transactions](/docs/transactions/filters) in the manual for more information.diff --git a/docs/tour/budget.md b/docs/tour/budget.mdindex 680537ffe0..7929a99c20 100644--- a/docs/tour/budget.md+++ b/docs/tour/budget.md@@ -1,4 +1,4 @@-# The Budget+# The BudgetThis view lets you manage your budget for various months. You'll find more information about how to do budgeting with Actualin the [Budgeting](/docs/budgeting/) part of this manual.diff --git a/docs/tour/payees.md b/docs/tour/payees.mdindex 17d76de909..276df2f840 100644--- a/docs/tour/payees.md+++ b/docs/tour/payees.md@@ -1,4 +1,4 @@-# Payees Management+# Payees ManagementThis view lets you manage your Payees. In the overview, you see which Payeesyou have in your system and if they have any associated [rules](./rules).diff --git a/docs/tour/reports.md b/docs/tour/reports.mdindex acb39e15a3..535609e44d 100644--- a/docs/tour/reports.md+++ b/docs/tour/reports.md@@ -25,11 +25,11 @@ These reports are detailed in the [reports section](/docs/reports/) in the manua## Custom reports-Actual custom reports should give you all the reports you need on your spending habits and your income and are-thoroughly covered in the [Custom Reports topic](/docs/reports/custom-reports) in the manual.+Actual custom reports should give you all the reports you need on your spending habits and your income and are+thoroughly covered in the [Custom Reports topic](/docs/reports/custom-reports) in the manual.-Below are examples of reports covering our _Daily Expenses_ over the last six months. One report shows this as a graph,-the other as a table. Note that the table version also shows the sum and average (over six months)+Below are examples of reports covering our _Daily Expenses_ over the last six months. One report shows this as a graph,+the other as a table. Note that the table version also shows the sum and average (over six months)for the various categories.diff --git a/docs/transactions/transfers.md b/docs/transactions/transfers.mdindex 059d58cf07..0d0c454ee4 100644--- a/docs/transactions/transfers.md+++ b/docs/transactions/transfers.md@@ -44,9 +44,9 @@ Delete a transfer the same way you delete any transaction: hover over it and pre## Transfer Categories-Transfers between On Budget accounts don't have a category. This is because the funds never left your budget. One way to think about this is that the funds both left and entered your budget thus canceling each other out. Actual marks these types of transfers with _`Transfer`_ in the category field.+Transfers between On Budget accounts don't have a category. This is because the funds never left your budget. One way to think about this is that the funds both left and entered your budget thus canceling each other out. Actual marks these types of transfers with _`Transfer`_ in the category field.-Transfers between Off Budget and On Budget accounts are different. Only one half of the transfer exists on your budget and, from the perspective of your budget, is the same as a regular transaction. You can create these transfers just the same as an On Budget transfer, but you will be asked to assign a category on the On Budget side of the transfer.+Transfers between Off Budget and On Budget accounts are different. Only one half of the transfer exists on your budget and, from the perspective of your budget, is the same as a regular transaction. You can create these transfers just the same as an On Budget transfer, but you will be asked to assign a category on the On Budget side of the transfer.## Payee rulesdiff --git a/docs/troubleshooting/reset_password.md b/docs/troubleshooting/reset_password.mdindex 1ce9f989bc..f0d932e245 100644--- a/docs/troubleshooting/reset_password.md+++ b/docs/troubleshooting/reset_password.md@@ -1,8 +1,8 @@# Resetting Actual login password-If you have forgotten your actual-server login password - not all is lost, as the password can be reset without losing any of your files / data.+If you have forgotten your actual-server login password - not all is lost, as the password can be reset without losing any of your files / data.-A password reset feature is available from version 23.4.2.+A password reset feature is available from version 23.4.2.## Execute directly```sh@@ -21,4 +21,4 @@ kubectl exec --stdin --tty <actual_pod_name> -- /bin/shnode /app/src/scripts/reset-password.js```-The script will prompt through requesting a new password and confirming it. Once set - you can login with the new password.+The script will prompt through requesting a new password and confirming it. Once set - you can login with the new password.diff --git a/docs/vision.md b/docs/vision.mdindex 18c98e7a46..6e074a9f2f 100644--- a/docs/vision.md+++ b/docs/vision.md@@ -23,7 +23,7 @@ title: Actual Budget VisionActual is local first, meaning that the database that powers Actual Budget, and ultimately your budget, lives on your device. We don't store it on a server. Now you're wondering, what 'actual server' is for? Well, that allows you to sync changes to your budget on different devices. To do this, only the changes to the budget are sent to the server. The server stores the messages, and the client pulls down the change(s).-### Open+### OpenActual is Open Source utilizing the MIT license. The code is open for anyone to see, view, and contribute. You own your data; you can do whatever you want with it.@@ -35,7 +35,7 @@ The sleek and clutter-free user interface is simple to use for beginners and comThe contributors to Actual Budget don't just write the program; they USE the program. We all have a vested interest in maintaining reliability, security, and stability. If issues are found, bug reports are welcomed so that issues can be remedied immediately.-### Privacy Focused+### Privacy FocusedActual has no trackers, and unless explicitly enabled, no third-party access is allowed.@@ -56,4 +56,4 @@ Actual Budget, being community-driven means that development is driven by the co* Accessible application### Third-party use-Actual is [MIT licensed](https://github.com/actualbudget/actual/blob/master/LICENSE.txt) which allows for the use of the software without restriction. The Actual Budget project and community appreciate any submissions from third-party contributors to enhance and improve our amazing project. This appreciation extends to any single volunteer or company-sponsored participants alike. Let's continue to make Actual Budget the best personal finance tool together!\ No newline at end of file+Actual is [MIT licensed](https://github.com/actualbudget/actual/blob/master/LICENSE.txt) which allows for the use of the software without restriction. The Actual Budget project and community appreciate any submissions from third-party contributors to enhance and improve our amazing project. This appreciation extends to any single volunteer or company-sponsored participants alike. Let's continue to make Actual Budget the best personal finance tool together!