mirror of
https://github.com/frappe/bench.git
synced 2025-01-04 22:55:25 +00:00
docs: remove easy install from docs (#1380)
https://discuss.erpnext.com/t/deprecation-easy-install-script-is-no-longer-supported/96245/3 [skip ci]
This commit is contained in:
parent
9fd15f6fdd
commit
09274ed305
74
README.md
74
README.md
@ -33,7 +33,6 @@ Bench is a command-line utility that helps you to install, update, and manage mu
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Containerized Installation](#containerized-installation)
|
||||
- [Easy Install Script](#easy-install-script)
|
||||
- [Manual Installation](#manual-installation)
|
||||
- [Usage](#basic-usage)
|
||||
- [Custom Bench commands](#custom-bench-commands)
|
||||
@ -52,12 +51,11 @@ A typical bench setup provides two types of environments — Development and
|
||||
The setup for each of these installations can be achieved in multiple ways:
|
||||
|
||||
- [Containerized Installation](#containerized-installation)
|
||||
- [Easy Install Script](#easy-install-script)
|
||||
- [Manual Installation](#manual-installation)
|
||||
|
||||
We recommend using either the Docker Installation or the Easy Install Script to setup a Production Environment. For Development, you may choose either of the three methods to setup an instance.
|
||||
We recommend using either the 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 ERPNext, you can register for [a free trial on erpnext.com](https://erpnext.com/pricing).
|
||||
Otherwise, if you are looking to evaluate Frappe apps without hassle of hosting, you can try them [on frappecloud.com](https://frappecloud.com/).
|
||||
|
||||
|
||||
### Containerized Installation
|
||||
@ -73,53 +71,6 @@ $ cd frappe_docker
|
||||
|
||||
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).
|
||||
|
||||
### Easy Install Script
|
||||
|
||||
The Easy Install script should get you going with a Frappe/ERPNext setup with minimal manual intervention and effort. Since there are a lot of configurations being automatically setup, we recommend executing this script on a fresh server.
|
||||
|
||||
**Note:** This script works only on GNU/Linux based server distributions, and has been designed and tested to work on Ubuntu 16.04+, CentOS 7+, and Debian-based systems.
|
||||
|
||||
> This script installs Version 12 by default. It is untested with Version 13 and above. Containerized or manual installs are recommended for newer setups.
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
You need to install the following packages for the script to run:
|
||||
|
||||
- ##### Ubuntu and Debian-based Distributions:
|
||||
|
||||
```sh
|
||||
$ apt install python3-minimal build-essential python3-setuptools
|
||||
```
|
||||
|
||||
- ##### CentOS and other RPM Distributions:
|
||||
|
||||
```sh
|
||||
$ dnf groupinstall "Development Tools"
|
||||
$ dnf install python3
|
||||
```
|
||||
|
||||
#### Setup
|
||||
|
||||
Download the Easy Install script and execute it:
|
||||
|
||||
```sh
|
||||
$ wget https://raw.githubusercontent.com/frappe/bench/develop/install.py
|
||||
$ python3 install.py --production
|
||||
```
|
||||
|
||||
The script should then prompt you for the MySQL root password and an Administrator password for the Frappe/ERPNext instance, which will then be saved under `$HOME/passwords.txt` of the user used to setup the instance. This script will then install the required stack, setup bench and a default ERPNext instance.
|
||||
|
||||
When the setup is complete, you will be able to access the system at `http://<your-server-ip>`, wherein you can use the administrator password to login.
|
||||
|
||||
#### Troubleshooting
|
||||
|
||||
In case the setup fails, the log file is saved under `/tmp/logs/install_bench.log`. You may then:
|
||||
|
||||
- Create an Issue in this repository with the log file attached.
|
||||
- Search for an existing issue or post the log file on the [Frappe/ERPNext Discuss Forum](https://discuss.erpnext.com/c/bench) with the tag `installation_problem` under "Install/Update" category.
|
||||
|
||||
For more information and advanced setup instructions, check out the [Easy Install Documentation](https://github.com/frappe/bench/blob/develop/docs/easy_install.md).
|
||||
|
||||
|
||||
### Manual Installation
|
||||
|
||||
@ -132,11 +83,6 @@ You'll have to set up the system dependencies required for setting up a Frappe E
|
||||
$ pip install frappe-bench
|
||||
```
|
||||
|
||||
For more extensive distribution-dependent documentation, check out the following guides:
|
||||
|
||||
- [Hitchhiker's Guide to Installing Frappe on Linux](https://github.com/frappe/frappe/wiki/The-Hitchhiker%27s-Guide-to-Installing-Frappe-on-Linux)
|
||||
- [Hitchhiker's Guide to Installing Frappe on MacOS](https://github.com/frappe/bench/wiki/Setting-up-a-Mac-for-Frappe-ERPNext-Development)
|
||||
|
||||
|
||||
## Basic Usage
|
||||
|
||||
@ -192,22 +138,6 @@ For more in-depth information on commands and their usage, follow [Commands and
|
||||
If you wish to extend the capabilities of bench with your own custom Frappe Application, you may follow [Adding Custom Bench Commands](https://github.com/frappe/bench/blob/develop/docs/bench_custom_cmd.md).
|
||||
|
||||
|
||||
## Bench Manager
|
||||
|
||||
[Bench Manager](https://github.com/frappe/bench_manager) is a GUI frontend for Bench with the same functionalties. You can install it by executing the following command:
|
||||
|
||||
```sh
|
||||
$ bench setup manager
|
||||
```
|
||||
|
||||
- **Note:** This will create a new site to setup Bench Manager, if you want to set it up on an existing site, run the following commands:
|
||||
|
||||
```sh
|
||||
$ bench get-app https://github.com/frappe/bench_manager.git
|
||||
$ bench --site <sitename> install-app bench_manager
|
||||
```
|
||||
|
||||
|
||||
## Guides
|
||||
|
||||
- [Configuring HTTPS](https://frappe.io/docs/user/en/bench/guides/configuring-https.html)
|
||||
|
Loading…
Reference in New Issue
Block a user