---
title: "Installation"
space: "Books"
url: "https://docs.frappe.io/books/installation"
updated: "2026-10-03"
---

Frappe Books is an app for the [Frappe Framework](https://github.com/frappe/frappe). You install it on a Frappe site. Your team then signs in to that site from a browser on a computer or a phone.

All company data stays in the site database. There is no file to download and no `.db` file to keep.

## Requirements

| Item | Version |
| --- | --- |
| Frappe Framework | `develop` branch (version 17 in development) |
| Python | 3.14 |
| Node.js and Yarn | Current LTS release of Node.js |
| Redis | Any supported release |
| Database | MariaDB 11.8, PostgreSQL 18, or SQLite 3 |

## Install with Bench

1. Install Python 3.14 and Bench:

   ```bash
   uv python install 3.14
   uv tool install frappe-bench
   ```

2. Create a bench on the Frappe `develop` branch:

   ```bash
   bench init --frappe-branch develop --python "$(uv python find 3.14)" books-bench
   cd books-bench
   ```

3. Get the app:

   ```bash
   bench get-app https://github.com/frappe/frappe-books
   ```

4. Create a site. Set `--db-type` to `mariadb`, `postgres`, or `sqlite`:

   ```bash
   bench new-site books.localhost --db-type mariadb --set-default
   ```

5. Install the app on the site:

   ```bash
   bench --site books.localhost install-app frappe_books
   ```

6. Start the bench:

   ```bash
   bench start
   ```

7. Open `http://books.localhost:8000/books` and sign in as Administrator.

The setup wizard opens on the first sign-in. To complete it, see [Getting Started with Frappe Books](/books/getting-started-with-frappe-books).

:::note
A database server needs more options for `bench new-site`, such as `--db-host`, `--db-port`, and `--db-root-username`.
:::

## Update the App

1. Pull the latest version of the app:

   ```bash
   bench update --apps frappe_books
   ```

2. Run the migration on each site:

   ```bash
   bench --site books.localhost migrate
   ```

## Back Up a Site

Back up the database and the attached files:

```bash
bench --site books.localhost backup --with-files
```

Keep a copy of `site_config.json` with the backup.

:::caution
You cannot change the database type of a site in `site_config.json`. To move to a different database, create a new site and move the data.
:::