Plugin requiring its own collectstatic

[dmcken]

Good Day,

I'm attempting to use nextbox-ui-plugin (https://github.com/iDebugAll/nextbox-ui-plugin).

I'm having issues with running collectstatic for this plugin (currently I'm getting 404s to /static/nextbox_ui_plugin/next_app.js and anything else in the /static/nextbox_ui_plugin/ folder). Looking into the container I found the netbox_ui_plugin folder wasn't there.

As such I altered the Dockerfile-Plugins as follows to collect the files after installing the extra packages:

FROM netboxcommunity/netbox:latest

copy ./plugin_requirements.txt /
RUN /opt/netbox/venv/bin/pip install  --no-warn-script-location -r /plugin_requirements.txt
WORKDIR /opt/netbox/netbox
RUN SECRET_KEY="dummy" /opt/netbox/venv/bin/python manage.py collectstatic --no-input
#RUN  mkdir -p static/nextbox_ui_plugin/ && SECRET_KEY="dummy" /opt/netbox/venv/bin/python manage.py collectstatic --no-input

The output of the 'docker-compose build --no-cache' is as follows:

Step 4/5 : WORKDIR /opt/netbox/netbox
 ---> Running in 86e58aa17c05
Removing intermediate container 86e58aa17c05
 ---> 4af380ef6db6
Step 5/5 : RUN SECRET_KEY="dummy" /opt/netbox/venv/bin/python manage.py collectstatic --no-input
 ---> Running in a1d7f4243c65
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/extra.py'

0 static files copied to '/opt/netbox/netbox/static', 961 unmodified.
Removing intermediate container a1d7f4243c65
 ---> 0d88909a2d51

Successfully built 0d88909a2d51
Successfully tagged netbox:latest-plugins

No updates are being made so somehow its not picking up on the extra plugins to be added to the static files.

If I docker exec -it /bin/bash in and attempt to do it manually I get permission errors:

~/netbox-docker$ docker exec -it 9543e1d02d45 /bin/bash
bash-5.1$ cd /opt/netbox/netbox/
bash-5.1$ source /opt/netbox/venv/bin/activate
(venv) bash-5.1$ python3 manage.py collectstatic --no-input
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/extra.py'
Traceback (most recent call last):
  File "manage.py", line 10, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/__init__.py", line 401, in execute_from_command_line
    utility.execute()
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/__init__.py", line 395, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/base.py", line 330, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/base.py", line 371, in execute
    output = self.handle(*args, **options)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py", line 194, in handle
    collected = self.collect()
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py", line 118, in collect
    handler(path, prefixed_path, storage)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py", line 355, in copy_file
    self.storage.save(prefixed_path, source_file)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/files/storage.py", line 52, in save
    return self._save(name, content)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/files/storage.py", line 267, in _save
    fd = os.open(full_path, self.OS_OPEN_FLAGS, 0o666)
PermissionError: [Errno 13] Permission denied: '/opt/netbox/netbox/static/nextbox_ui_plugin/bootstrap.min.css'
(venv) bash-5.1$

Is there something obvious I'm doing wrong? Either way any plugins that require collect static files I would guess don't work with this project (if I do a "collectstatic --clear" it fails as well for the same permission issues so I can't really say a plugin that does not have it's files in a separate folder would work either).

[tobiasge]

Hello,
I converted this to a discussion. I don't think this is an actual bug.

What is happening is this: When you run collectstatic in your Dockerfile the plugin is not loaded because you didn't include a config file that does just that.

Add the following line to your Dockerfile before the collectstatic line:

COPY configuration/load_plugin.py /etc/netbox/config/load_plugin.py

The file configuration/load_plugin.py should contain the plugin configuration:

PLUGINS = ['nextbox_ui_plugin']

PLUGINS_CONFIG = {
    'nextbox_ui_plugin': {
         # The settings you want
    }
}

[dmcken]

No problem, wasn't sure where made sense.

So that worked, I had the PLUGIN section filled in the general configuration/configuration.py so I tried just re-copying it and it worked.

So the final Dockerfile-Plugins looks like this:

FROM netboxcommunity/netbox:latest

COPY ./plugin_requirements.txt /
RUN /opt/netbox/venv/bin/pip install  --no-warn-script-location -r /plugin_requirements.txt
COPY configuration/configuration.py /etc/netbox/config/configuration.py
RUN SECRET_KEY="dummy" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input

Is there anything that would stop this from working in the general case? I would like to get https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins updated to include the extra two lines to the "Custom Docker File" section.