mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
|
# Removing a Plugin
|
||
|
|
|
||
|
|
!!! warning
|
||
|
|
The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modifications to the steps below. Always consult the documentation for a specific plugin **before** attempting to remove it.
|
||
|
|
|
||
|
|
## Disable the Plugin
|
||
|
|
|
||
|
|
Disable the plugin by removing it from the `PLUGINS` list in `configuration.py`.
|
||
|
|
|
||
|
|
## Remove its Configuration
|
||
|
|
|
||
|
|
Delete the plugin's entry (if any) in the `PLUGINS_CONFIG` dictionary in `configuration.py`.
|
||
|
|
|
||
|
|
!!! tip
|
||
|
|
If there's a chance you may reinstall the plugin, consider commenting out any configuration parameters instead of deleting them.
|
||
|
|
|
||
|
|
## Re-index Search Entries
|
||
|
|
|
||
|
|
Run the `reindex` management command to reindex the global search engine. This will remove any stale entries pertaining to objects provided by the plugin.
|
||
|
|
|
||
|
|
```no-highlight
|
||
|
|
$ cd /opt/netbox/netbox/
|
||
|
|
$ source /opt/netbox/venv/bin/activate
|
||
|
|
(venv) $ python3 manage.py reindex
|
||
|
|
```
|
||
|
|
|
||
|
|
## Uninstall its Python Package
|
||
|
|
|
||
|
|
Use `pip` to remove the installed plugin:
|
||
|
|
|
||
|
|
```no-highlight
|
||
|
|
$ source /opt/netbox/venv/bin/activate
|
||
|
|
(venv) $ pip uninstall <package>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Restart WSGI Service
|
||
|
|
|
||
|
|
Restart the WSGI service:
|
||
|
|
|
||
|
|
```no-highlight
|
||
|
|
# sudo systemctl restart netbox
|
||
|
|
```
|
||
|
|
|
||
|
|
## Drop Database Tables
|
||
|
|
|
||
|
|
!!! note
|
||
|
|
This step is necessary only for plugins which have created one or more database tables (generally through the introduction of new models). Check your plugin's documentation if unsure.
|
||
|
|
|
||
|
|
Enter the PostgreSQL database shell (`manage.py dbshell`) to determine if the plugin has created any SQL tables. Substitute `pluginname` in the example below for the name of the plugin being removed. (You can also run the `\dt` command without a pattern to list _all_ tables.)
|
||
|
|
|
||
|
|
```no-highlight
|
||
|
|
netbox=> \dt pluginname_*
|
||
|
|
List of relations
|
||
|
|
List of relations
|
||
|
|
Schema | Name | Type | Owner
|
||
|
|
--------+----------------+-------+--------
|
||
|
|
public | pluginname_foo | table | netbox
|
||
|
|
public | pluginname_bar | table | netbox
|
||
|
|
(2 rows)
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! warning
|
||
|
|
Exercise extreme caution when removing tables. Users are strongly encouraged to perform a backup of their database immediately before taking these actions.
|
||
|
|
|
||
|
|
Drop each of the listed tables to remove it from the database:
|
||
|
|
|
||
|
|
```no-highlight
|
||
|
|
netbox=> DROP TABLE pluginname_foo;
|
||
|
|
DROP TABLE
|
||
|
|
netbox=> DROP TABLE pluginname_bar;
|
||
|
|
DROP TABLE
|
||
|
|
```
|