DOCUMENTATION
BudgetClick documentation
Everything you need to install BudgetClick, configure your storage, and manage your finances.
Pre-installation
BudgetClick is a private, offline-first personal finance application. Unlike traditional budget trackers, it does not require an account with BudgetClick or a subscription.
Your data is encrypted on your device and stored in an S3-compatible storage bucket that you control.
What you need
- A desktop or mobile device with a modern browser.
- An S3-compatible storage provider and a dedicated bucket.
- A secure passphrase that you will not lose.
- A place to securely store your recovery information.
Understand the storage model
BudgetClick does not operate a database containing your financial information. The storage bucket is your source of truth.
Install BudgetClick
BudgetClick is a Progressive Web App (PWA). You can install it directly from your browser without visiting an app marketplace.
Desktop: Chrome or Edge
- Open BudgetClick in Chrome or Edge.
- Look for the install icon in the browser address bar.
- Choose Install and confirm.
- Launch BudgetClick from your desktop or application menu.
Android
- Open BudgetClick in Chrome.
- Open the browser menu.
- Choose Install app or Add to Home screen.
- Confirm the installation.
iPhone and iPad
- Open BudgetClick in Safari.
- Tap the Share button.
- Choose Add to Home Screen.
- Confirm and launch BudgetClick from the Home Screen.
You can also use BudgetClick directly in a browser without installing it.
Configure storage
BudgetClick needs an S3-compatible bucket to store your encrypted financial data. You can use Amazon S3, Cloudflare R2, Backblaze B2, MinIO, or another compatible provider.
The following instructions explain how to configure Amazon S3 using the provided CloudFormation template.
▶ Watch Interactive Storage Setup Walkthrough
BudgetClick encrypts all financial data on your device before uploading it. Your passphrase and encryption key are never sent to the storage provider.
The bucket uses public access by design. Anyone who obtains its URL can list, download, overwrite, and delete stored objects according to the bucket policy. Encryption prevents unauthorized reading, but does not protect your data from modification or deletion.
Create a dedicated bucket exclusively for BudgetClick. Keep its URL private and maintain independent backups.
If you lose your encryption passphrase and saved encryption key, your data becomes permanently unreadable.
If your bucket is deleted or its contents are overwritten or removed, your remote data may be permanently lost. BudgetClick does not maintain a separate backup.
1. Create an AWS account
Open Amazon Web Services and create an account if you do not already have one.
Check the current AWS Free Tier offer and eligibility conditions. AWS credits and account plans are subject to change.
2. Create your bucket using CloudFormation
▶ Watch Interactive Storage Setup Walkthrough
BudgetClick provides a CloudFormation template that creates an S3 bucket with the required bucket policy and CORS configuration. This is the recommended setup method.
- Download the cloudformation.yml template from GitHub.
- Open AWS CloudFormation .
- Choose Create stack → With new resources → Upload a template file.
- Upload the downloaded
cloudformation.ymlfile. - Choose a globally unique bucket name when prompted.
- Complete the stack creation and wait until its status is CREATE_COMPLETE.
3. Get your storage path
- Open your newly created CloudFormation stack.
- Navigate to the Outputs tab.
- Copy the value of
StoragePath. - Keep this URL private and securely store it.
The storage path is the HTTPS URL BudgetClick uses to access your bucket. Enter it in BudgetClick when configuring storage.
The template configures the bucket policy to allow the operations required by BudgetClick, including reading, writing, listing, and deleting objects. It also configures the required CORS rules so the application can communicate with your bucket from the browser.
If stack creation fails because AWS blocks public bucket policies, check the account-level S3 Block Public Access settings. Account-level restrictions can override bucket-level settings. Disable the restrictions that prevent public bucket policies, then retry the stack creation.
4. Other S3-compatible providers
You can use another S3-compatible storage provider instead of Amazon S3. Configure a dedicated bucket with equivalent permissions and CORS settings.
The configuration must support:
- Anonymous object reading (GetObject).
- Anonymous object writing and replacement (PutObject).
- Object listing (ListBucket).
- Object deletion (DeleteObject).
- Browser access through appropriate CORS configuration.
- An HTTPS endpoint.
Provider documentation:
Provider configuration differs. Verify that the endpoint, permissions, and CORS configuration work with BudgetClick before storing important financial data.
5. Storage size limits
Each storage object must not exceed 5 MB. This includes monthly transaction chunks and attachments.
Large attachments or months containing many transactions may exceed this limit. Reduce attachment sizes or distribute attachments across records when necessary.
First-time setup
Once your bucket is ready, open the BudgetClick application and follow the setup wizard.
Step 1. Client ID
BudgetClick generates a Client ID for your installation.
This identifier is used for synchronization and conflict detection. It is not a password and does not protect your financial information.
Memorize or securely save your Client ID. If you reinstall BudgetClick, you can enter the same ID to restore the identity of this client.
Step 2. Configure storage
Paste the HTTPS bucket URL you created earlier.
BudgetClick checks the storage location. If it is empty, the application proceeds with creating new storage. If it already contains BudgetClick data, you can unlock that existing storage.
Step 3. Set your passphrase
For new storage, choose and confirm a secure passphrase.
Your passphrase is used to derive the encryption key. BudgetClick does not store or upload the passphrase.
If you lose your passphrase and do not have the necessary recovery information, your encrypted data cannot be recovered.
Step 4. Create your first account
Enter the name, description, currency, and starting balance of your first account.
Examples include a bank account, cash wallet, savings account, or credit card.
The currency of your first account becomes the initial default currency. You can change it later in Settings.
Step 5. Finish setup
BudgetClick initializes your data and opens the Dashboard.
Print or securely save the recovery information offered by the application.
You are ready to start tracking your finances.
Using BudgetClick
BudgetClick combines a spreadsheet-style transaction list with interactive widgets. The spreadsheet gives you an overview, while widgets let you create and edit individual records.
Accounts
An account represents a place where you keep or manage money. Examples include bank accounts, cash, credit cards, and savings.
Each account has its own currency and starting balance. You can create additional accounts and select the default currency used for total statistics in Settings.
Transactions
Transactions represent income and expenses.
Open the Dashboard and use the transaction form to create a record. The form contains the following fields:
- Amount: Transaction amount.
- Account: Account associated with the transaction.
- Description: Short explanation of the transaction.
- Date and time: Transaction date and time.
- Actual: Indicates whether the transaction has actually occurred.
- Income: Identifies income rather than an expense.
- Category: Optional transaction classification.
- Contractor: Optional person or organization associated with the transaction.
- Comment: Additional information.
Future-dated transactions cannot be marked as actual. They are treated as planned transactions.
The spreadsheet displays the running account balance after each transaction.
Recurring transactions
Recurrences allow you to generate planned transactions automatically according to a schedule.
BudgetClick supports daily, weekly, monthly, and annual recurrence frequencies, with configurable intervals and date ranges.
When you edit a recurrence, its actual transactions remain unchanged. Planned transactions are regenerated using the updated rules.
When deleting a recurrence, you can choose whether to remove its planned transactions or keep them as independent transactions.
Attachments
You can attach receipts, invoices, and other documents to transactions.
Attachments are encrypted before upload and downloaded when you open them. Each attachment must not exceed 5 MB.
You can also create a document-only record without a normal transaction. Add an attachment, leave Amount and Description empty, and confirm document-only saving.
Statistics and balances
The Statistics Widget displays income, expenses, and ending balances. You can view statistics for all accounts together or for individual accounts.
Statistics are derived from your transaction history and can be rebuilt if necessary.
Account balances are calculated from the account's starting balance and transaction history.
Currency rates allow BudgetClick to convert account values into your default currency. If a rate is missing, a 1:1 conversion is used.
Offline use
BudgetClick is designed to work offline.
Your application files and working data are stored locally on your device. You can continue creating and editing transactions without an internet connection.
Changes are synchronized with your storage bucket when connectivity becomes available.
Do not clear browser data or uninstall the application before confirming that your changes have synchronized. Keep your storage URL, Client ID, and recovery information safe.
Backup and recovery
BudgetClick supports exporting your data to a ZIP file through Settings.
You can choose whether to include attachments. The exported ZIP file is not encrypted, so store it securely.
Importing an export replaces the current application data.
Keep the following recovery information somewhere secure:
- Client ID.
- Storage URL.
- Encryption passphrase.
- Encryption key and recovery information.
- Independent data exports.
Losing access to your bucket, passphrase, or encryption key may permanently prevent you from accessing your financial information. Maintain independent backups.
Further help
For more detailed information about individual application features, see the in-app Help section.
You can also explore the BudgetClick source code and the development video playlist.