# NetBox Quick Start Installation Guide

### Deploy a NetBox Dev/Test Environment in 20 Minutes

To get [NetBox](https://netbox.readthedocs.io/en/stable/) up and running in the fastest possible way, follow this guide. This framework will allow you to install, backup, remove, upgrade, customize, and deploy NetBox plugins, all in minutes.

<p class="callout info">The blue info boxes flag **What You've Missed**, which are stages you should consider in a production, or in "more than just a NetBox lab" environment.</p>

### 5 Minute Demo

<iframe allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen="allowfullscreen" class=" align-center" frameborder="0" height="450" src="https://www.youtube.com/embed/-08l3LOLX-o?si=5Hrtzfw15N1Xubas" title="YouTube video player" width="800"></iframe>

### Installation Guide

#### 1. Install Ubuntu Server

You're going to need to get a server with **Ubuntu 24.04 LTS** up and running. [Download an image](https://ubuntu.com/download/server) like `ubuntu-24.04-live-server-amd64.iso` or spin up an instance on your favorite cloud provider, like AWS.

#### 2. Install Semaphore and the Netos NetOps Project

You can follow the full [Install Semaphore Guide](https://docs.netos.io/books/semaphore-netops/page/deploy-semaphore-netos-projects), however, in summary, once you install Ubuntu, paste this command to pull the repo and run the install script, and you shouldn't need to do anything else:

`sudo wget https://raw.githubusercontent.com/netos-networks/netos-netops/refs/heads/main/easy-deploy.sh && sudo chmod +x easy-deploy.sh && sudo ./easy-deploy.sh`

[![image.png](https://docs.netos.io/uploads/images/gallery/2024-09/scaled-1680-/wjPnxkbt4Z0ogrTF-image.png)](https://docs.netos.io/uploads/images/gallery/2024-09/wjPnxkbt4Z0ogrTF-image.png)

<p class="callout info">The [Key Semaphore Principles](https://docs.netos.io/books/semaphore-netops/page/key-semaphore-principles) guide explains more about Semaphore.</p>

<p class="callout warning">Check the [Users, Accounts, and Tokens](https://docs.netos.io/books/semaphore-netops/page/users-accounts-tokens) guide for more information about credentials and variables.</p>

#### 3. Configure Semaphore

These steps are optional, so you can skip this for now.

<p class="callout info">Change the `DOMAIN` and `SEMAPHORE_HOSTNAME` variables in the **NetBox Global Settings** Semaphore environment. Follow the [Deploying NGINX &amp; Certificates](https://docs.netos.io/books/semaphore-netops/page/deploying-nginx-certificates) guide.</p>

<p class="callout info">Deploy self-signed certificates, so you don't get "<span style="color: rgb(224, 62, 45);">your connection isn't private</span>" browser warnings. Follow the [Deploying NGINX &amp; Certificates](https://docs.netos.io/books/semaphore-netops/page/deploying-nginx-certificates) guide.</p>

<p class="callout info">Enable [Semaphore Backups](https://docs.netos.io/books/semaphore-netops/page/semaphore-backup-guide).</p>

#### 4. Deploy NGINX and Self-Signed Cert for NetBox

You need to deploy NGINX to connect to NetBox. To fast track, you can just create a self-signed certificate. The default hostname will be `netbox.netos.dev`.

[![image.png](https://docs.netos.io/uploads/images/gallery/2024-09/scaled-1680-/UZ5mahAPnD3cl951-image.png)](https://docs.netos.io/uploads/images/gallery/2024-09/UZ5mahAPnD3cl951-image.png)

<p class="callout info">Change the `DOMAIN` and `NETBOX_HOSTNAME` variables in the **NetBox Global Settings** Semaphore environment. Follow the [Deploying NGINX &amp; Certificates](https://docs.netos.io/books/semaphore-netops/page/deploying-nginx-certificates) guide.</p>

<p class="callout info">Deploy self-signed certificates, so you don't get "<span style="color: rgb(224, 62, 45);">Your connection isn't private</span>" browser warnings. Follow the [Deploying NGINX &amp; Certificates](https://docs.netos.io/books/semaphore-netops/page/deploying-nginx-certificates) guide.</p>

#### 5. Install NetBox

Browse to the **NETBOX DEPLOY** view in Semaphore to start the installation. The full [NetBox Installation Guide](https://docs.netos.io/books/semaphore-netbox/page/install-netbox) is here.

[![image.png](https://docs.netos.io/uploads/images/gallery/2024-09/scaled-1680-/gkzWMYios59nJyix-image.png)](https://docs.netos.io/uploads/images/gallery/2024-09/gkzWMYios59nJyix-image.png)

If you want to install a specific version, set it here, matching the numeric version from [Releases · netbox-community/netbox (github.com)](https://github.com/netbox-community/netbox/releases). Don't add the `v`, i.e. `v4.1.2` would be `4.1.2`.

[![image.png](https://docs.netos.io/uploads/images/gallery/2024-09/scaled-1680-/fIACUdKPF7wErapl-image.png)](https://docs.netos.io/uploads/images/gallery/2024-09/fIACUdKPF7wErapl-image.png)

<p class="callout info">Configure scheduled daily [NetBox ](https://docs.netos.io/books/semaphore-netbox/page/netbox-backup-guide)Backups or set your own custom frequency.</p>

<p class="callout info">[Upgrade NetBox](https://docs.netos.io/books/semaphore-netbox/page/upgrade-netbox). For example, maybe you've used the [Restore](https://docs.netos.io/books/semaphore-netbox/page/netbox-restoration-guide) process to restore to an older version and want to upgrade to a newer version.</p>

<p class="callout info">Enable the [NetBox Maintenance Playbook](https://docs.netos.io/books/semaphore-netbox/page/netbox-health-checks-maintenance) on a daily schedule as per the developer's guidance.</p>

#### 6. Connect to NetBox

Once the playbook is complete, you should be able to connect using HTTPS and the IP address to NetBox. Check the [Users, Accounts, and Tokens](https://docs.netos.io/books/semaphore-netops/page/users-accounts-tokens) guide for full details on account and passwords. The default credentials are as follows:

- **Username**: `admin`
- **Password**: `ohp8toef7Jee`

[![image.png](https://docs.netos.io/uploads/images/gallery/2024-09/scaled-1680-/K1H1uubECrlQwMCS-image.png)](https://docs.netos.io/uploads/images/gallery/2024-09/K1H1uubECrlQwMCS-image.png)

<p class="callout info">If you experience any problems, you can run the [Health Check Playbook](https://docs.netos.io/books/semaphore-netbox/page/netbox-health-checks-maintenance) to quickly diagnose common issues. For example, check the logs to catch the reason why NetBox failed to start.</p>

#### 7. Install NetBox Plugins

You can [Install and Upgrade](https://docs.netos.io/books/semaphore-netbox/page/deploy-netbox-community-plugins) popular NetBox plugins from within Semaphore, and also [Disable NetBox Plugins](https://docs.netos.io/books/semaphore-netbox/page/disable-netbox-community-plugins). This feature is a work-in-progress, and probably will be for a while...!

[![image.png](https://docs.netos.io/uploads/images/gallery/2024-09/scaled-1680-/cZ0FC3AH3LYr2m9U-image.png)](https://docs.netos.io/uploads/images/gallery/2024-09/cZ0FC3AH3LYr2m9U-image.png)

<p class="callout success">If things go wrong in your test environment, you can quickly [Wipe NetBox](https://docs.netos.io/books/semaphore-netbox/page/remove-netbox) and start again.</p>