diff --git a/docs/install/pikapods.md b/docs/install/pikapods.md index 12954930c6..6e1c629538 100644 --- a/docs/install/pikapods.md +++ b/docs/install/pikapods.md @@ -2,13 +2,125 @@ title: 'PikaPods' --- -## Deploying Actual on PikaPods [PikaPods](https://www.pikapods.com/) offers one click "instant open source app hosting", allowing -you to run Actual for a little more than $1 per month (price may have changed since this document was updated). +you to run Actual for less than $ 1.50 per month (as of July 2024). -## Deploying +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. -[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). +You get a $ 5.00 credit when you sign up, which means that you should be able to run Actual for +over 3 months before your credit runs out. + + +## 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). + +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 +Actual 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). + + +You will be greeted with the following screen. + +![](/img/pikapods-setup/pikapods-1-register-login.png) + +Click on the **register** inside the blue banner, which will take you to 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. +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) + + +## Verification email + +By clicking the green button saying **Activate and Login**, you are now registered as +a PikaPods customer. You will be returned to the login screen. + +![](/img/pikapods-setup/pikapods-4-email-activation.png) + + +## Login screen + +Enter the email address and password you registered yourself with. + +![](/img/pikapods-setup/pikapods-5-login-screen.png) + + +## 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*. +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 + +One Pod running Actual can have multiple budgets available at the same time. You do not need to set up a new 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. + +::: + + +![](/img/pikapods-setup/pikapods-6-add-pod-basics.png) + + +## Assigning storage to your Pod + + +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. + +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. + +![](/img/pikapods-setup/pikapods-7-add-pod-resoruces.png) + + + +## Your pod is now ready to be used + +When click on the green **OPEN POD** you will be taken 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. + + +![](/img/pikapods-setup/pikapods-8-running-pod.png) + + +## 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 +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 +be able to retrieve your budget. + + +![](/img/a-tour-of-actual/server-connecting-first-time.png) + + +## Getting started with using Actual Budget + +Go to our [Starting Fresh](/docs/getting-started/starting-fresh) guide to get started with +Actual Budget. + diff --git a/static/img/a-tour-of-actual/server-connecting-first-time.png b/static/img/a-tour-of-actual/server-connecting-first-time.png new file mode 100644 index 0000000000..ccfad2950b Binary files /dev/null and b/static/img/a-tour-of-actual/server-connecting-first-time.png differ diff --git a/static/img/pikapods-setup/pikapods-1-register-login.png b/static/img/pikapods-setup/pikapods-1-register-login.png new file mode 100644 index 0000000000..da67f33f3c Binary files /dev/null and b/static/img/pikapods-setup/pikapods-1-register-login.png differ diff --git a/static/img/pikapods-setup/pikapods-2-register-name.png b/static/img/pikapods-setup/pikapods-2-register-name.png new file mode 100644 index 0000000000..1dd4bddc25 Binary files /dev/null and b/static/img/pikapods-setup/pikapods-2-register-name.png differ diff --git a/static/img/pikapods-setup/pikapods-3-register-thanks-for-signup.png b/static/img/pikapods-setup/pikapods-3-register-thanks-for-signup.png new file mode 100644 index 0000000000..690c34627e Binary files /dev/null and b/static/img/pikapods-setup/pikapods-3-register-thanks-for-signup.png differ diff --git a/static/img/pikapods-setup/pikapods-4-email-activation.png b/static/img/pikapods-setup/pikapods-4-email-activation.png new file mode 100644 index 0000000000..a0819eb8ad Binary files /dev/null and b/static/img/pikapods-setup/pikapods-4-email-activation.png differ diff --git a/static/img/pikapods-setup/pikapods-4b-email-welcome.png b/static/img/pikapods-setup/pikapods-4b-email-welcome.png new file mode 100644 index 0000000000..4c6495a29b Binary files /dev/null and b/static/img/pikapods-setup/pikapods-4b-email-welcome.png differ diff --git a/static/img/pikapods-setup/pikapods-5-login-screen.png b/static/img/pikapods-setup/pikapods-5-login-screen.png new file mode 100644 index 0000000000..f3896a8406 Binary files /dev/null and b/static/img/pikapods-setup/pikapods-5-login-screen.png differ diff --git a/static/img/pikapods-setup/pikapods-6-add-pod-basics.png b/static/img/pikapods-setup/pikapods-6-add-pod-basics.png new file mode 100644 index 0000000000..bba467d4cf Binary files /dev/null and b/static/img/pikapods-setup/pikapods-6-add-pod-basics.png differ diff --git a/static/img/pikapods-setup/pikapods-7-add-pod-resoruces.png b/static/img/pikapods-setup/pikapods-7-add-pod-resoruces.png new file mode 100644 index 0000000000..eb5de1dfa1 Binary files /dev/null and b/static/img/pikapods-setup/pikapods-7-add-pod-resoruces.png differ diff --git a/static/img/pikapods-setup/pikapods-8-running-pod.png b/static/img/pikapods-setup/pikapods-8-running-pod.png new file mode 100644 index 0000000000..17a4daf77e Binary files /dev/null and b/static/img/pikapods-setup/pikapods-8-running-pod.png differ