diff --git a/Deployment.md b/Deployment.md index 431ca4f..3c68173 100644 --- a/Deployment.md +++ b/Deployment.md @@ -1,9 +1,9 @@ -**Important: Also consider [the advice about configuring Netbox for production](configuration#configure-for-production)!** +**Important: Also consider [the advice about configuring NetBox for production](configuration#configure-for-production)!** If run this image in a cluster such as Docker Swarm, Kubernetes or OpenShift, the following will come in extra handy for you. But these techniques work equally well in the regular _docker-compose_-based approach. -In this case, we encourage you to statically configure Netbox by starting from [Netbox's example config file][default-config], and mounting it into your container in the directory `/etc/netbox/config/` using the mechanism provided by your container platform (i.e. [Docker Swarm configs][swarm-config], [Kubernetes ConfigMap][k8s-config], [OpenShift ConfigMaps][openshift-config]). +In this case, we encourage you to statically configure NetBox by starting from [NetBox's example config file][default-config], and mounting it into your container in the directory `/etc/netbox/config/` using the mechanism provided by your container platform (i.e. [Docker Swarm configs][swarm-config], [Kubernetes ConfigMap][k8s-config], [OpenShift ConfigMaps][openshift-config]). But if you rather continue to configure your application through environment variables, you may continue to use [the built-in configuration file][docker-config]. **We discourage storing secrets in environment variables**, as environment variable are passed on to all sub-processes and may leak easily into other systems, e.g. error collecting tools that often collect all environment variables whenever an error occurs. @@ -34,7 +34,7 @@ If a secret is defined by an environment variable and in the respective file at ## _docker-compose_-based Deployments -If you are about to deploy Netbox using this project's Docker image and _docker-compose_ file on a more permanent basis here you'll find some hints from our community. +If you are about to deploy NetBox using this project's Docker image and _docker-compose_ file on a more permanent basis here you'll find some hints from our community. **Please make sure you also read the [_Configure for Production_ section of the _Configuration_ wiki page](Configuration#configure-for-production). You need to change the passwords and other secrets!** ### Restart Policy @@ -72,7 +72,7 @@ Learn more on [the dedicated _TLS_ wiki page](https://github.com/netbox-communit * [Helm Chart][netbox-helm] by @bootc * [Kubernetes objects][netbox-kubernetes] by @CENGN -See also the [Community Contributions wiki page](etbox-community/netbox/wiki/Community-Contributions) of the Netbox project. +See also the [Community Contributions wiki page](netbox-community/netbox/wiki/Community-Contributions) of the NetBox project. [netbox-kubernetes]: https://github.com/CENGN/netbox-kubernetes [netbox-helm]: https://github.com/bootc/netbox-chart \ No newline at end of file