Package: ifrappe-bench
BenchBench is a command-line utility that helps you to install, update, and manage multiple sites for Frappe/ERPNext applications on*nix systemsfor development and production.Table of ContentsTable of ContentsInstallationContainerized InstallationEasy Install ScriptSetupArgumentsTroubleshootingManual InstallationBasic UsageCustom Bench CommandsGuidesResourcesDevelopmentReleasesLicenseInstallationA typical bench setup provides two types of environments — Development and Production.The setup for each of these installations can be achieved in multiple ways:Containerized InstallationManual InstallationWe recommend using Docker Installation to setup a Production Environment. For Development, you may choose either of the two methods to setup an instance.Otherwise, if you are looking to evaluate Frappe apps without hassle of hosting, you can try themon frappecloud.com.Containerized InstallationA Frappe/ERPNext instance can be setup and replicated easily usingDocker. The officially supported Docker installation can be used to setup either of both Development and Production environments.To setup either of the environments, you will need to clone the official docker repository:$gitclonehttps://github.com/frappe/frappe_docker.git
$cdfrappe_dockerA quick setup guide for both the environments can be found below. For more details, check out theFrappe/ERPNext Docker Repository.Easy Install ScriptThe Easy Install script should get you going with a Frappe/ERPNext setup with minimal manual intervention and effort.This script uses Docker with theFrappe/ERPNext Docker Repositoryand can be used for both Development setup and Production setup.SetupDownload the Easy Install script and execute it:OBS:geraressaURLcomumtokenvalidoquandousar...
$wgethttps://raw.githubusercontent.com/HarryPaulo/bench/version-14/easy-install.py?token=GHSAT0AAAAAAB4FNP6WETPRAHXLBGVEG4C2ZCIGD7A-Oeasy-install.py
$python3easy-install.py--prod--emailyour@email.tldThis script will install docker on your system and will fetch the required containers, setup bench and a default ERPNext instance.The script will generate MySQL root password and an Administrator password for the Frappe/ERPNext instance, which will then be saved under$HOME/passwords.txtof the user used to setup the instance.
It will also generate a new compose file under$HOME/<project-name>-compose.yml.When the setup is complete, you will be able to access the system athttp://<your-server-ip>, wherein you can use the Administrator password to login.ArgumentsHere are the arguments for the easy-install scriptusage: easy-install.py [-h] [-p] [-d] [-s SITENAME] [-n PROJECT] [--email EMAIL]

Install Frappe with Docker

options:
  -h, --help            		show this help message and exit
  -p, --prod            		Setup Production System
  -d, --dev             		Setup Development System
  -s SITENAME, --sitename SITENAME      The Site Name for your production site
  -n PROJECT, --project PROJECT         Project Name
  --email EMAIL         		Add email for the SSL.TroubleshootingIn case the setup fails, the log file is saved under$HOME/easy-install.log. You may thenCreate an Issue in this repository with the log file attached.Manual InstallationSome might want to manually setup a bench instance locally for development. To quickly get started on installing bench the hard way, you can follow the guide onInstalling Bench and the Frappe Framework.You'll have to set up the system dependencies required for setting up a Frappe Environment. Checkoutdocs/installationfor more information on this. If you've already set up, install bench via pip:$pipinstallfrappe-benchBasic UsageNote:Apart frombench init, all other bench commands are expected to be run in the respective bench directory.Create a new bench:$benchinit[bench-name]Add a site under current bench:$benchnew-site[site-name]Optional: If the database for the site does not reside on localhost or listens on a custom port, you can use the flags--db-hostto set a custom host and/or--db-portto set a custom port.$benchnew-site[site-name]--db-host[custom-db-host-ip]--db-port[custom-db-port]Download and add applications to bench:$benchget-app[app-name][app-link]Install apps on a particular site$bench--site[site-name]install-app[app-name]Start bench (only for development)$benchstartShow bench help:$bench--helpFor more in-depth information on commands and their usage, followCommands and Usage. As for a consolidated list of bench commands, check outBench Usage.Custom Bench CommandsIf you wish to extend the capabilities of bench with your own custom Frappe Application, you may followAdding Custom Bench Commands.GuidesConfiguring HTTPSUsing Let's Encrypt to setup HTTPSDiagnosing the SchedulerChange HostnameManual SetupSetup ProductionSetup MultitenancyStopping ProductionFor an exhaustive list of guides, check outBench Guides.ResourcesBench Commands Cheat SheetBackground ServicesBench ProcfileFor an exhaustive list of resources, check outBench Resources.DevelopmentTo contribute and develop on the bench CLI tool, clone this repo and create an editable install. In editable mode, you may get the following warning everytime you run a bench command:WARN: bench is installed in editable mode!

This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install frappe-bench`$gitclonehttps://github.com/frappe/bench~/bench-repo
$pip3install-e~/bench-repo
$benchsrc
/Users/frappe/bench-repoTo clear up the editable install and switch to a stable version of bench, uninstall via pip and delete the corresponding egg file from the python path.# Delete bench installed in editable install$rm-r$(find~-name'*.egg-info')$pip3uninstallfrappe-bench# Install latest released version of bench$pip3install-Ufrappe-benchTo confirm the switch, check the output ofbench src. It should change from something like$HOME/bench-repoto/usr/local/lib/python3.6/dist-packagesand stop the editable install warnings from getting triggered at every command.ReleasesBench's version information can be accessed viabench.VERSIONin the package'sinit.py file. Eversince the v5.0 release, we've started publishing releases on GitHub, and PyPI.GitHub:https://github.com/frappe/bench/releasesPyPI:https://pypi.org/project/frappe-benchFrom v5.3.0, we partially automated the release process using@semantic-release. Under this new pipeline, we do the following steps to make a release:Mergedevelopinto thestagingbranchMergestaginginto the latest stable branch, which isv5.xat this point.This triggers a GitHub Action job that generates a bump commit, drafts and generates a GitHub release, builds a Python package and publishes it to PyPI.The intermediatestagingbranch exists to mediate thebench.VERSIONconflict that would arise while mergingdevelopand stable. On develop, the version has to be manually updated (for major release changes). The version tag plays a role in deciding when checks have to be made for new Bench releases.Note: We may want to kill the convention of separate branches for different version releases of Bench. We don't need to maintain this the way we do for Frappe & ERPNext. A single branch namedstablewould sustain.LicenseThis repository has been released under theGNU GPLv3 License.