diff --git a/docs/index.rst b/docs/index.rst index 5e658b8b59..b5547c2520 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ InvenTree Source Documentation Configuration Deployment Migrate Data + Update InvenTree Backup and Restore Modal Forms Tables diff --git a/docs/update.rst b/docs/update.rst new file mode 100644 index 0000000000..d6ef6a5913 --- /dev/null +++ b/docs/update.rst @@ -0,0 +1,37 @@ +Update InvenTree +================ + +.. toctree:: + :titlesonly: + :maxdepth: 2 + :caption: Update + :hidden: + +Adminitrators wishing to update InvenTree to the latest version should follow the instructions below. The commands listed below should be run from the InvenTree root directory. + +.. important:: + It is advisable to backup the InvenTree database before performing these steps. + +Stop Server +----------- + +Stop the InvenTree server (e.g. gunicorn) + +Update Source +------------- + +Update the InvenTree source code to the latest version. + +``git pull origin master`` + +Perform Migrations +------------------ + +Updating the database is as simple as calling the makefile target: + +``make migrate`` + +Restart Server +-------------- + +Restart the InvenTree server \ No newline at end of file