Skip to content

Commit

Permalink
update README and add table of contents (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
jvoss authored Apr 29, 2022
1 parent f964be6 commit ba56abb
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,30 @@ https://img.shields.io/badge/Netbox-v3.2.2-blue)](https://github.com/netbox-comm
[![Version](https://img.shields.io/github/release/jvoss/ansible-role-netbox.svg)](https://github.com/jvoss/ansible-role-netbox/releases/)

Installs, configures and maintains [NetBox](https://github.com/netbox-community/netbox)

## Requirements
on a variety of popular Linux distributions.

## Contents
1. [General Information](#general-information)
1. [Supported Platforms](#supported-platforms)
2. [Role variables](#role-variables)
3. [User accounts](#user-accounts)
1. [External Authentication](#external-authentication)
4. [Plugins](#plugins)
1. [Removing Plugins](#removing-plugins)
5. [Version Locking](#version-locking)
6. [Dependencies](#dependencies)
7. [Example Playbook](#example-playbook)
8. [Contributing](#contributing)

## General Information

This role manages the installation and configuration of NetBox. This role
does not provide PostgreSQL or Redis services that are required dependencies
of the application. Those tasks are intentionally left to allow the user to
manage those services within their own roles and playbooks.

### Supported Platforms

Tested on the following platforms:
* Amazon Linux 2
* CentOS 8
Expand Down

0 comments on commit ba56abb

Please sign in to comment.