inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-12 10:15:33 +00:00
Code Activity

Adds framework for documentation of user and global settings

Browse Source
This commit is contained in:
Oliver
2021-10-18 22:12:15 +11:00
parent 48d2a11318
commit 0d1e4fdf04
25 changed files with 140 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/settings/shell.md Normal file
View File

@ -0,0 +1,24 @@
---
title: Admin Shell
---
## Python Shell
A Python shell interface is provided at the URL `/admin/shell/`.
This interface allows advanced users direct access to the underlying database objects using Python.
!!! warning "Danger"
The scripting shell interface should only ever be used by advanced users. It requires intimate knowledge of the underlying InvenTree code, and improper use could easily result in corruption of data
!!! warning "Seriously"
If you are not 100% sure of what you are doing, do not use the shell interface
!!! info "Enabling Shell Mode"
The admin shell is (by default) only enabled when InvenTree is running in DEBUG mode
The shell interface allows Python queries to be run by the admin user, as shown below:
{% with id="admin_shell", url="admin/shell.png", description="Admin shell interface" %}
{% include 'img.html' %}
{% endwith %}