Skip to content

Commit

Permalink
16349 add warning to custom script docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@arthanson @jeremystretch
arthanson authored and jeremystretch committed Sep 5, 2024
1 parent 684cdda commit ed1b8bc
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/customization/custom-scripts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ They can also be used as a mechanism for validating the integrity of data within

Custom scripts are Python code which exists outside the NetBox code base, so they can be updated and changed without interfering with the core NetBox installation. And because they're completely custom, there is no inherent limitation on what a script can accomplish.

!!! danger "Only install trusted scripts"
Custom scripts have unrestricted access to change anything in the databse and are inherently unsafe and should only be installed and run from trusted sources. You should also review and set permissions for who can run scripts if the script can modify any data.

## Writing Custom Scripts

All custom scripts must inherit from the `extras.scripts.Script` base class. This class provides the functionality necessary to generate forms and log activity.
Expand Down

0 comments on commit ed1b8bc

Please sign in to comment.