Setting Up

Managed Hosting

Get started with your personal or business site with a few clicks on Frappe Cloud.

Self-hosting

If you prefer self-hosting, follow the official Frappe Bench Installation instructions.

Docker Compose [Recommended]

The quickest way to set up Frappe Builder and take it for a test ride.

Frappe framework is multi-tenant and supports multiple apps by default. This docker compose is just a standalone version with Frappe Builder pre-installed. Just put it behind your desired reverse-proxy if needed, and you're good to go.

If you wish to use multiple Frappe apps or need multi-tenancy. Take a look at our production ready self-hosted workflow, or join us on Frappe Cloud to get first party support and hassle-free hosting.

Step 1: Setup folder and download the required files

mkdir frappe-builder
cd frappe-builder

Step 2: Download the required files

Docker Compose File:

wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/builder/develop/docker/docker-compose.yml

Frappe Builder bench setup script

wget -O init.sh https://raw.githubusercontent.com/frappe/builder/develop/docker/init.sh

Step 3: Run the container and daemonize it

docker compose up -d

Step 4: The site http://builder.localhost should now be available. The default credentials are:

username: administrator
password: admin

Want to just try out or contribute?

Local Setup

Install Bench.
Install Frappe Builder app:

$ bench get-app builder

Create a site with the builder app:

$ bench --site sitename.localhost install-app builder

Open the site in the browser:

$ bench browse sitename.localhost --user Administrator

Access the builder page at sitename.localhost:8000/builder in your web browser.

GitHub (Codespaces)

Open this link and click on "Create Codespace".
Wait for initialization (~15 mins).
Run bench start from the terminal tab.
Click on the link beside "8000" port under "Ports" tab.
Log in with "Administrator" as the username and "admin" as the password.
Go to <random-id>.github.dev/builder to access the builder interface.