github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-03-21 15:36:50 -05:00
Code Issues 250 Packages Projects Releases 53 Wiki Activity

Add PWA install instructions and links to Pikapods doc - fixes #6191 (#6215)

Browse Source 
* Update pikapods.md

* Update pikapods.md

Added info and links to PWA installation

* Update pikapods.md

* Update pikapods.md

A couple of formatting changes

* Update pikapods.md

* Update notification method for PikaPods

* Update packages/docs/docs/install/pikapods.md

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

* Update pikapods.md

* Update pikapods.md

* Update expect.txt - add 'taskbar'

* Update expect.txt

* Update pikapods.md

* Update packages/docs/docs/install/pikapods.md

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

* Update pikapods.md

* Update pikapods.md

* Update pikapods.md

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
This commit is contained in:
Juulz
2025-11-24 08:39:40 -05:00
committed by GitHub
parent 7613de013e
commit c17fa45692
2 changed files with 69 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/actions/docs-spelling/expect.txt vendored
View File

@@ -108,6 +108,7 @@ prefs
Primoco Primoco
Priotecs Priotecs
proactively proactively
pwa
Qatari Qatari
QNTOFRP QNTOFRP
QONTO QONTO
@@ -133,6 +134,7 @@ SWEDNOKK
Synology Synology
systemctl systemctl
tada tada
taskbar
templating templating
THB THB
touchscreen touchscreen

116
packages/docs/docs/install/pikapods.md
View File

@@ -3,19 +3,22 @@ title: 'PikaPods'
--- ---
[PikaPods](https://www.pikapods.com/) offers one click "instant open source app hosting", allowing [PikaPods](https://www.pikapods.com/) offers one click "instant open source app hosting", allowing you to run Actual for about $ 1.50 per month (as of November 2025).
you 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 will share some of its revenues with Actual for customers using their Actual Budget Pods.
share 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 for 3 months before your credit runs out.
over 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. For web clients, PikaPods will automatically update about a week or so after the latest monthly release is deployed. PikaPods tests each new release before deploying it. If you have the Notification setting in PikaPods checked, you will get an email notifying you that the server has been updated.
For desktop clients, you will need to reinstall the desktop client to update to the latest version. For desktop clients, you will need to reinstall the desktop client to update to the latest version.
We suggest first checking on the web client if PikaPods has updated, then reinstalling the desktop client. First check on the web client to see if PikaPods has updated, then reinstall the desktop client.
:::note[Using Actual on Pikapods]
We suggest [using a PWA](#using-a-PWA) desktop client with PikaPods so you don't run into version issues.
:::
## Deploying Actual on PikaPods ## Deploying Actual on PikaPods
@@ -23,12 +26,11 @@ If you are technically inclined, just [Click here to create an account and run A
You can leave the resources at their lowest setting (although you will need a non-zero amount of storage for your budget files). 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_ _Your browser does most of Actual's computation,_ 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 setting up your Pod, head over to our [Starting Fresh](/docs/getting-started/starting-fresh) guide to get started with
Actual Budget. Actual Budget.
## A step by step guide to setting up Actual Budget with PikaPods ## 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).
@@ -36,95 +38,111 @@ Actual Budget.
You will be greeted with the following screen. You will be greeted with the following screen.
![](/img/pikapods-setup/pikapods-1-register-login.png) ![image PikaPods register](/img/pikapods-setup/pikapods-1-register-login.png)
Click on the **register** link inside the blue banner, which will take you to the user registration screen. Click on the **register** link inside the blue banner, which will take you to the user registration screen.
## The user registration screen ## The user registration screen
This screen is self-explanatory, but a kind reminder is to use a password only you know. A working email address is required, as PikaPods will send an email with a link you need to click on to complete the signup process.
You will need to use a working email address, as you will receive an email with a link you need
to click on to complete the signup process.
![](/img/pikapods-setup/pikapods-2-register-name.png) ![Image Pikapods email](/img/pikapods-setup/pikapods-2-register-name.png)
## Verification email ## Verification email
By clicking the green button saying **Activate and Login**, you are now registered as Click the green button **Activate and Login**. You are now registered as a PikaPods customer. You will be returned to the login screen.
a PikaPods customer. You will be returned to the login screen.
![](/img/pikapods-setup/pikapods-4-email-activation.png) ![Image Pikapods email registration](/img/pikapods-setup/pikapods-4-email-activation.png)
## Login screen ## Login screen
Enter the email address and password you registered yourself with. Enter _your_ registration email address and password.
![](/img/pikapods-setup/pikapods-5-login-screen.png) ![Image Pikapods login](/img/pikapods-setup/pikapods-5-login-screen.png)
## Naming your Pod ## Naming your Pod
A simplistic explanation of a Pod in layperson's terms is that *a Pod is a very tiny computer running in the cloud*. Simply put, *a Pod is a very tiny computer running in the cloud*. Typically, a Pod only runs one application - like Actual Budget Server.
Typically, a Pod only runs one application - like Actual Budget.
In 1), you enter a name for your Pod. This name really does not matter unless you plan to run several different Pods.
In 2), you decide which region your Pod should run - choose the most suitable region.
:::info :::info
One Pod running Actual can have multiple budgets available at the same time. You do not need to set up a new Pod Multiple budgets can reside in one Pod running Actual. You do not need to set up a new Pod for each budget you create. The number of budgets is limited only by the storage capacity you assign to your Pod.
for each budget you want to set up. The number of budgets is only limited by the storage capacity you assign to your
Pod. If you [connect to your bank](/docs/advanced/bank-sync.md), note that all budgets in the same Pod share a single bank sync key.
::: :::
In 1), you enter a name for your Pod. This name really does not matter unless you plan to run several different Pods.
![](/img/pikapods-setup/pikapods-6-add-pod-basics.png) In 2), you decide which region your Pod should run - choose the most suitable region.
![Image pikapods basic](/img/pikapods-setup/pikapods-6-add-pod-basics.png)
## Assigning storage to your 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 you that this is more than enough for your budget purposes.
that 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: It takes about 33 megabytes of storage for about 1,200 transactions, 18 months of budgeting, and approximately 200 rules and payees. 10 gigabytes equals 10,000 megabytes, equivalent to 303 18-month budgets.
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. Your Pod will be created when you click on the green **ADD POD** button. This step takes less than one minute.
![](/img/pikapods-setup/pikapods-7-add-pod-resoruces.png) ![Image pikapods add resources](/img/pikapods-setup/pikapods-7-add-pod-resoruces.png)
## Your pod is now ready to be used ## Your Pod is now ready to be used
When you click on the green **OPEN POD** button you will be taken to your Pod. Click on the green **OPEN POD** button to be taken to your Pod.
The address for your Actual Budget is found in the Domain field. In the screenshot example, this is 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.
`https://berserk-bullmastiff.pikapod.net/budget/`. Yours will be something completely different.
![](/img/pikapods-setup/pikapods-8-running-pod.png) ![Image pikapod pod url](/img/pikapods-setup/pikapods-8-running-pod.png)
## Setting a password for your Actual Budget ## 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 used the next time you log into your server - and should never be the same as your PikaPods account password.
next 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 :::warning
be able to retrieve your budget.
Keep your Actual Budget password safe, as it cannot be retrieved. If you forget your server password, you will not be able to retrieve your budget.
:::
![](/img/a-tour-of-actual/server-connecting-first-time.png) ![Image connecting to Actual](/img/a-tour-of-actual/server-connecting-first-time.png)
<br />
<br />
## Using a PWA (Progressive Web App) {#using-a-PWA}
When using Actual Server over the internet, we suggest using a PWA web client. After you login and open Actual Budget, it's easy to set up a PWA from your browser of choice.
Here's some help with a few common desktop browsers.
:::note
Browser version and OS/browser combination may affect how to install a PWA. Please refer to your browsers documentation for definitive guidance.
:::
- Chrome: There may be an "app available" icon on the right side of the URL or use the browser menu. See [Chrome's documentation](https://support.google.com/chrome/answer/9658361?hl=en&co=GENIE.Platform%3DDesktop).
- Firefox: In supported OS, there should be an "add tab to taskbar" icon on the right side of the URL. You may need to add a PWA extension as described in [Mozilla's documentation](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Installing).
- Safari: There should be a share icon in the Safari toolbar or use the browser menu. See [Safari's documentation](https://support.apple.com/en-mide/104996).
For other browsers or browser/OS combinations, most search engines or the browser's documentation will describe how to install a PWA. PC Magazine had an [article in March 2025](https://www.pcmag.com/explainers/how-to-use-progessive-web-apps) with some good information.
## Getting started with using Actual Budget ## Getting started with 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 with Actual Budget.
Actual Budget.