accounting/bench
2
0
Fork 0
mirror of https://github.com/frappe/bench.git synced 2024-09-22 12:09:02 +00:00
Code Issues Releases Activity
9107581a56
bench/docs/installation.md
Gavin D'souza f48bb5a130 chore: updated and consolidated readme 
- added visual hierarchy and structure to text
- added table of contents
- breakdown additional information about each section in their respective
files
2020-01-16 17:48:43 +05:30

2.4 KiB
Raw Blame History

Requirements

You will need a computer/server. Options include:

  • A Normal Computer/VPS/Baremetal Server: This is strongly recommended. Frappe/ERPNext installs properly and works well on these
  • A Raspberry Pi, SAN Appliance, Network Router, Gaming Console, etc.: Although you may be able to install Frappe/ERPNext on specialized hardware, it is unlikely to work well and will be difficult for us to support. Strongly consider using a normal computer/VPS/baremetal server instead. We do not support specialized hardware.
  • A Toaster, Car, Firearm, Thermostat, etc.: Yes, many modern devices now have embedded computing capability. We live in interesting times. However, you should not install Frappe/ERPNext on these devices. Instead, install it on a normal computer/VPS/baremetal server. We do not support installing on noncomputing devices.

To install the Frappe/ERPNext server software, you will need an operating system on your normal computer which is not Windows. Note that the command line interface does work on Windows, and you can use Frappe/ERPNext from any operating system with a web browser. However, the server software does not run on Windows. It does run on other operating systems, so choose one of these instead:

  • Linux: Ubuntu, Debian, CentOS are the preferred distros and are tested. Arch Linux can also be used
  • Mac OS X

Manual Install

To manually install frappe/erpnext, you can follow this this wiki for Linux and this wiki for MacOS. It gives an excellent explanation about the stack. You can also follow the steps mentioned below:

1. Install Prerequisites

• Python 3.6+
• Node.js 12
• Redis 5					(caching and realtime updates)
• MariaDB 10.3 / Postgres 9.5			(to run database driven apps)
• yarn 1.12+					(js dependency manager)
• pip 15+					(py dependency manager)
• cron 						(scheduled jobs)
• wkhtmltopdf (version 0.12.5 with patched qt) 	(for pdf generation)
• Nginx 					(for production)

2. Install Bench

Install bench as a non root user,

git clone https://github.com/frappe/bench ~/.bench
pip3 install --user -e ~/.bench

Note: Please do not remove the bench directory the above commands will create