Skip to content

Commit 536239d

Browse files
authored
Merge branch 'feature' into issue_8233
2 parents fa4807b + 9b51c2a commit 536239d

File tree

162 files changed

+2096
-596
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+2096
-596
lines changed

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ body:
1414
attributes:
1515
label: NetBox version
1616
description: What version of NetBox are you currently running?
17-
placeholder: v3.2.1
17+
placeholder: v3.2.4
1818
validations:
1919
required: true
2020
- type: dropdown

.github/ISSUE_TEMPLATE/feature_request.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ body:
1414
attributes:
1515
label: NetBox version
1616
description: What version of NetBox are you currently running?
17-
placeholder: v3.2.1
17+
placeholder: v3.2.4
1818
validations:
1919
required: true
2020
- type: dropdown

.github/workflows/stale.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
stale:
99
runs-on: ubuntu-latest
1010
steps:
11-
- uses: actions/stale@v4
11+
- uses: actions/stale@v5
1212
with:
1313
close-issue-message: >
1414
This issue has been automatically closed due to lack of activity. In an
@@ -27,7 +27,10 @@ jobs:
2727
This issue has been automatically marked as stale because it has not had
2828
recent activity. It will be closed if no further activity occurs. NetBox
2929
is governed by a small group of core maintainers which means not all opened
30-
issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
30+
issues may receive direct feedback. **Do not** attempt to circumvent this
31+
process by "bumping" the issue; doing so will result in its immediate closure
32+
and you may be barred from participating in any future discussions. Please see
33+
our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
3134
stale-pr-label: 'pending closure'
3235
stale-pr-message: >
3336
This PR has been automatically marked as stale because it has not had

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The changelog has been moved to the [project release notes](https://netbox.readthedocs.io/en/stable/release-notes/).
1+
The changelog has been moved to the [project release notes](https://docs.netbox.dev/en/stable/release-notes/).

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ appropriate labels will be applied for categorization.
9999
## Submitting Pull Requests
100100

101101
* If you're interested in contributing to NetBox, be sure to check out our
102-
[getting started](https://netbox.readthedocs.io/en/stable/development/getting-started/)
102+
[getting started](https://docs.netbox.dev/en/stable/development/getting-started/)
103103
documentation for tips on setting up your development environment.
104104

105105
* Be sure to open an issue **before** starting work on a pull request, and
@@ -160,9 +160,9 @@ to aid in issue management.
160160

161161
It is natural that some new issues get more attention than others. The stale
162162
bot helps bring renewed attention to potentially valuable issues that may have
163-
been overlooked. **Do not** comment on an issue that has been marked stale in
164-
an effort to circumvent the bot: Doing so will not remove the stale label.
165-
(Stale labels can be removed only by maintainers.)
163+
been overlooked. **Do not** comment on a stale issue merely to "bump" it in an
164+
effort to circumvent the bot: This will result in the immediate closure of the
165+
issue, and you may be barred from participating in future discussions.
166166

167167
## Maintainer Guidance
168168

@@ -171,7 +171,7 @@ an effort to circumvent the bot: Doing so will not remove the stale label.
171171
the understanding that all contributions are submitted under the Apache 2.0
172172
license and that your employer may not make claim to any contributions.
173173
Contributions include code work, issue management, and community support. All
174-
development must be in accordance with our [development guidance](https://netbox.readthedocs.io/en/stable/development/).
174+
development must be in accordance with our [development guidance](https://docs.netbox.dev/en/stable/development/).
175175

176176
* Maintainers are expected to attend (where feasible) our biweekly ~30-minute
177177
sync to review agenda items. This meeting provides opportunity to present and

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ NetBox runs as a web application atop the [Django](https://www.djangoproject.com
4949
Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a
5050
complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/netbox-community/netbox).
5151

52-
The complete documentation for NetBox can be found at [Read the Docs](https://netbox.readthedocs.io/en/stable/). A public demo instance is available at https://demo.netbox.dev.
52+
The complete documentation for NetBox can be found at [docs.netbox.dev](https://docs.netbox.dev/). A public demo instance is available at https://demo.netbox.dev.
5353

5454
<div align="center">
5555
<h4>Thank you to our sponsors!</h4>
@@ -60,6 +60,8 @@ The complete documentation for NetBox can be found at [Read the Docs](https://ne
6060
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
6161
[![NS1](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/ns1.png)](https://ns1.com/)
6262
<br />
63+
[![Sentry](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/sentry.png)](https://sentry.io/)
64+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
6365
[![Stellar Technologies](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/stellar.png)](https://stellar.tech/)
6466

6567
</div>
@@ -71,7 +73,7 @@ The complete documentation for NetBox can be found at [Read the Docs](https://ne
7173

7274
### Installation
7375

74-
Please see [the documentation](https://netbox.readthedocs.io/en/stable/) for
76+
Please see [the documentation](https://docs.netbox.dev/) for
7577
instructions on installing NetBox. To upgrade NetBox, please download the
7678
[latest release](https://github.com/netbox-community/netbox/releases) and
7779
run `upgrade.sh`.

SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Security Policy
2+
3+
## No Warranty
4+
5+
Per the terms of the Apache 2 license, NetBox is offered "as is" and without any guarantee or warranty pertaining to its operation. While every reasonable effort is made by its maintainers to ensure the product remains free of security vulnerabilities, users are ultimately responsible for conducting their own evaluations of each software release.
6+
7+
## Recommendations
8+
9+
Administrators are encouraged to adhere to industry best practices concerning the secure operation of software, such as:
10+
11+
* Do not expose your NetBox installation to the public Internet
12+
* Do not permit multiple users to share an account
13+
* Enforce minimum password complexity requirements for local accounts
14+
* Prohibit access to your database from clients other than the NetBox application
15+
* Keep your deployment updated to the most recent stable release
16+
17+
## Reporting a Suspected Vulnerability
18+
19+
If you believe you've uncovered a security vulnerability and wish to report it confidentially, you may do so via email. Please note that any reported vulnerabilities **MUST** meet all the following conditions:
20+
21+
* Affects the most recent stable release of NetBox, or a current beta release
22+
* Affects a NetBox instance installed and configured per the official documentation
23+
* Is reproducible following a prescribed set of instructions
24+
25+
Please note that we **DO NOT** accept reports generated by automated tooling which merely suggest that a file or file(s) _may_ be vulnerable under certain conditions, as these are most often innocuous.
26+
27+
If you believe that you've found a vulnerability which meets all of these conditions, please email a brief description of the suspected bug and instructions for reproduction to **[email protected]**. For any security concerns regarding NetBox deployed via Docker, please see the [netbox-docker](https://github.com/netbox-community/netbox-docker) project.
28+
29+
### Bug Bounties
30+
31+
As NetBox is provided as free open source software, we do not offer any monetary compensation for vulnerability or bug reports, however your contributions are greatly appreciated.

base_requirements.txt

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,14 @@ django-pglocks
3030
# https://github.com/korfuri/django-prometheus
3131
django-prometheus
3232

33-
# Django chaching backend using Redis
33+
# Django caching backend using Redis
3434
# https://github.com/jazzband/django-redis
3535
django-redis
3636

37+
# Django extensions for Rich (terminal text rendering)
38+
# https://github.com/adamchainz/django-rich
39+
django-rich
40+
3741
# Django integration for RQ (Reqis queuing)
3842
# https://github.com/rq/django-rq
3943
django-rq
@@ -68,8 +72,7 @@ gunicorn
6872

6973
# Platform-agnostic template rendering engine
7074
# https://github.com/pallets/jinja
71-
# Pin to v3.0 for mkdocstrings
72-
Jinja2<3.1
75+
Jinja2
7376

7477
# Simple markup language for rendering HTML
7578
# https://github.com/Python-Markdown/markdown
@@ -85,7 +88,7 @@ mkdocs-material
8588

8689
# Introspection for embedded code
8790
# https://github.com/mkdocstrings/mkdocstrings
88-
mkdocstrings<=0.17.0
91+
mkdocstrings[python-legacy]
8992

9093
# Library for manipulating IP prefixes and addresses
9194
# https://github.com/netaddr/netaddr
@@ -103,6 +106,10 @@ psycopg2-binary
103106
# https://github.com/yaml/pyyaml
104107
PyYAML
105108

109+
# Sentry SDK
110+
# https://github.com/getsentry/sentry-python
111+
sentry-sdk
112+
106113
# Social authentication framework
107114
# https://github.com/python-social-auth/social-core
108115
social-auth-core

contrib/netbox-rq.service

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[Unit]
22
Description=NetBox Request Queue Worker
3-
Documentation=https://netbox.readthedocs.io/en/stable/
3+
Documentation=https://docs.netbox.dev/
44
After=network-online.target
55
Wants=network-online.target
66

contrib/netbox.service

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[Unit]
22
Description=NetBox WSGI Service
3-
Documentation=https://netbox.readthedocs.io/en/stable/
3+
Documentation=https://docs.netbox.dev/
44
After=network-online.target
55
Wants=network-online.target
66

0 commit comments

Comments
 (0)