Frappe Documentation

https://docs.frappe.io
Admin
Frappe is a comprehensive full-stack web framework and ecosystem including ERPNext, Books, Builder,...
Tokens:1,413,468
Snippets:15,973
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Setup Python Environment

Source: https://docs.frappe.io/learning/falcon-self-hosting-guide

Create a virtual environment and install the necessary dependencies.

```bash
1234python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install -r dev-requirements.txt
```

--------------------------------

### Install Wiki app with bench

Source: https://docs.frappe.io/wiki-v2/install-locally

Use these bench commands to get the Wiki app from GitHub and install it on a site. Replace 'sitename' with your actual site name.

```bash
# get-app

$ bench get-app https://github.com/frappe/wiki

# install on site

$ bench --site sitename install-app wiki
```

--------------------------------

### Set up Bench Manager with bench setup manager

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Run this command in an existing bench to set up Bench Manager. It creates a new site bench-manager.local, gets the bench_manager app, and installs it on that site.

```zsh
➜ bench setup manager

zsh
```

--------------------------------

### Example: bench setup add-domain with SSL certificates

Source: https://docs.frappe.io/framework/user/en/bench/guides/adding-custom-domains.html

Example command to add a custom domain with SSL certificates. The certificates are specified using --ssl-certificate and --ssl-certificate-key.

```bash
1 bench setup add-domain custom.erpnext.com --ssl-certificate /etc/letsencrypt/live/erpnext.cert --ssl-certificate-key /etc/letsencrypt/live/erpnext.key

auto

```

--------------------------------

### Setup site and apps with Bench CLI

Source: https://docs.frappe.io/framework/user/en/production-setup

Creates a new site named example.com, fetches the ERPNext app and a custom app from GitHub, then installs them onto the site. Run these commands from the frappe-bench directory.

```bash
# change directory to frappe-bench
cd frappe-bench

# create a new site
bench new-site example.com

# download frappe apps or your custom-apps
bench get-app erpnext
bench get-app https://github.com/yourremote/yourapp.git

# install apps onto your site
bench --site example.com install-app erpnext yourapp
```

--------------------------------

### Run easy-install.py deploy command

Source: https://docs.frappe.io/insights/get-started/installation

Runs the deployment command to install Frappe Insights. Replace your_email.example.com and subdomain.domain.tld with your actual email and domain. The setup takes about 5 minutes.

```bash
python3 ./easy-install.py deploy \
    --project=insights_prod_setup \
    --email=your_email.example.com \
    --image=ghcr.io/frappe/insights \
    --version=stable \
    --app=insights \
    --sitename subdomain.domain.tld
```

--------------------------------

### Initialize a frappe-bench setup with bench init

Source: https://docs.frappe.io/framework/user/en/basics/architecture

Initializes a new frappe-bench directory with the specified name. This command creates the bench structure, sets up a Python virtual environment, configures Redis, downloads and installs the frappe app, installs node packages, and builds JS/CSS assets.

```sh
bench init frappe-bench
```

--------------------------------

### Start frontend development server

Source: https://docs.frappe.io/crm/introduction/installation

Installs dependencies and starts the Vite dev server for frontend development. Run in frappe-bench/apps/crm.

```bash
yarn install
yarn dev
```

--------------------------------

### Install CRM with Bench

Source: https://docs.frappe.io/crm/introduction/installation

Sets up Frappe CRM locally using Bench. Run these commands in the frappe-bench directory after starting bench.

```bash
$ bench get-app crm
$ bench new-site sitename.localhost --install-app crm
$ bench browse sitename.localhost --user Administrator
```

--------------------------------

### Install app on site

Source: https://docs.frappe.io/framework/user/en/tutorial/create-a-site

Run this command to install the library_management app on the site library.localhost. The output shows the installation process.

```bash
123$ bench --site library.localhost install-app library_management

Installing library_management...

auto

```

--------------------------------

### Setup a new bench with bench init

Source: https://docs.frappe.io/cloud/common-issues/debugging-app-installs-locally

Creates a new bench named test-install at the current path. Use a fresh bench to isolate Python dependencies when debugging app install failures.

```bash
bench init test-install # At /some/path/test-install
```

--------------------------------

### Download easy install script

Source: https://docs.frappe.io/crm/introduction/installation

Downloads the easy install script for Frappe CRM production setup.

```bash
wget https://frappe.io/easy-install.py
```

--------------------------------

### Add an app with bench get-app

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Fetches a remote Frappe app from a git repository and installs it. Example uses the erpnext app.

```zsh
bench get-app erpnext https://github.com/frappe/erpnext
```

--------------------------------

### Create a new site and install an app

Source: https://docs.frappe.io/framework/user/en/bench/reference/new-site

Creates a new site and installs an app that is available on the current bench.

```bash
bench new-site {site} --install-app {app}
```

--------------------------------

### Prepare Docker setup files

Source: https://docs.frappe.io/learning/get-started/installation

Creates a directory and downloads the required Docker Compose file and setup script for Frappe Learning.

```bash
mkdir frappe-learning
cd frappe-learning

# Download the docker-compose file
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/lms/develop/docker/docker-compose.yml

# Download the setup script
wget -O init.sh https://raw.githubusercontent.com/frappe/lms/develop/docker/init.sh
```

--------------------------------

### Install Bench CLI

Source: https://docs.frappe.io/framework/user/en/installation

Install the Frappe Bench CLI using uv.

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

--------------------------------

### Start the Frappe web server with bench start

Source: https://docs.frappe.io/framework/user/en/tutorial/install-and-setup-bench

Run this command from the frappe-bench directory to start the Frappe web server. The output shows the services that start (redis_cache, redis_socketio, redis_queue, socketio, web, watch, schedule, worker_short, worker_long, worker_default) and the asset rebuilding process. The web server runs on http://0.0.0.0:8000/.

```bash
$ cd frappe-bench
$ bench start
18:16:36 system | redis_cache.1 started (pid=11231)
18:16:36 system | redis_socketio.1 started (pid=11233)
18:16:36 system | redis_queue.1 started (pid=11234)
18:16:36 system | socketio.1 started (pid=11236)
18:16:36 system | web.1 started (pid=11237)
18:16:36 system | watch.1 started (pid=11240)
18:16:36 system | schedule.1 started (pid=11241)
18:16:36 system | worker_short.1 started (pid=11242)
18:16:36 redis_queue.1 | 11234:C 10 Jul 2020 18:16:36.320 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
18:16:36 redis_queue.1 | 11234:C 10 Jul 2020 18:16:36.320 # Redis version=6.0.5, bits=64, commit=00000000, modified=0, pid=11234, just started
18:16:36 redis_queue.1 | 11234:C 10 Jul 2020 18:16:36.320 # Configuration loaded
18:16:36 system | worker_long.1 started (pid=11244)
18:16:36 redis_cache.1 | 11231:C 10 Jul 2020 18:16:36.318 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
18:16:36 redis_cache.1 | 11231:C 10 Jul 2020 18:16:36.318 # Redis version=6.0.5, bits=64, commit=00000000, modified=0, pid=11231, just started
18:16:36 redis_cache.1 | 11231:C 10 Jul 2020 18:16:36.318 # Configuration loaded
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.320 * Increased maximum number of open files to 10032 (it was originally set to 256).
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.325 * Increased maximum number of open files to 10032 (it was originally set to 256).
18:16:36 system | worker_default.1 started (pid=11245)
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.337 * Running mode=standalone, port=13000.
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.337 # Server initialized
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.337 * Ready to accept connections
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.367 * Running mode=standalone, port=11000.
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.367 # Server initialized
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.367 * Ready to accept connections
18:16:36 redis_socketio.1 | 11233:C 10 Jul 2020 18:16:36.359 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
18:16:36 redis_socketio.1 | 11233:C 10 Jul 2020 18:16:36.359 # Redis version=6.0.5, bits=64, commit=00000000, modified=0, pid=11233, just started
18:16:36 redis_socketio.1 | 11233:C 10 Jul 2020 18:16:36.359 # Configuration loaded
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.374 * Increased maximum number of open files to 10032 (it was originally set to 256).
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.417 * Running mode=standalone, port=12000.
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.418 # Server initialized
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.418 * Ready to accept connections
18:16:37 socketio.1 | listening on *: 9000
18:16:41 web.1 | * Running on http://0.0.0.0:8000/ (Press CTRL+C to quit)
18:16:41 web.1 | * Restarting with fsevents reloader
18:16:41 watch.1 | yarn run v1.22.4
18:16:41 watch.1 | $ node rollup/watch.js
18:16:42 watch.1 |
18:16:42 watch.1 | Rollup Watcher Started
18:16:42 watch.1 |
18:16:42 watch.1 | Watching...
18:16:42 web.1 | * Debugger is active!
18:16:42 web.1 | * Debugger PIN: 100-672-925
18:16:43 watch.1 | Rebuilding frappe-web-b4.css
18:16:44 watch.1 | Rebuilding frappe-chat-web.css
18:16:44 watch.1 | Rebuilding chat.js
18:16:45 watch.1 | Rebuilding frappe-recorder.min.js
18:16:48 watch.1 | Rebuilding checkout.min.js
18:16:48 watch.1 | Rebuilding frappe-web.min.js
18:16:51 watch.1 | Rebuilding bootstrap-4-web.min.js
18:16:52 watch.1 | Rebuilding control.min.js
18:16:54 watch.1 | Rebuilding dialog.min.js
18:16:57 watch.1 | Rebuilding desk.min.css
18:16:57 watch.1 | Rebuilding frappe-rtl.css
18:16:58 watch.1 | Rebuilding printview.css
18:16:58 watch.1 | Rebuilding desk.min.js
18:17:04 watch.1 | Rebuilding form.min.css
18:17:04 watch.1 | Rebuilding form.min.js
18:17:07 watch.1 | Rebuilding list.min.css
18:17:07 watch.1 | Rebuilding list.min.js
18:17:09 watch.1 | Rebuilding report.min.css
18:17:09 watch.1 | Rebuilding report.min.js
18:17:12 watch.1 | Rebuilding web_form.min.js
18:17:12 watch.1 | Rebuilding web_form.css
18:17:13 watch.1 | Rebuilding email.css
18:17:13 watch.1 | Rebuilding social.min.js
18:17:13 watch.1 | Rebuilding barcode_scanner.min.js
18:17:15 watch.1 | Rebuilding data_import_tools.min.js


```

--------------------------------

### Sample Bench Procfile

Source: https://docs.frappe.io/framework/user/en/bench/resources/bench-procfile

A sample Procfile for `bench start` that defines processes for Redis caching, queueing, and socketio, the Frappe web server, socketio, watch, schedule, and worker queues. The `auto` line at the end is part of the displayed example.

```plaintext
12345678910 redis_cache: redis-server config/rediscache.conf
 redis_socketio: redis-server config/redissocketio.conf
 redis_queue: redis-server config/redisqueue.conf
 web: bench serve --port 8000
 socketio: /usr/bin/node apps/frappe/socketio.js
 watch: bench watch
 schedule: bench schedule
 worker_short: bench worker --queue short
 worker_long: bench worker --queue long
 worker_default: bench worker --queue default

auto

```

--------------------------------

### Install Frappe Insights on existing ERPNext site

Source: https://docs.frappe.io/insights/get-started/installation

Commands to get and install the Frappe Insights app on an existing self-hosted ERPNext site. Use the bench commands as shown.

```bash
bench get-app insights --branch version-3
bench --site your_site_name install_app insights
```

--------------------------------

### Start bench with bench start

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Starts the bench development server. After starting, access Frappe/ERPNext at [your-external-ip]:8000 (usually localhost:8000). Default username is 'Administrator' and the password is the one set when creating the site.

```zsh
bench start
```

--------------------------------

### Start the Bench Server

Source: https://docs.frappe.io/framework/user/en/tutorial

Navigate to the frappe-bench directory and execute the bench start command to launch the server and its associated services.

```bash
$ cd frappe-bench
$ bench start
18:16:36 system | redis_cache.1 started (pid=11231)
18:16:36 system | redis_socketio.1 started (pid=11233)
18:16:36 system | redis_queue.1 started (pid=11234)
18:16:36 system | socketio.1 started (pid=11236)
18:16:36 system | web.1 started (pid=11237)
18:16:36 system | watch.1 started (pid=11240)
18:16:36 system | schedule.1 started (pid=11241)
18:16:36 system | worker_short.1 started (pid=11242)
18:16:36 redis_queue.1 | 11234:C 10 Jul 2020 18:16:36.320 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
18:16:36 redis_queue.1 | 11234:C 10 Jul 2020 18:16:36.320 # Redis version=6.0.5, bits=64, commit=00000000, modified=0, pid=11234, just started
18:16:36 redis_queue.1 | 11234:C 10 Jul 2020 18:16:36.320 # Configuration loaded
18:16:36 system | worker_long.1 started (pid=11244)
18:16:36 redis_cache.1 | 11231:C 10 Jul 2020 18:16:36.318 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
18:16:36 redis_cache.1 | 11231:C 10 Jul 2020 18:16:36.318 # Redis version=6.0.5, bits=64, commit=00000000, modified=0, pid=11231, just started
18:16:36 redis_cache.1 | 11231:C 10 Jul 2020 18:16:36.318 # Configuration loaded
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.320 * Increased maximum number of open files to 10032 (it was originally set to 256).
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.325 * Increased maximum number of open files to 10032 (it was originally set to 256).
18:16:36 system | worker_default.1 started (pid=11245)
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.337 * Running mode=standalone, port=13000.
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.337 # Server initialized
18:16:36 redis_cache.1 | 11231:M 10 Jul 2020 18:16:36.337 * Ready to accept connections
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.367 * Running mode=standalone, port=11000.
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.367 # Server initialized
18:16:36 redis_queue.1 | 11234:M 10 Jul 2020 18:16:36.367 * Ready to accept connections
18:16:36 redis_socketio.1 | 11233:C 10 Jul 2020 18:16:36.359 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
18:16:36 redis_socketio.1 | 11233:C 10 Jul 2020 18:16:36.359 # Redis version=6.0.5, bits=64, commit=00000000, modified=0, pid=11233, just started
18:16:36 redis_socketio.1 | 11233:C 10 Jul 2020 18:16:36.359 # Configuration loaded
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.374 * Increased maximum number of open files to 10032 (it was originally set to 256).
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.417 * Running mode=standalone, port=12000.
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.418 # Server initialized
18:16:36 redis_socketio.1 | 11233:M 10 Jul 2020 18:16:36.418 * Ready to accept connections
18:16:37 socketio.1 | listening on *: 9000
18:16:41 web.1 | * Running on http://0.0.0.0:8000/ (Press CTRL+C to quit)
18:16:41 web.1 | * Restarting with fsevents reloader
18:16:41 watch.1 | yarn run v1.22.4
18:16:41 watch.1 | $ node rollup/watch.js
18:16:42 watch.1 |
18:16:42 watch.1 | Rollup Watcher Started
18:16:42 watch.1 |
18:16:42 watch.1 | Watching...
18:16:42 web.1 | * Debugger is active!
18:16:42 web.1 | * Debugger PIN: 100-672-925
18:16:43 watch.1 | Rebuilding frappe-web-b4.css
18:16:44 watch.1 | Rebuilding frappe-chat-web.css
18:16:44 watch.1 | Rebuilding chat.js
18:16:45 watch.1 | Rebuilding frappe-recorder.min.js
18:16:48 watch.1 | Rebuilding checkout.min.js
18:16:48 watch.1 | Rebuilding frappe-web.min.js
18:16:51 watch.1 | Rebuilding bootstrap-4-web.min.js
18:16:52 watch.1 | Rebuilding control.min.js
18:16:54 watch.1 | Rebuilding dialog.min.js
18:16:57 watch.1 | Rebuilding desk.min.css
18:16:57 watch.1 | Rebuilding frappe-rtl.css
18:16:58 watch.1 | Rebuilding printview.css
18:16:58 watch.1 | Rebuilding desk.min.js
18:17:04 watch.1 | Rebuilding form.min.css
18:17:04 watch.1 | Rebuilding form.min.js
18:17:07 watch.1 | Rebuilding list.min.css
18:17:07 watch.1 | Rebuilding list.min.js
18:17:09 watch.1 | Rebuilding report.min.css
18:17:09 watch.1 | Rebuilding report.min.js
18:17:12 watch.1 | Rebuilding web_form.min.js
18:17:12 watch.1 | Rebuilding web_form.css
18:17:13 watch.1 | Rebuilding email.css
18:17:13 watch.1 | Rebuilding social.min.js
18:17:13 watch.1 | Rebuilding barcode_scanner.min.js
18:17:15 watch.1 | Rebuilding data_import_tools.min.js
```

--------------------------------

### Install an app: bench --site install-app

Source: https://docs.frappe.io/framework/user/en/bench/frappe-commands

Installs a Frappe application on the specified site. The app must already be installed on the bench. This installs the app's meta, modules, and doctypes on the site.

```bash
bench --site {site} install-app {app}
```

--------------------------------

### Check Bench version with bench --version

Source: https://docs.frappe.io/framework/user/en/tutorial

Run this command to verify that Bench is installed and to display its version. The expected output is the version number, for example 5.1.0.

```bash
$ bench --version
5.1.0

```

--------------------------------

### Install hooks: before_install, after_install, after_sync

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Define install hooks in `app/hooks.py` and implement the corresponding functions in `app/setup/install.py`. The functions run before installation, after installation, and after fixtures are synced.

```python
before_install = "app.setup.install.before_install"
after_install = "app.setup.install.after_install"
after_sync = "app.setup.install.after_sync"
```

```python
# will run before app is installed on site
def before_install():
    pass

# will run after app is installed on site
def after_install():
    pass

# will run after app fixtures are synced
def after_sync():
    pass
```

--------------------------------

### Install Nginx

Source: https://docs.frappe.io/learning/falcon-self-hosting-guide

Install the Nginx web server.

```bash
12sudo apt update
sudo apt install nginx
```

--------------------------------

### Get version info in JSON format

Source: https://docs.frappe.io/framework/user/en/bench/reference/bench-version

Example of retrieving version information using the short flag for JSON format.

```bash
bench version -f json
```

--------------------------------

### Install an app to a site

Source: https://docs.frappe.io/framework/user/en/guides/basics/apps

Use `bench --site site_name install-app app_name` to install the app to a specific site.

```bash
bench --site site_name install-app app_name

```

--------------------------------

### Example site_config.json

Source: https://docs.frappe.io/framework/user/en/basics/sites

Example site_config.json file. Values are available in the frappe.conf local variable as a dict.

```json
{
    "db_name": "test_frappe",
    "db_password": "test_frappe",
    "admin_password": "admin",
}

```

--------------------------------

### Install an app onto a site

Source: https://docs.frappe.io/framework/user/en/basics/apps

Install an app to a specific site to create its database models and tables.

```sh
123$ bench --site site_name install-app custom_app

Installing custom_app...
```

--------------------------------

### Bench Execute Command Examples

Source: https://docs.frappe.io/framework/user/en/bench/reference/execute

Various examples of using bench execute to run Python code on a Frappe site. Includes clearing cache, fetching documents, counting records, running whitelisted methods, checking record existence, getting configuration values, executing DocType methods, and chaining operations.

```bash
# Clear cache for a specific DocType
bench --site frappe.test execute frappe.clear_cache --doctype "Sales Order"

# Get a document
bench --site frappe.test execute frappe.get_doc User Administrator

# Count records
bench --site frappe.test execute frappe.db.count User

# Run a whitelisted method
bench --site frappe.test execute myapp.api.my_function --param1 value1 --param2 value2

# Check if a record exists
bench --site frappe.test execute frappe.db.exists User guest

# Get configuration value
bench --site frappe.test execute frappe.conf.get developer_mode

# Execute a DocType method
bench --site frappe.test execute "frappe.get_doc('User', 'Administrator').get_fullname()"

# Chain operations with Python expressions
bench --site frappe.test execute "frappe.get_doc('User', 'Administrator').add_roles('System Manager')"
```

--------------------------------

### Install uv

Source: https://docs.frappe.io/framework/user/en/installation

Install the uv package manager.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

--------------------------------

### List installed apps

Source: https://docs.frappe.io/framework/user/en/tutorial/create-a-site

Run this command to confirm the app was installed. The output lists frappe and library_management as installed apps.

```bash
123$ bench --site library.localhost list-apps
frappe
library_management

auto

```

--------------------------------

### Install an app with bench install-app

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Installs an app on a specific site. Use the --site flag to target the site.

```zsh
bench --site site1.local install-app erpnext
```

--------------------------------

### Enable developer mode and start bench

Source: https://docs.frappe.io/framework/user/en/tutorial/create-a-doctype

Run these commands from the frappe-bench directory to enable developer mode and start the bench server. The first command sets the developer_mode configuration to true, and the second starts the server.

```bash
bench set-config -g developer_mode true
bench start
```

--------------------------------

### Install Python via uv

Source: https://docs.frappe.io/framework/user/en/installation

Install Python 3.14 using uv.

```bash
uv python install 3.14 --default
```

--------------------------------

### Start development server with bench start

Source: https://docs.frappe.io/framework/user/en/debugging

The bench start command initiates all processes defined in the Procfile, displaying their output in the terminal. This includes logs for Redis, web servers, workers, and file watchers.

```bash
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556▶ bench start
14:55:17 system | redis_cache.1 started (pid=4085)
14:55:17 system | redis_socketio.1 started (pid=4086)
14:55:17 system | redis_queue.1 started (pid=4088)
14:55:17 system | web.1 started (pid=4089)
14:55:17 system | socketio.1 started (pid=4090)
14:55:17 system | watch.1 started (pid=4094)
14:55:17 system | worker_short.1 started (pid=4096)
14:55:17 system | schedule.1 started (pid=4095)
14:55:17 redis_queue.1 | 4088:C 22 May 14:55:17.257 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
14:55:17 redis_queue.1 | 4088:C 22 May 14:55:17.264 # Redis version=4.0.11, bits=64, commit=00000000, modified=0, pid=4088, just started
14:55:17 redis_queue.1 | 4088:C 22 May 14:55:17.264 # Configuration loaded
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.265 * Increased maximum number of open files to 10032 (it was originally set to 4864).
14:55:17 redis_cache.1 | 4085:C 22 May 14:55:17.262 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
14:55:17 redis_cache.1 | 4085:C 22 May 14:55:17.268 # Redis version=4.0.11, bits=64, commit=00000000, modified=0, pid=4085, just started
14:55:17 redis_cache.1 | 4085:C 22 May 14:55:17.268 # Configuration loaded
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.269 * Increased maximum number of open files to 10032 (it was originally set to 4864).
14:55:17 redis_socketio.1 | 4086:C 22 May 14:55:17.262 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
14:55:17 redis_socketio.1 | 4086:C 22 May 14:55:17.270 # Redis version=4.0.11, bits=64, commit=00000000, modified=0, pid=4086, just started
14:55:17 redis_socketio.1 | 4086:C 22 May 14:55:17.270 # Configuration loaded
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.272 * Increased maximum number of open files to 10032 (it was originally set to 4864).
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.285 * Running mode=standalone, port=11002.
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.285 # Server initialized
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.286 * Ready to accept connections
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.287 * Running mode=standalone, port=13002.
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.292 # Server initialized
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.292 * Ready to accept connections
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.294 * Running mode=standalone, port=12002.
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.294 # Server initialized
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.295 * Ready to accept connections
14:55:17 system | worker_long.1 started (pid=4098)
14:55:17 system | worker_default.1 started (pid=4100)
14:55:18 socketio.1 | listening on *: 9002
14:55:20 socketio.1 | { Error: connect ECONNREFUSED 0.0.0.0:8002
14:55:20 socketio.1 | at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1191:14)
14:55:20 socketio.1 | errno: 'ECONNREFUSED',
14:55:20 socketio.1 | code: 'ECONNREFUSED',
14:55:20 socketio.1 | syscall: 'connect',
14:55:20 socketio.1 | address: '0.0.0.0',
14:55:20 socketio.1 | port: 8002,
14:55:20 socketio.1 | response: undefined }
14:55:24 web.1 | * Running on http://0.0.0.0:8002/ (Press CTRL+C to quit)
14:55:24 web.1 | * Restarting with fsevents reloader
14:55:24 watch.1 | yarn run v1.10.1
14:55:24 watch.1 | $ node rollup/watch.js
14:55:25 web.1 | * Debugger is active!
14:55:25 web.1 | * Debugger PIN: 321-355-865
14:55:26 watch.1 |
14:55:26 watch.1 | Rollup Watcher Started
14:55:26 watch.1 |
14:55:26 watch.1 | Watching...
14:55:26 watch.1 | Rebuilding frappe-web.css
14:55:27 watch.1 | Rebuilding frappe-web-b4.css
14:55:27 watch.1 | Rebuilding chat.js
14:55:28 web.1 |
14:55:28 web.1 | test print

auto
```

--------------------------------

### Install Helpdesk on existing ERPNext site

Source: https://docs.frappe.io/helpdesk/introduction

Installs Frappe Helpdesk on an existing self-hosted ERPNext site. Run these commands in your bench environment.

```bash
bench get-app helpdesk --branch main
bench --site your_site_name install-app helpdesk
```

--------------------------------

### Install Bench with Easy Install script (--production)

Source: https://docs.frappe.io/framework/user/en/production-setup

Use the Easy Install script with the --production flag on supported Linux distributions (Debian, Ubuntu, CentOS) to deploy Frappe in production mode. Replace [frappe-user] with the user account you want to use.

```bash
sudo python install.py --production --user [frappe-user]
```

--------------------------------

### bench setup command usage

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

General usage for the bench setup command group. Run with the bench setup prefix to manipulate requirements and the environment for the current bench.

```zsh
1➜ bench setup COMMAND [ARGS]...

zsh
```

--------------------------------

### Pagination: GET /api/resource/:doctype?limit_start=5&amp;limit_page_length=10

Source: https://docs.frappe.io/framework/user/en/api/rest

Page results using `limit_start` and `limit_page_length` parameters. This example starts at offset 5 and returns 10 records.

```http
GET /api/resource/:doctype?limit_start=5&amp;limit_page_length=10
```

--------------------------------

### Deploy Frappe Helpdesk with easy-install

Source: https://docs.frappe.io/helpdesk/introduction

Deploys Frappe Helpdesk on your own server. Replace your_email.example.com with your email and subdomain.domain.tld with your domain. The setup takes about 5 minutes.

```bash
python3 ./easy-install.py deploy \
    --project=helpdesk_prod_setup \
    --email=your_email.example.com \
    --image=ghcr.io/frappe/helpdesk \
    --version=stable \
    --app=helpdesk \
    --sitename subdomain.domain.tld
```

--------------------------------

### Install Dependencies on Debian/Ubuntu

Source: https://docs.frappe.io/framework/user/en/installation

Install git, redis, and mariadb server/client packages.

```bash
sudo apt install git redis-server libmariadb-dev mariadb-server mariadb-client pkg-config
```

--------------------------------

### Deploy Frappe Learning with easy-install.py

Source: https://docs.frappe.io/learning/get-started/installation

Deploys a production-ready Frappe Learning instance. Replace your_email.example.com and subdomain.domain.tld with your values. The script takes about 5 minutes.

```bash
python3 ./easy-install.py deploy \
    --project=learning_prod_setup \
    --email=your_email.example.com \
    --image=ghcr.io/frappe/lms \
    --version=stable \
    --app=lms \
    --sitename subdomain.domain.tld
```

--------------------------------

### Install pycups in frappe-bench environment

Source: https://docs.frappe.io/erpnext/print-settings

Install the pycups library in the virtual environment from the frappe-bench directory.

```bash
./env/bin/pip install pycups
```

--------------------------------

### Install Yarn

Source: https://docs.frappe.io/framework/user/en/installation

Install Yarn globally using npm.

```bash
npm install -g yarn
```

--------------------------------

### Yarn install error: incompatible Node version

Source: https://docs.frappe.io/cloud/common-issues/incompatible-node-version

Example of a yarn install command output showing the incompatible Node version error. The error indicates the expected Node version is >=18.0.0 but the installed version is 16.16.0.

```bash
12345$ yarn install
yarn install v1.22.22
[1/5] Validating package.json...
error customization_forms@1.0.0: The engine "node" is incompatible with this module. Expected version ">=18.0.0". Got "16.16.0"
error Found incompatible module.

auto

```

--------------------------------

### Install frappe-gantt with npm

Source: https://docs.frappe.io/gantt/introduction

Installs the frappe-gantt package via npm.

```bash
npm install frappe-gantt
```

--------------------------------

### Start Docker containers

Source: https://docs.frappe.io/crm/introduction/installation

Starts the Docker containers for Frappe CRM development.

```bash
docker compose up -d
```

--------------------------------

### Output of bench new-app library_management

Source: https://docs.frappe.io/framework/user/en/tutorial/create-an-app

Example output from running 'bench new-app library_management'. Shows the prompts and defaults, the creation message, and the installation/build output.

```text
123456789101112131415161718App Title (default: Library Management):
App Description: Library Management System
App Publisher: Faris Ansari
App Email: faris@example.com
App Icon (default 'octicon octicon-file-directory'):
App Color (default 'grey'):
App License (default 'MIT'):
'library_management' created at /home/frappe/frappe-bench/apps/library_management

Installing library_management
$ ./env/bin/pip install -q -U -e ./apps/library_management
$ bench build --app library_management
yarn run v1.22.4
$ FRAPPE_ENV=production node rollup/build.js --app library_management
Production mode
✔ Built js/moment-bundle.min.js
✔ Built js/libs.min.js
✨  Done in 1.95s.

auto

```

--------------------------------

### Install app after site restore

Source: https://docs.frappe.io/framework/user/en/bench/reference/restore

Specifies an app to install after the site restore completes.

```bash
bench --site {site} restore {path/to/database/file}
--install-app {app}
```

--------------------------------

### Example workflow: create translation file

Source: https://docs.frappe.io/framework/user/en/guides/basics/translations

Path for creating the Arabic translation file in the example workflow.

```text
apps/my_app/my_app/translations/ar.csv

```

--------------------------------

### GET /api/method/frappe.auth.get_logged_user

Source: https://docs.frappe.io/framework/user/en/api/rest

Example of calling a whitelisted Python method via the REST API.

```APIDOC
## [GET] /api/method/frappe.auth.get_logged_user

### Description
Calls the whitelisted Python method `frappe.auth.get_logged_user` to get the logged-in user's email.

### Method
GET

### Endpoint
/api/method/frappe.auth.get_logged_user

### Response
#### Success Response (200)
- **message** (string) - The logged-in user's email.

#### Response Example
{
  "message": "john@doe.com"
}

```

--------------------------------

### Get human readable version info

Source: https://docs.frappe.io/framework/user/en/bench/reference/bench-version

Example of retrieving human-readable information with commit messages.

```bash
bench version --format plain
```

--------------------------------

### Install setuptools==80.9.0 on new bench via SSH

Source: https://docs.frappe.io/cloud/private-benches/common-issues/pkg-resources-error-when-updating-site

Run these two commands in the new bench environment to install the older setuptools that still includes pkg_resources. This is a temporary fix - you must repeat it after every deploy.

```bash
cd /home/frappe/frappe-bench
 env/bin/pip install setuptools==80.9.0

```

--------------------------------

### Install Node.js via nvm

Source: https://docs.frappe.io/framework/user/en/installation

Install Node.js version 24 using nvm.

```bash
nvm install 24
```

--------------------------------

### Install Press App

Source: https://docs.frappe.io/cloud/local-fc-setup

Command to install the Press application into your bench environment.

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

--------------------------------

### Install dayjs with yarn

Source: https://docs.frappe.io/framework/user/en/basics/asset-bundling

Run this command from the root of your apps folder to install the dayjs library.

```sh
cd frappe-bench/apps/myapp
yarn add dayjs
```

--------------------------------

### Install Required Packages via Homebrew

Source: https://docs.frappe.io/framework/user/en/installation

Install git, redis, mariadb, and related dependencies using Homebrew.

```bash
brew install git redis mariadb@11.8 pkg-config mariadb-connector-c
```

--------------------------------

### Example workflow: build site

Source: https://docs.frappe.io/framework/user/en/guides/basics/translations

Command to build the site, only needed if using __() in custom frontend JS and changed JS files.

```bash
bench --site my-site build

```

--------------------------------

### SSH Command with -vvvv for Debugging

Source: https://docs.frappe.io/cloud/benches/ssh

Example command to get verbose output for troubleshooting. Do not copy as is; add -vvvv to the command from the dashboard.

```bash
ssh <bench-name>@nx-region.frappe.cloud -p 2222 -vvvv
```

--------------------------------

### Response for GET /api/method/lending.api.get_repayment_schedule

Source: https://docs.frappe.io/lending/loan-management/api-documentation/proposed-repayment-schedule

Example response from the endpoint. Contains the loan details and an array of repayment periods with payment_date, principal_amount, interest_amount, total_payment, and balance_loan_amount.

```json
{
    "message": {
        "loan_amount": 25000.0,
        "rate_of_interest": 12.0,
        "tenure": 6,
        "repayment_start_date": "2026-02-27",
        "repayment_periods": [
            {
                "payment_date": "2026-02-27",
                "principal_amount": 4314.0,
                "interest_amount": 0.0,
                "total_payment": 4314.0,
                "balance_loan_amount": 20686.0
            },
            {
                "payment_date": "2026-03-27",
                "principal_amount": 4123.58,
                "interest_amount": 190.42,
                "total_payment": 4314.0,
                "balance_loan_amount": 16562.42
            },
            {
                "payment_date": "2026-04-27",
                "principal_amount": 4145.2,
                "interest_amount": 168.8,
                "total_payment": 4314.0,
                "balance_loan_amount": 12417.22
            },
            {
                "payment_date": "2026-05-27",
                "principal_amount": 4191.53,
                "interest_amount": 122.47,
                "total_payment": 4314.0,
                "balance_loan_amount": 8225.69
            },
            {
                "payment_date": "2026-06-27",
                "principal_amount": 4230.17,
                "interest_amount": 83.83,
                "total_payment": 4314.0,
                "balance_loan_amount": 3995.52
            },
            {
                "payment_date": "2026-07-27",
                "principal_amount": 3995.52,
                "interest_amount": 39.41,
                "total_payment": 4034.93,
                "balance_loan_amount": 0.0
            }
        ]
    }
}
```

--------------------------------

### frappe.cache() usage example

Source: https://docs.frappe.io/framework/user/en/api/utils

Uses frappe.cache() to get a Redis connection and store/retrieve key-value pairs. The cache object is an instance of RedisWrapper, which inherits from redis.Redis.

```python
import frappe

cache = frappe.cache()

cache.set('name', 'frappe') # True
cache.get('name') # b'frappe'
```

--------------------------------

### Create a new app with bench new-app

Source: https://docs.frappe.io/framework/user/en/guides/basics/apps

Run `bench new-app sample_app` to start an interactive shell that prompts for app details. The output shows the prompts and the entered values.

```bash
% bench new-app sample_app
 App Name: sample_app
 App Title: Sample App
 App Description: This is a sample app.
 App Publisher: Acme Inc.
 App Icon: icon-linux
 App Color: #6DAFC9
 App Email: info@example.com
 App URL: http://example.com
 App License: MIT

```

--------------------------------

### bench set-limit example for user count

Source: https://docs.frappe.io/framework/user/en/bench/guides/settings-limits

Example command that sets the `users` limit to 5 for the site `site1.local`. This restricts the maximum number of users for the site.

```bash
bench --site site1.local set-limit users 5
```

--------------------------------

### Initialize MariaDB Security

Source: https://docs.frappe.io/framework/user/en/installation

Run the security installation script if the MySQL root password was not set during the initial package installation.

```bash
sudo mariadb-secure-installation
```
Tokens:
Raw