Skip to content

readme new user updates #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jabelk wants to merge 2 commits into
base: main
Choose a base branch
from
Open

readme new user updates #95

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d82b401
readme new user updates
jabelk Nov 27, 2024
052b584
rewrite section super user
jabelk Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ The reason it was chosen over Makefile was due to our collective familiarity wit

This repo is designed to provide a custom build of Nautobot to include a set of plugins which can then be used in a development environment or deployed in production. Included in this repo is a skeleton Nautobot plugin which is designed only to provide a quick example of how a plugin could be developed. Plugins should ultimately be built as packages, published to a PyPI style repository and added to the poetry `pyproject.toml` in this repo. The plugin code should be hosted in their own repositories with their own CI pipelines and not included here.

Are you installing Nautobot for the first time to locally try out the application? After installing Poetry and Docker, jump down to [Getting Started](#getting-started) for a step-by-step guide to install the application.

If you want to play with a cloud instance, you can always access [the Nautobot Demo Instance](https://demo.nautobot.com/) online.

## Install Docker

Before beginning, install Docker and verify its operation by running `docker run hello-world`. If you encounter any issues connecting to the Docker service, check that your local user account is permitted to run Docker. **Note:** `docker` v1.10.0 or later is required.
Expand Down Expand Up @@ -184,11 +188,21 @@ The installation of plugins has a slightly more involved getting-started process

## Super User Account

A superuser account is required to authenticate to the Nautobot web interface. There are two ways to create a superuser: automatically via environment variables (recommended) or manually via a command.

### Create Super User via Environment

The Docker container has a Docker entry point script that allows you to create a super user by the usage of Environment variables. This can be done by updating the `creds.env` file environment option of `NAUTOBOT_CREATE_SUPERUSER` to `True`. This will then use the information supplied to create the specified superuser.
The Docker container can automatically create a superuser on initial startup if the appropriate environment variables are set in your `creds.env` file. To enable this:

1. In your `creds.env` file, set `NAUTOBOT_CREATE_SUPERUSER` to `true` (note: the value must be lowercase)
2. Ensure the following variables are set with your desired values:
- `NAUTOBOT_SUPERUSER_NAME` - The username for the superuser
- `NAUTOBOT_SUPERUSER_EMAIL` - The email address for the superuser
- `NAUTOBOT_SUPERUSER_PASSWORD` - The password for the superuser

The superuser will be automatically created when the containers start. If you need to create additional superusers or the automatic creation didn't work, you can manually create one using the method below.

### Create Super User via Container
### Create Super User Manually

After the containers have started:

Expand Down