Help & Docs

The in-app home for the guides, the keyboard shortcuts, the Quick Add page URL, and the system information to paste into a bug report.

Overview#

Help & Docs is the last entry in the sidebar. It collects the things you go looking for when you're stuck or filing a bug, rather than the preferences you set once and forget — those stay in Settings.

There are two ways into help:

  • The Help & Docs page (this one), for the full list of guides and the diagnostic tools.
  • The ? button at the bottom of the sidebar, beside Tools & Settings, which opens a panel with a short summary for whatever page you're currently on plus a link to that page's full guide. Its footer links through to this page.

Documentation#

A card per topic, each opening the full guide on this site. The list is generated from the same topic map the help panel uses, so the two never drift apart.

Keyboard Shortcuts#

Show shortcuts opens the cheat sheet — the same overlay you get by pressing ? anywhere in the app.

Briefly: g followed by a letter jumps to any page, / (or Ctrl/Cmd+K) focuses search, Esc closes any dialog, and on the transaction list j/k move a row cursor with e to edit and x to select.

The cheat sheet also has a Reordering group: Alt with the up and down arrows moves a focused category, or a column in the Accounts page's display settings, and Alt with the right and left arrows makes a category a subcategory of the one above or moves it out a level. The full list is under Keyboard Shortcuts.

Quick Add Page#

The Quick Add Page is a standalone, minimal page for entering a single transaction on the go — it shows only the entry form, with no balances, account details, or other sensitive information visible. This makes it safe to use in public (e.g. paying at a till) without revealing your finances.

  • This page shows a copyable Quick Add URL (/apps/budget/quick-add) you can bookmark or add to a device home screen.
  • The Dashboard's Quick Add Transaction tile also has a Standalone ↗ link that opens it in a new tab.

Adding a receipt#

Upload receipt at the top of the form takes a photo of the receipt, or an image or PDF you already have. On a phone it offers the camera as well as your photos and files. The receipt is attached to the transaction when you press Save Transaction, and is filed in your Nextcloud Files with the rest of your receipts (see Where receipts are filed).

When your administrator has set up receipt scanning, a Read receipt button appears beside the photo. Press it and the page reads the photo and fills in the date, amount, description and vendor, plus the category when one of your rules matches the shop. Check them before you save. Choosing a photo on its own only attaches it: it is only sent to be read when you press Read receipt, as the scanning your administrator chose may be a paid service away from your server. If the receipt cannot be read, the photo stays attached and you enter the details yourself. Scanning reads JPEG, PNG and WebP images, so a PDF is attached without being read.

Receipts are filed in the Files of whoever owns the account, so they can only be attached to transactions in your own accounts. If you pick an account someone has shared with you, the page tells you before you save, and the transaction is saved without the receipt.

If the transaction saves but the receipt does not upload, the page says so and clears the form as it would after any save, so pressing Save again does not enter the transaction twice. Open the transaction in Budget to attach the receipt there.

Installing it as an app#

The Quick Add page can be installed on its own, so it gets its own icon and opens straight to the form in a window without the browser's address bar. Open the Quick Add URL first, then:

DeviceHow to install
iPhone / iPad (Safari)Tap Share, then Add to Home Screen
Android (Chrome)Open the ⋮ menu and choose Add to Home screen (or Install app)
Desktop (Chrome or Edge)Click the install icon at the right of the address bar

Chrome and Edge only offer to install it when your Nextcloud is reached over HTTPS. On iPhone and iPad the installed app keeps its own login, separate from Safari, so the first time you open it you will be asked to sign in to Nextcloud.

If you added a Quick Add icon to your home screen before this was supported and it opens the main Budget page instead, remove it and add it again from the Quick Add page.

System Info#

The System Info panel provides diagnostic information useful when reporting issues:

  • App & Server Details — Budget version, Nextcloud version, PHP version, database type
  • Data Stats — Account count, transaction count, category count, active rules, bills, bank sync connections, sharing status
  • Browser & Screen — Browser version and viewport dimensions
  • Client Diagnostics — Failed API requests and JavaScript errors captured during the current session
  • Server Logs (admin only) — Recent budget-related entries from the Nextcloud log

Click Copy to Clipboard to copy all diagnostic info as plain text for pasting into bug reports. Report an Issue in the page header opens the GitHub issue tracker.

FeatureDescription
SettingsPreferences, notifications, data migration, maintenance and factory reset
Getting StartedSet up your first account and start tracking