Merge pull request #30 from jwrober/2017-11-30-reporting

2017.12.12 Update

i-u-b/backup.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting") | Next: [3.5 Restoring from a Previous Backup](restore "Restoring from a Previous Backup") 
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting") | Next: [3.5 Restoring from a Previous Backup](restore "Restoring from a Previous Backup") 
 
 ## 3.4 Backing Up ERPNext
 
@@ -31,4 +31,4 @@ There is another level of backup that is not really discussed in the [Discussion
 
 This will create a `tar.bz2` file in the `/home/erpnext/` directory. You can then follow the steps in [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version") to get back to a known good state.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting") | Next: [3.5 Restoring from a Previous Backup](restore "Restoring from a Previous Backup")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting") | Next: [3.5 Restoring from a Previous Backup](restore "Restoring from a Previous Backup")

i-u-b/bench.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [2.2 Getting Help](../introduction/help "Getting Help") | Next: [3.1.3 Wonderful World of git](git "The Wonderful World of git") 
+Home: [Table of Contents](../ "Table of Contents") | Previous: [2.2 Getting Help](../introduction/help "Getting Help") | Next: [3.1.3 Wonderful World of git](git "The Wonderful World of git") 
 
 # 3.0 ERPNext Installation, Upgrades and Backups
 
@@ -54,4 +54,4 @@ 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 that is a good start.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [2.2 Getting Help](../introduction/help "Getting Help") | Next: [3.1.3 Wonderful World of git](git "The Wonderful World of git")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [2.2 Getting Help](../introduction/help "Getting Help") | Next: [3.1.3 Wonderful World of git](git "The Wonderful World of git")

i-u-b/git.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3 Frappe Bench](bench "Frappe Bench") | Next: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx") 
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3 Frappe Bench](bench "Frappe Bench") | Next: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx") 
 
 ### 3.1.3 The Wonderful World of git
 
@@ -12,4 +12,4 @@ Here are some places to go gain some knowledge on `git`:
 * There is a good cheat sheet at [git-tower](https://www.git-tower.com/blog/git-cheat-sheet "Git Cheat Sheet")<br /><br />
 * There is the official documentation at [git-scm](https://git-scm.com/docs "Git SCM Documentation")<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3 Frappe Bench](bench "Frappe Bench") | Next: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3 Frappe Bench](bench "Frappe Bench") | Next: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx")

i-u-b/install-dev.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting") | Next: [3.3 Upgrading ERPNext](upgrade "Upgrading ERPNext") 
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting") | Next: [3.3 Upgrading ERPNext](upgrade "Upgrading ERPNext") 
 
 ### 3.2.2 Installation of a Side by Side Development Environment
 
@@ -42,4 +42,4 @@ Now remove `sudoer` rights from the `erpnext` user to move back to a run-time co
 
 Most administrators will now take a [simple backup](backup#Simple "Backing up ERPNext") of the production site and then [restore](restore "Restoring from a Previous Backup") to the stage site. You will have a carbon copy of your production database in a stage environment that you can use for testing.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting") | Next: [3.3 Upgrading ERPNext](upgrade "Upgrading ERPNext")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting") | Next: [3.3 Upgrading ERPNext](upgrade "Upgrading ERPNext")

i-u-b/install-trouble.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.2 Installing ERPNext](install "Installing ERPNext") | Next: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") 
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.2 Installing ERPNext](install "Installing ERPNext") | Next: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") 
 
 ### 3.2.1 Installation Troubleshooting
 
@@ -29,6 +29,12 @@ Confirm by running
 
     sudo netstat -tulpn | grep nginx
 
-and see if the server is running.<br /><br />
+and see if the server is running.
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.2 Installing ERPNext](install "Installing ERPNext") | Next: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") 
+Another thing that can cause `nginx` to not run is that the `bench` that ERPNext is installed in has not been setup for production mode. With the `erpnext` as a member of the `sudo` group, run this command:
+
+    sudo bench setup production --yes erpnext
+
+You should now see `nginx` running.<br /><br />
+
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.2 Installing ERPNext](install "Installing ERPNext") | Next: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") 

i-u-b/install.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: Next: [3.1.5 Software Packages Installed](software "Software Packages Installed") | Next: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting")
+Home: [Table of Contents](../ "Table of Contents") | Previous: Next: [3.1.5 Software Packages Installed](software "Software Packages Installed") | Next: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting")
 
 ## 3.2 Installing ERPNext
 
@@ -206,4 +206,4 @@ If any of the above items are not running, then you will need to troubleshoot th
 su
 At this point the `erpnext` user should be an non-sudoer user and you will have an empty production environment running. Next step is to run the [Setup Wizard](../setup/setup "Setup").<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: Next: [3.1.5 Software Packages Installed](software "Software Packages Installed") | Next: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting")
+Home: [Table of Contents](../ "Table of Contents") | Previous: Next: [3.1.5 Software Packages Installed](software "Software Packages Installed") | Next: [3.2.1 Installation Troubleshooting](install-trouble "Installation Troubleshooting")

i-u-b/nginx.md

@@ -1,9 +1,9 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.1.3 Wonderful World of git](git "The Wonderful World of git") | Next: [3.1.5 Software Packages Installed](software "Software Packages Installed")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.1.3 Wonderful World of git](git "The Wonderful World of git") | Next: [3.1.5 Software Packages Installed](software "Software Packages Installed")
 
 ### 3.1.4 The Wonderful World of nginx
 
 `nginx` is a web server, similar to the popular Apache `httpd` web server. This piece of software is critical to the proper functioning of an ERPNext installation. Ensuring that the configuration of the web server is correct ensures that your installation will work properly and also stays secure, especially if your installation is exposed to the open Internet.
 
 The best place to learn about nginx is on the [nginx.org](http://nginx.org/en/docs/ "nginx Documentation") website. At a minimum, an administrator should read the Beginner's Guide and the Admin's Guide.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.1.3 Wonderful World of git](git "The Wonderful World of git") | Next: [3.1.5 Software Packages Installed](software "Software Packages Installed")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.1.3 Wonderful World of git](git "The Wonderful World of git") | Next: [3.1.5 Software Packages Installed](software "Software Packages Installed")

i-u-b/restore.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext") | Next: [4 Setup](../setup/setup "Setup")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext") | Next: [4 Setup](../setup/setup "Setup")
 
 ## 3.5 Restoring from a Previous Backup
 
@@ -13,4 +13,4 @@ Assuming you have a good [simple backup](backup#Simple "Backing Up ERPNext"), yo
 
 This should bring your system's database and files configuration back to the point in time the backup was taken.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext") | Next: [4 Setup](../setup/setup "Setup")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext") | Next: [4 Setup](../setup/setup "Setup")

i-u-b/revert.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous [3.2 Upgrading ERPNext](upgrade "Upgrading ERPNext") | Next: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting")
+Home: [Table of Contents](../ "Table of Contents") | Previous [3.2 Upgrading ERPNext](upgrade "Upgrading ERPNext") | Next: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting")
 
 ### 3.3.3 Reverting to an Older Version
 
@@ -22,4 +22,4 @@ Assuming the steps to take a **full backup** were completed from [3.4 Backing up
 
 Following these commands will essentially wipe the old version completely and restore what was taken in the full backup to production.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous [3.2 Upgrading ERPNext](upgrade "Upgrading ERPNext") | Next: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting")
+Home: [Table of Contents](../ "Table of Contents") | Previous [3.2 Upgrading ERPNext](upgrade "Upgrading ERPNext") | Next: [3.3.4 Upgrade Troubleshooting](upgrade-trouble "Upgrade Troubleshooting")

i-u-b/software.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx") | Next: [3.2 Installing ERPNext](install "Installing ERPNext")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx") | Next: [3.2 Installing ERPNext](install "Installing ERPNext")
 
 ### 3.1.5 Software Packages Installed
 
@@ -98,4 +98,4 @@ Here is the listing for MacOS:
 * brew
 * cmake<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx") | Next: [3.2 Installing ERPNext](install "Installing ERPNext")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.1.4 Wonderful World of nginx](nginx "The Wonderful World of nginx") | Next: [3.2 Installing ERPNext](install "Installing ERPNext")

i-u-b/upgrade-trouble.md

@@ -1,7 +1,14 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version") | Next: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version") | Next: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext")
 
 ### 3.3.4 Upgrade Troubleshooting
 
-TO BE WRITTEN<br /><br />
+There are a number of things that can go wrong during an upgrade. The best thing to do is to ensure that you did indeed take a good [simple](backup#Simple) and [full](backup#Full) backup of the environment before you started. Second thing to do is capture the `python` stack trace in its entirety and open a new topic on the [discussion forum](https://discuss.erpnext.com/c/bench). The more specific you are in the forum topic the better support you will get from the community.  Things that should be mentioned in the post:
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version") | Next: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext")
+* Current version of ERPNext and Frappe Framework
+* Version of each attempting to upgrade to (don't just say current, explicitly state the version number)
+* Operating system environment and version
+* List of any custom apps installed, including your own
+
+These things will help the community to better understand your issue. You might have discovered a defect in the software and so a [github issue](https://github.com/frappe/erpnext/issues) will need to be opened. This is why the admin guide stresses the importance of upgrading in a non-production environment first. That way your users will not be impacted by a delay to figure out an issue with an upgrade. Especially if there is a defect, you will have to wait to get it fixed (or fix it yourself and post a pull request) and then wait for a release to master branch to occur to try again.<br /><br /><br /><br />
+
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version") | Next: [3.4 Backing Up ERPNext](backup "Backing Up ERPNext")

i-u-b/upgrade.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") | Next: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") | Next: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version")
 
 ## 3.3 Upgrading ERPNext
 
@@ -88,4 +88,4 @@ To summarize the steps:
 1. Run `bench clear-cache`, `bench clear-website-cache`, and `bench restart` to get production ready
 1. Get some coffee!<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") | Next: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [3.2.2 Installing Development Side by Side](install-dev "Installation of a Side by Side Development Environment") | Next: [3.3.3 Reverting to an Older Version](revert "Reverting to an Older Version")

introduction/help.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [2.1 Overview](overview "Overview of ERPNext") | Next [3.1 Frappe Bench](../i-u-b/bench "Frappe Bench")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [2.1 Overview](overview "Overview of ERPNext") | Next [3.1 Frappe Bench](../i-u-b/bench "Frappe Bench")
 
 ## 2.2 Getting Help
 
@@ -16,4 +16,4 @@ There are a number of places to get help with your ERPNext installation.
 
 * There are a number of helpful videos that the ERPNext team has created at [https://erpnext.org/docs/user/videos/learn/](https://erpnext.org/docs/user/videos/learn/ "ERPNext Video Tutorials").<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [2.1 Overview](overview "Overview of ERPNext") | Next [3.1 Frappe Bench](../i-u-b/bench "Frappe Bench")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [2.1 Overview](overview "Overview of ERPNext") | Next [3.1 Frappe Bench](../i-u-b/bench "Frappe Bench")

introduction/overview.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [1.4 Typography](../preface/typography "Typography") | Next: [2.2 Getting Help](help "Getting Help") 
+Home: [Table of Contents](../ "Table of Contents") | Previous: [1.4 Typography](../preface/typography "Typography") | Next: [2.2 Getting Help](help "Getting Help") 
 
 # 2.0 Introduction
 
@@ -14,4 +14,4 @@ From the ERPNext Documentation website at [https://erpnext.org/docs](https://erp
 
 > ERPNext is Open Source under the GNU General Public License v3 and has been listed as one of the Best Open Source Softwares in the world by many online blogs.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [1.4 Typography](../preface/typography "Typography") | Next: [2.2 Getting Help](help "Getting Help")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [1.4 Typography](../preface/typography "Typography") | Next: [2.2 Getting Help](help "Getting Help")

preface/audience.md

@@ -1,7 +1,7 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [1.1 Foreward](foreward "Foreward") | Next: [1.3 Prerequisites](prerequisites "Prerequisites")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [1.1 Foreward](foreward "Foreward") | Next: [1.3 Prerequisites](prerequisites "Prerequisites")
 
 ## 1.2 Audience
 
 This book targets technical resources who will be expected to install, manage, customize (tailor) and generally administrate [ERPNext]("https://erpnext.org" "ERPNext Website"). This is not a user manual for non-technical people, this is a technical manual for technicians.<br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [1.1 Foreward](foreward "Foreward") | Next: [1.3 Prerequisites](prerequisites "Prerequisites")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [1.1 Foreward](foreward "Foreward") | Next: [1.3 Prerequisites](prerequisites "Prerequisites")

preface/foreward.md

@@ -1,4 +1,4 @@
-Home: [Table of Contents](../README "Table of Contents") | Previous: [Readme / Index](../README "Readme / Index") | Next: [1.2 Audience](audience "Audience") 
+Home: [Table of Contents](../ "Table of Contents") | Previous: [Readme / Index](../README "Readme / Index") | Next: [1.2 Audience](audience "Audience") 
 
 # 1.0 Preface
 
@@ -8,4 +8,4 @@ This book was originally created in October 2016 as I began to install and manag
 
 <div style="text-align: right">James Robertson<br />November 2017</div><br /><br />
 
-Home: [Table of Contents](../README "Table of Contents") | Previous: [Readme / Index](../README "Readme / Index") | Next: [1.2 Audience](audience "Audience")
+Home: [Table of Contents](../ "Table of Contents") | Previous: [Readme / Index](../README "Readme / Index") | Next: [1.2 Audience](audience "Audience")