The following are the basic principles this project is trying to achieve.
They may change of time as we learn.
Plug And Play
After cloning the project for the first time, a docker-compose up should all be needed to get to a running Netbox instance.
Optimized for Local, but Production-ready
The main focus of this project is to enable quick local use.
I.e. people who want to explore Netbox, who develop scripts for Netbox or develop on Netbox.
But it should be possible to configure the image to be used in production.
A word on Security
We should try to provide all the tools for secure operations of this Docker Image.
But our main goal is first and foremost a Plug And Play experience.
Therefore not every security feature can be enabled out-of-the-box.
Where it is not possible to enable security out-of-the-box, we try to describe and advocate these features in the wiki.
Extensibility
We try to keep extensibility in mind. It should be possible to add additional behavior to the project.
Upgrade Path
When Netbox offers and upgrade path, we should aim to do that as well.
Manual actions are good enough though, but they have to be added to the Release Notes.
Documentation
The wiki should be used for user guides, FAQs and project documentation.
Reasoning
We try to provide reasoning for our decisions in the project through (comments on) issues, PRs or by using the wiki.
Be nice
Try to be nice in issues. This goes out to user and maintainers likewise. Always assume the best intentions.