Skip to content

Commit

Permalink
Merge pull request #31 from shall0pass/overview_installation_prereqs
Browse files Browse the repository at this point in the history
Update overview page
  • Loading branch information
Rich Howell committed Oct 21, 2022
2 parents 733f285 + 8b9a4c0 commit a5464d5
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/Installing/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@ title: 'Overview'

Installing Actual be it on your own personal computer or in the cloud is really simple, we have a selection of guides available that will help you get setup, but first, there are some things your going to need and also some things we need to tell you that we currently don't support.

### Pre Requisites
There are two basic methods of installing Actual. The first is to build from source. If you plan to build from source, package your own Docker images, or use Fly.io as your hosting provider there are a few pre-requisites to get started.

If you would simply like to use the Docker images provided by the Actual development team, you only need to install Docker to run it locally. If you plan to use a hosting provider in the cloud like PikaPods, you may not have to install anything.

Pick one of our guides which should help you install Actual and identify the specific pre-requisites for an environment that is suitable for you.

### Pre-requisites from source code or Fly.io

We support all Operating systems including Windows, OSX or Linux.

Install [Git](https://git-scm.com/) for your operating system,

Install [NodeJS](https://nodejs.org/en/) version 14 or greater,

You will need access to the internet.
Expand All @@ -18,8 +26,6 @@ Install [Yarn](https://yarnpkg.com/) using NPM, if you only just installed NodeJ
npm install --global yarn
```

Once you have the above, pick one of our guides which should help you install Actual in an environment that is suitable for you.

### Currently Not Supported

The following is currently not supported by Actual.
Expand Down

0 comments on commit a5464d5

Please sign in to comment.