Netbox Update issue in the "Building documentation (mkdocs build)..." part #12101
Replies: 1 comment 3 replies
-
Why can you not just put the secret key inline in the config file? If you want to drive configuration.py from environment variables, then I suggest you copy how netbox-docker does it. In particular, for mkdocs and collectstatic you can see in the Dockerfile that they pass a dummy value for SECRET_KEY explicitly, probably to work around the exact problem you're seeing. Therefore, I suspect you may have to do something similar for your GROUP_MAPPINGS. Even if mkdocs doesn't use the value, there's still a bunch of python library setup which will be done. |
Beta Was this translation helpful? Give feedback.
-
Because the secret_key must be kept secret. Django don't recommend to expose its value. And if we put in the configuration.py it will be in the company github repo.
Great ideia! But how I will change the secret_key after the installation? |
Beta Was this translation helpful? Give feedback.
-
Putting it in the config file is not "exposing" it: that is where it is supposed to go. You can of course set the config file so it's only readable by the netbox user, in case you have other shell users on the same system. Putting it in an environment variable exposes it far more! It's visible to all users on the system, by looking at
By editing the file - but this is not something you should need to do on a regular basis. The Similar argument applies for GROUP_MAPPINGS: put it in the configuration file. It's not something you'll have to edit very often, but if you do, you will have to restart Netbox anyway. |
Beta Was this translation helpful? Give feedback.
-
It will be exposed because our configuration.py file is in our github repo, and our .env file is in our machine that only few people have access (the repo a lot of people can see). So is not an option to put the value in the configuration.py file.
Which file? just editing the .env would be enough? The Django will get the new value? Even if it was installed with a dummy one?
|
Beta Was this translation helpful? Give feedback.
-
Hello there!
I'm updating Netbox from 3.1.11 to 3.3.10 and I'm having some issues with the mkdocs build part. It seems that it can't get some of my env vars (but when I print them, they are there). And this problem happens in two points:
In my configuration.py file I have:
SECRET_KEY = os.environ.get('SECRET_KEY')But when I run the upgrade, I have this error:
This GROUP_MAPPINGS needs a dict, but I get this value from a env var, which should be a string. So I have to map this value (I was using a method to do this, but was having errors, so I changed to use a json.loads() so I saved my dict inside a string to them parse it, but I had the same errors as well. The error is as below:
We can see a pettern here, it seems that its not being able to get the env var (but when I print the vars in my configuration.py and in my settings.py files, the values are there).
I tried to put mkdocstrings[python]>=0.20.0 into my local_requirements.txt file, but I had the exactly same issue from this person: https://stackoverflow.com/questions/75803054/documentation-build-issues-during-upgrade-netbox
I have found this that maybe can lead to something: https://stackoverflow.com/questions/68516144/mkdocs-with-mkdocstrings-fails-to-serve-with-could-not-collect-error
What can I do to solve this? Thanks!
My local_requirements.txt is like this:
Beta Was this translation helpful? Give feedback.
All reactions