Skip to content
This repository has been archived by the owner on Oct 15, 2020. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'refs/remotes/origin/develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
jwrober committed Nov 19, 2017
2 parents 7e2f69d + c6086cc commit e722bbb
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 14 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This is the ERPNext Administrator's Guide. All content in this guide is generated in markdown (MD) language. The purpose of this guide is to provide self-hosters of the [ERPNext](https://erpnext.org "ERPNext Website") system a place to capture tips and tricks on administering this complex platform.

If you would like to contribute to the maintenance of this guide, please PM me from the [ERPNext Discussion Forum](https://discuss.erpnext.com/) to get added to the repo. I go by the handle `james_robertson` there. Also, please read the [Contributing Guidelines](https://github.com/jwrober/erpnext_admin_guide/wiki/Contributing-Guidelines) as well.

<a rel="license" href="http://creativecommons.org/licenses/by-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nd/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nd/4.0/">Creative Commons Attribution-NoDerivatives 4.0 International License</a>.

## Table of Contents

* 1 Preface
Expand Down
8 changes: 4 additions & 4 deletions i-u-b/bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Once you have logged on to the server and become the `erpnext` user, you are rea
* **pids** -- Process ID Files
* **env** -- The `bench` operating environment
* **bin** -- `python` executables and scripts
* **include** -- Links to python 2.7 includes
* **lib** -- Python 2.7 libraries
* **local** -- Python 2.7 local
* **include** -- Links to python includes
* **lib** -- Python libraries
* **local** -- Python local
* **selenium** -- Web [browser automation](http://www.seleniumhq.org/ "Selenium Website") tool
* **share** -- `man` pages
* **src** -- Other utilities like `mysqlclient` and `pdfkit`.
Expand All @@ -48,6 +48,6 @@ Once you have logged on to the server and become the `erpnext` user, you are rea

Administrators need to be comfortable with the frappe `bench` command structure.

There is a [cheat sheet](https://frappe.io/docs/user/en/bench/resources/bench-commands-cheatsheet "Frappe Bench Commands Cheetsheet") available at the link below that is a good start.<br /><br />
There is a [cheat sheet](https://frappe.io/docs/user/en/bench/resources/bench-commands-cheatsheet "Frappe Bench Commands Cheetsheet") available that is a good start.<br /><br />

Previous: [2.2 Getting Help](../introduction/help.md "Getting Help") | Next: [3.1.3 Wonderful World of git](git.md "The Wonderful World of git")
4 changes: 2 additions & 2 deletions i-u-b/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For Red Hat based distributions (CentOS) start by installing a collection of sof
lcms2-devel libXext libXrender libffi-devel libjpeg-devel libselinux-python \
libtiff-devel libwebp-devel libxml2 libxml2-devel libxslt libxslt-devel \
libzip-devel mariadb-devel mariadb-server nginx nodejs npm openssl-devel \
postfix python-2.7.5 python-devel python-setuptools redhat-lsb-core redis \
postfix python-2 python-devel python-setuptools redhat-lsb-core redis \
sudo supervisor tcl-devel tk-devel wget which xorg-x11-fonts-75dpi \
xorg-x11-fonts-Type1 zlib-devel
sudo shutdown -r now
Expand All @@ -48,7 +48,7 @@ Now to create the `erpnext` user. Run these commands:
sudo useradd -m erpnext
sudo passwd erpnext

The group `sudo` might not exist on every platform. For example if you run a server in the Google Compute Engine instance the group is `google-suoders` and many base Debian based distributions use the `sudoers` group. Before running the next command run
The group `sudo` might not exist on every platform. For example, if you run a server in the Google Compute Engine instance the group is `google-suoders` and many base Debian based distributions use the `sudoers` group. Before running the next command run

cat /etc/group

Expand Down
7 changes: 3 additions & 4 deletions i-u-b/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## 3.3 Upgrading ERPNext

In this section we go over steps to upgrade ERPNext. One of the things that comes up very often on the [Discussion Forum](https://discuss.erpnext.com/ "ERPNext Discussion Forum") is upgrade issues. So besides installation issues, the author would say that the second most often cries for help are from challenges related to upgrading ERPNext. What is interesting is in most cases the administrator is the one who caused their issue because they didn't take the time to be prepared and get setup in a way to allow them plenty of flexibilty to upgrade in a safe evironment.
In this section we go over steps to upgrade ERPNext. One of the things that comes up very often on the [Discussion Forum](https://discuss.erpnext.com/ "ERPNext Discussion Forum") is upgrade issues. So besides installation issues, the author would say that the second most often cries for help are from challenges related to upgrading ERPNext. What is interesting is in most cases the administrator is the one who caused their own issue because they didn't take the time to be prepared and get setup in a way to allow them plenty of flexibilty to upgrade in a safe evironment.

What is this "flexibility"? It's very simple. **ONLY UPGRADE IN A DEVELOPMENT/NON-PRODUCTION ENVIRONMENT FIRST.**
What is this "flexibility"? It's very simple: **ONLY UPGRADE IN A DEVELOPMENT/NON-PRODUCTION ENVIRONMENT FIRST.**

Yes, the author purposefully put that in all caps with bold text to make a point. Seriously, who upgrades a production environment and breaks it because he didn't take the time to test out an upgrade in a development environment first. Your company's ERPNext installation is at the heart of its operations! Don't risk messing something up because you (as the administrator) didn't take the time to test out in a safe place where you have all the time in the world to figure out and fix before you upgrade production. Please read [3.2.2 Installation of a Side by Side Development Environment](install-dev.md "Installation of a Side by Side Development Environment") to get setup.

Expand All @@ -26,8 +26,6 @@ Assuming the development environment is the same version as production (or very
bench clear-website-cache
bench restart

**NOTE**: The use of the elipsis ( `...` ) is used to shorten the command. Clearly you will need to give a complete path for `bench restore`.

At this point, you should go into the development environment user interface and ensure it looks and operates like the current production site. Run trough a few tests to ensure everything is working ok. Don't just blindly assume that the copy down operation completed above actually worked!

Once you are comfortable that the copy down procedure worked, now it's time to upgrade development.
Expand Down Expand Up @@ -87,6 +85,7 @@ The steps to upgrade from a minor version to another is very similar to the proc
* Your production site will always be pretty close to the current code base.
* Security issues discovered in the frappe framework are keeping your business safe.
* Upgrades are less painful and require less troubleshooting as they often work much better than trying the major upgrade route.
* The changes to the software are smaller and so any re-training of your users will be easier.

To summarize the steps:

Expand Down
2 changes: 1 addition & 1 deletion introduction/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
There are a number of places to get help with your ERPNext installation.

* The first and obvious place to get help is the discuss forum at [https://discuss.erpnext.com/](https://discuss.erpnext.com/ "Discuss ERPNext"). Sign up and join the coversation!<br /><br />
* ERPNext is based on the Frappe Framework. There is a separate discuss form at [https://discuss.frappe.io/](https://discuss.frappe.io/ "Discuss Frappe Framework")<br /><br />
* ERPNext is based on the Frappe Framework. There is a separate discuss forum at [https://discuss.frappe.io/](https://discuss.frappe.io/ "Discuss Frappe Framework")<br /><br />
* There is an open gitter chat group that you can sign into at [https://gitter.im/frappe/erpnext](https://gitter.im/frappe/erpnext "Gitter.im Channel for ERPNext")<br /><br />
* There is the ERPNext GitHub repository at [https://github.com/frappe/erpnext](https://github.com/frappe/erpnext "ERPNext GitHub Repo"). This is where a person would enter in new issues and check out new releases. See [3.3 Upgrading](../i-u-b/upgrade.md "Upgrading ERPNext").<br /><br />
* As any good system, there is a user manual at [https://erpnext.org/docs/user/manual/](https://erpnext.org/docs/user/manual/ "ERPNext User Manual"). If you have not read it from front to back, you should. The English language version is the most complete.<br /><br />
Expand Down
2 changes: 1 addition & 1 deletion preface/foreward.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 1.1 Foreward

This book was originally created in October 2016 as I began to install and manage an ERPNext 7.0.x installation. The first thing that I noticed was a lack of good administration level technical knowledge for the care and feeding of the platform. The user manual had both technical and non-technical information in it and was confusing to users and technicians alike. This new manual was created out of a need to aggregate knowledge from the forums, wiki's, online manuals and other sources into a single place to aid me in managing my self-hosted installation. The Administrators Guide started out as a Libre Office Writer document mainatained by me. As I became more involved with the community and continued to see more and more requests to the forum for basic help I decided to turn the document into Markdown text and publish to the public.
This book was originally created in October 2016 as I began to install and manage an ERPNext 7.0.x installation. The first thing that I noticed was a lack of good administration level technical knowledge for the care and feeding of the platform. The user manual had both technical and non-technical information in it and was confusing to users and technicians alike. This manual was created out of a need to aggregate knowledge from the forums, wiki's, online manuals and other sources into a single place to aid me in managing my self-hosted installation for my small business. The Administrators Guide started out as a LibreOffice Writer document mainatained by me. As I became more involved with the ERPNext community and continued to see more and more requests to the forum for basic help I decided to turn the document into Markdown text and publish to the public her at GitHub.

<div style="text-align: right">James Robertson<br />November 2017</div><br /><br />

Expand Down
2 changes: 1 addition & 1 deletion preface/typography.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ When working inside of ERPNext, the Administrators guide will give a click path

> Explore > Setup > Users > User
In this example, the user clicks the Explore icon on the Desktop, navigates to the Setup module, looks for the Users header and clicks on the User document type.<br /><br />
In this example, the user clicks the Explore icon on the Desktop, navigates to the Setup module, looks for the Users header and clicks on the User document list.<br /><br />

Previous: [1.3 Prerequisites](prerequisites.md "Prerequisites") | Next: [2.1 Overview of ERPNext](../introduction/overview.md "Introduction")
2 changes: 1 addition & 1 deletion setup/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 4.1 The Setup Wizard

The Setup Wizard handles all of the initial setup steps on a brand new install. The current user's manual does a decent job explaining this at this time.
The Setup Wizard handles all of the initial setup steps on a brand new install. The current users manual does a decent job explaining this at this time.

[https://erpnext.org/docs/user/manual/en/setting-up/setup-wizard](https://erpnext.org/docs/user/manual/en/setting-up/setup-wizard)<br /><br />

Expand Down

0 comments on commit e722bbb

Please sign in to comment.