-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Akhil Narang <[email protected]>
- Loading branch information
1 parent
6d2ce96
commit 1f399ad
Showing
2 changed files
with
72 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,28 @@ | ||
| <div align="center"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://github.com/frappe/design/raw/master/logos/png/bench-logo-dark.png"> | ||
| <img src="https://github.com/frappe/design/raw/master/logos/png/bench-logo.png" height="128"> | ||
| </picture> | ||
| <h2>Bench</h2> | ||
| </div> | ||
|
|
||
| Bench is a command-line utility that helps you to install, update, and manage multiple sites for Frappe/ERPNext applications on [*nix systems](https://en.wikipedia.org/wiki/Unix-like) for development and production. | ||
|  | ||
|
|
||
| ## Bench | ||
| **CLI to manage Frappe applications** | ||
|
|
||
|
|
||
| [](https://www.python.org/downloads/) | ||
| [](https://pypi.org/project/frappe-bench) | ||
|  | ||
|
|
||
| <div align="center"> | ||
| <a target="_blank" href="https://www.python.org/downloads/" title="Python version"> | ||
| <img src="https://img.shields.io/badge/python-%3E=_3.8-green.svg"> | ||
| </a> | ||
| <a target="_blank" href="https://app.travis-ci.com/github/frappe/bench" title="CI Status"> | ||
| <img src="https://app.travis-ci.com/frappe/bench.svg?branch=develop"> | ||
| </a> | ||
| <a target="_blank" href="https://pypi.org/project/frappe-bench" title="PyPI Version"> | ||
| <img src="https://badge.fury.io/py/frappe-bench.svg" alt="PyPI version"> | ||
| </a> | ||
| <a target="_blank" title="Platform Compatibility"> | ||
| <img src="https://img.shields.io/badge/platform-linux%20%7C%20osx-blue"> | ||
| </a> | ||
| <a target="_blank" href="https://app.fossa.com/projects/git%2Bgithub.com%2Ffrappe%2Fbench?ref=badge_shield" title="FOSSA Status"> | ||
| <img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffrappe%2Fbench.svg?type=shield"> | ||
| </a> | ||
| <a target="_blank" href="#LICENSE" title="License: GPLv3"> | ||
| <img src="https://img.shields.io/badge/License-GPLv3-blue.svg"> | ||
| </a> | ||
| </div> | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Table of Contents](#table-of-contents) | ||
| - [Installation](#installation) | ||
| - [Containerized Installation](#containerized-installation) | ||
| - [Easy Install Script](#easy-install-script) | ||
| - [Setup](#setup) | ||
| - [Arguments](#arguments) | ||
| - [Troubleshooting](#troubleshooting) | ||
| - [Manual Installation](#manual-installation) | ||
| - [Basic Usage](#basic-usage) | ||
| - [Custom Bench Commands](#custom-bench-commands) | ||
| - [Guides](#guides) | ||
| - [Resources](#resources) | ||
| - [Development](#development) | ||
| - [Releases](#releases) | ||
| - [License](#license) | ||
| ## Bench | ||
|
|
||
| Bench is a command-line utility that helps you to install, update, and manage multiple sites for Frappe applications on [*nix systems](https://en.wikipedia.org/wiki/Unix-like) for development and production. | ||
|
|
||
| ## Key features | ||
|
|
||
| Bench helps you set up and manage your frappe sites with ease. Here are some of the key features: | ||
| - Initializing a new bench | ||
| - Creating a new site | ||
| - Creating and installing apps | ||
| - Managing sites | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -59,35 +35,42 @@ The setup for each of these installations can be achieved in multiple ways: | |
|
|
||
| We 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 them [on frappecloud.com](https://frappecloud.com/). | ||
| Otherwise, if you are looking to evaluate Frappe apps without the hassle of managing hosting yourself, you can try them on [Frappe Cloud](https://frappecloud.com/). | ||
|
|
||
| <div> | ||
| <a href="https://frappecloud.com/dashboard/signup" target="_blank"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png"> | ||
| <img src="https://frappe.io/files/try-on-fc-black.png" alt="Try on Frappe Cloud" height="28" /> | ||
| </picture> | ||
| </a> | ||
| </div> | ||
|
|
||
| ### Containerized Installation | ||
|
|
||
| A Frappe/ERPNext instance can be setup and replicated easily using [Docker](https://docker.com). The officially supported Docker installation can be used to setup either of both Development and Production environments. | ||
| A Frappe instance can be setup and replicated easily using [Docker](https://docker.com). 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: | ||
|
|
||
| ```sh | ||
| $ git clone https://github.com/frappe/frappe_docker.git | ||
| $ cd frappe_docker | ||
| git clone https://github.com/frappe/frappe_docker.git | ||
| ``` | ||
|
|
||
| A quick setup guide for both the environments can be found below. For more details, check out the [Frappe/ERPNext Docker Repository](https://github.com/frappe/frappe_docker). | ||
| A quick setup guide for both the environments can be found below. For more details, check out the [Frappe Docker Repository](https://github.com/frappe/frappe_docker). | ||
|
|
||
| ### Easy Install Script | ||
|
|
||
| The Easy Install script should get you going with a Frappe/ERPNext setup with minimal manual intervention and effort. | ||
| The Easy Install script should get you going with a Frappe setup with minimal manual intervention and effort. | ||
|
|
||
| This script uses Docker with the [Frappe/ERPNext Docker Repository](https://github.com/frappe/frappe_docker) and can be used for both Development setup and Production setup. | ||
| This script uses Docker with the [Frappe Docker Repository](https://github.com/frappe/frappe_docker) and can be used for both Development setup and Production setup. | ||
|
|
||
| #### Setup | ||
|
|
||
| Download the Easy Install script and execute it: | ||
|
|
||
| ```sh | ||
| $ wget https://raw.githubusercontent.com/frappe/bench/develop/easy-install.py | ||
| $ python3 easy-install.py deploy [email protected] --sitename=subdomain.domain.tld --app=erpnext | ||
| wget https://raw.githubusercontent.com/frappe/bench/develop/easy-install.py | ||
| python3 easy-install.py deploy [email protected] --sitename=subdomain.domain.tld --app=erpnext | ||
| ``` | ||
|
|
||
| This script will install docker on your system and will fetch the required containers, setup bench and a default ERPNext instance. | ||
|
|
@@ -253,14 +236,7 @@ In case the setup fails, the log file is saved under `$HOME/easy-install.log`. Y | |
|
|
||
| ### Manual Installation | ||
|
|
||
| Some 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 on [Installing Bench and the Frappe Framework](https://frappe.io/docs/user/en/installation). | ||
|
|
||
| You'll have to set up the system dependencies required for setting up a Frappe Environment. Checkout [docs/installation](https://github.com/frappe/bench/blob/develop/docs/installation.md) for more information on this. If you've already set up, install bench via pip: | ||
|
|
||
|
|
||
| ```sh | ||
| $ pip install frappe-bench | ||
| ``` | ||
| Check out [docs/installation](https://docs.frappe.io/framework/user/en/tutorial/install-and-setup-bench) for more information on this | ||
|
|
||
|
|
||
| ## Basic Usage | ||
|
|
@@ -348,49 +324,61 @@ To contribute and develop on the bench CLI tool, clone this repo and create an e | |
|
|
||
| This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install frappe-bench` | ||
|
|
||
| ### Clone and install | ||
|
|
||
| ```sh | ||
| $ git clone https://github.com/frappe/bench ~/bench-repo | ||
| $ pip3 install -e ~/bench-repo | ||
| $ bench src | ||
| /Users/frappe/bench-repo | ||
| git clone https://github.com/frappe/bench ~/bench-repo | ||
| pip install -e ~/bench-repo | ||
| ``` | ||
|
|
||
| To 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. | ||
| ```shell | ||
| bench src | ||
| ``` | ||
| This should display $HOME/bench-repo | ||
|
|
||
| ### To clear up the editable install and delete the corresponding egg file from the python path: | ||
|
|
||
| ```sh | ||
| # Delete bench installed in editable install | ||
| $ rm -r $(find ~ -name '*.egg-info') | ||
| $ pip3 uninstall frappe-bench | ||
| rm -r $(find ~ -name '*.egg-info') | ||
| pip uninstall frappe-bench | ||
| ``` | ||
|
|
||
| # Install latest released version of bench | ||
| $ pip3 install -U frappe-bench | ||
| ### Then you can install the latest from PyPI | ||
| ```sh | ||
| pip install -U frappe-bench | ||
| ``` | ||
|
|
||
| To confirm the switch, check the output of `bench src`. It should change from something like `$HOME/bench-repo` to `/usr/local/lib/python3.6/dist-packages` and stop the editable install warnings from getting triggered at every command. | ||
| To confirm the switch, check the output of `bench src`. It should change from something like `$HOME/bench-repo` to `/usr/local/lib/python3.12/dist-packages` and stop the editable install warnings from getting triggered at every command. | ||
|
|
||
|
|
||
| ## Releases | ||
|
|
||
| Bench's version information can be accessed via `bench.VERSION` in the package's __init__.py file. Eversince the v5.0 release, we've started publishing releases on GitHub, and PyPI. | ||
|
|
||
| GitHub: https://github.com/frappe/bench/releases | ||
|
|
||
| PyPI: https://pypi.org/project/frappe-bench | ||
|
|
||
| Bench's version information can be accessed via `bench.VERSION` in the package's __init__.py file. Ever since the v5.0 release, we've started publishing releases on GitHub, and PyPI. | ||
|
|
||
| From v5.3.0, we partially automated the release process using [@semantic-release](.github/workflows/release.yml). Under this new pipeline, we do the following steps to make a release: | ||
| [GitHub](https://github.com/frappe/bench/releases) | ||
| [Pypi](https://pypi.org/project/frappe-bench) | ||
|
|
||
| 1. Merge `develop` into the `staging` branch | ||
| 1. Merge `staging` into the latest stable branch, which is `v5.x` at 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. | ||
| ## Learn and connect | ||
|
|
||
| The intermediate `staging` branch exists to mediate the `bench.VERSION` conflict that would arise while merging `develop` and 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. | ||
| - [Discuss](https://discuss.frappe.io/) | ||
| - [YouTube](https://www.youtube.com/@frappetech) | ||
|
|
||
| > 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 named `stable` would sustain. | ||
| ## Contribute | ||
| To contribute to this project, please review the [Contribution Guidelines](https://github.com/frappe/erpnext/wiki/Contribution-Guidelines) for detailed instructions. Make sure to follow our [Code of Conduct](https://github.com/frappe/frappe/blob/develop/CODE_OF_CONDUCT.md) to keep the community welcoming and respectful. | ||
|
|
||
| ## License | ||
| ## Security | ||
| The Frappe team and community prioritize security. If you discover a security issue, please report it via our [Security Report Form](https://frappe.io/security). | ||
| Your responsible disclosure helps keep Frappe and its users safe. We'll do our best to respond quickly and keep you informed throughout the process. | ||
| For guidelines on reporting, check out our [Reporting Guidelines](https://frappe.io/security), and review our [Logo and Trademark Policy](https://github.com/frappe/erpnext/blob/develop/TRADEMARK_POLICY.md) for branding information. | ||
|
|
||
| This repository has been released under the [GNU GPLv3 License](LICENSE). | ||
| <br/><br/> | ||
| <div align="center"> | ||
| <a href="https://frappe.io" target="_blank"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png"> | ||
| <img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/> | ||
| </picture> | ||
| </a> | ||
| </div> | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.