Local Installation
The easiest way to get Actual running locally is to use the actual-server project.
Actual Server is the server element of Actual that is used for syncing changes across devices, and it comes with the latest version of Actual Web.
Pre-requisites
Actual Server currently requires Node.js v16. If you don’t have Node.js installed, you can download the latest version of Node.js 16 from the Node.js website (search for “16” to find the right version). If you already have Node.js installed, consider using a tool like nvm
or asdf
to install and manage multiple versions of Node.js.
You’ll also need to have Git installed. The Git website has instructions for all supported operating systems.
Next, you’ll need to install yarn
, which is the package manager that Actual uses. You can install it using the following command:
npm install --global yarn
Installing Actual
First you need to clone the Actual Server project to your machine, you can do this using Git.
git clone https://github.com/actualbudget/actual-server.git
Once you have it cloned, navigate to the directory where you cloned the project
cd actual-server
Install all the dependencies using yarn
yarn install
Running Actual
Now that Actual is installed, start the server by running the following command:
yarn start
Note that if you restart your computer, you’ll have to run this command again to start the server.
Accessing Actual
You should now be able to visit Actual by going to http://localhost:5006 in your browser.
When first accessing Actual, you may be prompted to provide a URL for the server. For a local installation like this, you can click the “Use localhost:5006” button to use the same URL as the one you’re accessing Actual from.