Compare commits
422 Commits
Author | SHA1 | Date | |
---|---|---|---|
f64ae49f18 | |||
4f645769df | |||
db7acaf647 | |||
90909d4181 | |||
bdbcf7bf4a | |||
477decd80a | |||
b845efe1ad | |||
56defa3f82 | |||
7078ab7519 | |||
fcd5b4e66b | |||
2efacf39ca | |||
a4ce13be19 | |||
fa08388175 | |||
fd9b41a5d1 | |||
83ec1c2656 | |||
0fe49f87d7 | |||
83f87b4ad2 | |||
82d9d8ae49 | |||
f1864f8f20 | |||
8431b77422 | |||
19e167ec19 | |||
8f7c21749e | |||
ec9a3e80da | |||
61eaffaf2e | |||
fef49f447e | |||
5ded00b6fb | |||
67ddeb6735 | |||
8179a4344b | |||
688d8901b7 | |||
687b8384bc | |||
1c3017323c | |||
c8bd177a93 | |||
c31ed9a79a | |||
139c158d8a | |||
e5400e345b | |||
017098a587 | |||
bb8f2fd17c | |||
d9da3fa35b | |||
0f7e72fc0d | |||
d9f72e94fa | |||
1c8cdfa6dd | |||
b6a30bf989 | |||
4eb0d6a368 | |||
849f8bef07 | |||
9eee74ba61 | |||
34c26bbd30 | |||
caa3d3324f | |||
25b022203a | |||
e61496688d | |||
29bef7450a | |||
6edc921a79 | |||
0f0ce521d6 | |||
c3f119bedc | |||
1701399b82 | |||
0b70f722f9 | |||
cecfd627e4 | |||
fb7213a1d2 | |||
1aa742342c | |||
230cd09cb5 | |||
d67ed0c2df | |||
b1d6e3caaa | |||
542538bf5c | |||
76404d01bf | |||
ab948e467c | |||
0d221e684d | |||
5332504c5a | |||
0082261007 | |||
052b17d5c1 | |||
7516e5d00d | |||
1bd16cec68 | |||
0d1637bd71 | |||
60db7e6c90 | |||
607ae32450 | |||
64bf745dce | |||
0ec4c5d795 | |||
afc10aaf26 | |||
e48a1b685b | |||
d129ade861 | |||
f394400b2b | |||
b56c45b4ee | |||
a48b86b5d4 | |||
6e74993d99 | |||
6fd2681449 | |||
a194302a41 | |||
bd9bdd0635 | |||
11615dfd7b | |||
1a70f971c0 | |||
69e997f0ea | |||
878b3b6abb | |||
d08e8b8d9b | |||
49d80c9109 | |||
5a61886e1d | |||
0c0c468386 | |||
f5d5a04b1c | |||
c416a054ae | |||
ad139decb3 | |||
404b4bcffe | |||
0e1c589541 | |||
d8ac6f828c | |||
bf0cecc7fd | |||
1ed3b1d849 | |||
dcc8a624ba | |||
7ccd618c58 | |||
afd18c6f39 | |||
d573274e21 | |||
50721989bf | |||
06232f64bb | |||
8fcbc5c294 | |||
14612526e0 | |||
8cd5ea456e | |||
8453eab8dd | |||
cc6a35b636 | |||
48f6e6cc04 | |||
bffdc6d822 | |||
3982207d91 | |||
409cfeb337 | |||
5354b142cb | |||
d3ce916073 | |||
db34a0ae2b | |||
27bf52cf3e | |||
5dea11c4d4 | |||
35c19d0fc8 | |||
cd42632628 | |||
09c897aa22 | |||
656b118826 | |||
f134a44bc7 | |||
5add31ee7a | |||
2d5c453350 | |||
942f978ed2 | |||
52f38a3771 | |||
a24c19c503 | |||
f13a6bf5e4 | |||
52f80cc7ca | |||
a7ebc148e8 | |||
636495e062 | |||
6e735fd431 | |||
ab2a7bc8e5 | |||
09ba1d3f4e | |||
f3a78bfd10 | |||
b81d4fba64 | |||
2c26000304 | |||
671f5e9411 | |||
d9ff19fd30 | |||
cb1bc4bde6 | |||
a75db6add9 | |||
279a54bef0 | |||
3f5f4ff8bb | |||
59922f3423 | |||
d0f72b5fd3 | |||
838a56c96f | |||
6ee26d62e8 | |||
542300056c | |||
3c7f90cab8 | |||
2a15689e5f | |||
9c6b063408 | |||
3134057f87 | |||
56bda20a67 | |||
51372eed32 | |||
e33ff85b08 | |||
279873d20e | |||
681876681d | |||
29e66a0a01 | |||
5d9aa096fd | |||
84132e4b59 | |||
da4c1a54a9 | |||
53418e7d19 | |||
368d1bca75 | |||
bb9a7fe542 | |||
15da2f0642 | |||
ee2d1dea17 | |||
402ea6e8d4 | |||
8017bb72b9 | |||
33d5230859 | |||
f0b3a0701c | |||
1a2957238c | |||
ac496a16ee | |||
e4315245b0 | |||
d4e94017b4 | |||
21cf7b498d | |||
2bbb2d16e1 | |||
9d04f2a7a5 | |||
b29f7fd446 | |||
6a3ba4409e | |||
570bb311e2 | |||
5e492c63c6 | |||
26b15f9ff1 | |||
3c8449fbec | |||
c51747a163 | |||
75fa7e7e99 | |||
9de583553d | |||
daa8b40c34 | |||
af6306db25 | |||
730743139e | |||
94e242179a | |||
8c691f1308 | |||
b74688309a | |||
60e9cfd458 | |||
1d69e6f233 | |||
918952a2a5 | |||
c22996d7d7 | |||
0c99ff8b56 | |||
1265d2277a | |||
620ca96d64 | |||
2561055265 | |||
53ac2ff81b | |||
b6492b2e6b | |||
6d25a54d49 | |||
36f409a16b | |||
9d247f5530 | |||
7a42faaabc | |||
f5a3e3f955 | |||
6307a58c4a | |||
1e78c386a5 | |||
40f24105e6 | |||
1a4ef09a16 | |||
3d6b6c2a67 | |||
f1787b4775 | |||
a7cb1a4651 | |||
8fb42b3213 | |||
b7d99c9c69 | |||
d52ef4445e | |||
e1335a1194 | |||
c9d8f55ea1 | |||
347b943b75 | |||
f15dec52ae | |||
e024427428 | |||
5f57cb2774 | |||
5873885edc | |||
e141d9f16d | |||
eb59ace74c | |||
2ee4acba21 | |||
2a582304b3 | |||
5309673f95 | |||
3c07538719 | |||
3df807faa0 | |||
4c0ee77bd0 | |||
6c01ada882 | |||
b6e5486b48 | |||
46f628e91b | |||
9f009c5907 | |||
73ce1f9b7a | |||
f443d4ac53 | |||
1b9bb2a25e | |||
d2d7948021 | |||
31a4da297a | |||
8e278c3c8e | |||
24eaba7f9b | |||
99b906c4f1 | |||
37733049da | |||
4da3f75c14 | |||
607ccd10bf | |||
f27148634a | |||
46edaa1d22 | |||
064b713489 | |||
9169fc7684 | |||
b8a7ffdb7b | |||
8450ba2f74 | |||
291ba760f1 | |||
2fbb5dd0b0 | |||
ea81db4789 | |||
249e589096 | |||
f1ca9ab7eb | |||
dfa1904a82 | |||
b5c12a82d2 | |||
7e1750d3a3 | |||
651bbc49ba | |||
d72facf182 | |||
d7866d5f6e | |||
33430fda08 | |||
e020b46f6a | |||
51049781b4 | |||
1e681f30b3 | |||
4680e59a07 | |||
aaaa628585 | |||
e8fa63d18b | |||
17b9569094 | |||
1a3ace957a | |||
96799369fe | |||
f1de85d975 | |||
830d498094 | |||
714a132566 | |||
d0fbb37d66 | |||
87159b56be | |||
252ab33560 | |||
0603f1ebe9 | |||
164b01319c | |||
e6fedf16fe | |||
0594d2c3ae | |||
8b8447f5c6 | |||
f42e78ece2 | |||
c473fcc44a | |||
bcafc4328c | |||
fe27ebc907 | |||
364555eef6 | |||
451337750a | |||
bc6e4f81b0 | |||
e452004526 | |||
caba1b335d | |||
c798e881b0 | |||
b47e85ab3f | |||
28553202a4 | |||
69c5580a3e | |||
4d54bb172b | |||
44d0f47fb5 | |||
12af4233bd | |||
f703bba5e1 | |||
dd0c0b795d | |||
be7af2ea4c | |||
75690ac7dd | |||
ec603633ea | |||
c99172661c | |||
9bdd074ad7 | |||
d69dacef09 | |||
ebc5900206 | |||
8208dedb19 | |||
0d748ed392 | |||
23d5865e3d | |||
2037e42e45 | |||
055538cc21 | |||
5408cf5af0 | |||
22486fefb5 | |||
96bda7fa4f | |||
c085287e64 | |||
b4a6be37ec | |||
02a926431b | |||
3978b14c7f | |||
7532508aab | |||
858611ad67 | |||
155e90c99f | |||
cb524c32ed | |||
cb4dcc0488 | |||
ddcc8b5131 | |||
3286faa94c | |||
788cd03a35 | |||
0911c2251d | |||
c698496e36 | |||
23a262d72f | |||
5273e17d89 | |||
e44f0398fb | |||
7c2e012523 | |||
5a29364bca | |||
5d5b01f6b5 | |||
5d6e733bce | |||
87a9808bc2 | |||
7bf9e1af5a | |||
1e588431e2 | |||
41fd4e5d67 | |||
17f1bb0af0 | |||
9cc58918ab | |||
831867499b | |||
d5dde45bec | |||
6576c18a9c | |||
efd6e6a3c2 | |||
47a7eee16a | |||
5eac65b8f6 | |||
2ba441124e | |||
f2d070fc49 | |||
97ee353b00 | |||
c001b88a81 | |||
b131b07af8 | |||
311629ade4 | |||
256f23b4ad | |||
29e37a31d7 | |||
93017f150e | |||
ac8cb022ae | |||
480cabaefe | |||
ab7e19df55 | |||
4ce89f9209 | |||
3e2bf7ec93 | |||
4bad061bc4 | |||
f9abdf2390 | |||
cc95a67df0 | |||
fb5bacc4b4 | |||
ed309a15b4 | |||
5f8a09536c | |||
d3a30e1172 | |||
e60a746eee | |||
879c700bb8 | |||
6f70b88972 | |||
7a9aef3791 | |||
3071c500da | |||
350747c1cb | |||
250b1fb093 | |||
eef45c8197 | |||
f549b93b9d | |||
f2b0375d5b | |||
3202fb9446 | |||
ff373bd60d | |||
bd07a7a5a2 | |||
41d80d66b1 | |||
015e131d99 | |||
ff37e17eeb | |||
1403f52d04 | |||
7e0a8fee82 | |||
0c1b69ded0 | |||
06e0815c70 | |||
8f2820626c | |||
b6faad36cb | |||
73f479d5db | |||
89ad7588f0 | |||
a4d986011d | |||
f2bb1198dd | |||
39c7de4af4 | |||
238f95c5ce | |||
751a131b78 | |||
5e2158da24 | |||
4a530947f8 | |||
bdb4396275 | |||
80d87bdf1b | |||
6d465e6f81 | |||
b72084290a | |||
aa3357817a | |||
9441be459c | |||
1779ba790d | |||
22cb2d5812 | |||
6020f4503a | |||
a4f494db14 | |||
0cac6f51a9 | |||
dd01e3c227 | |||
925f41b97f | |||
7d871778eb | |||
35a94cb7e5 |
@ -1,10 +1,13 @@
|
|||||||
.git
|
.git*
|
||||||
.github
|
|
||||||
.travis.yml
|
|
||||||
*.md
|
*.md
|
||||||
env
|
|
||||||
build*
|
build*
|
||||||
docker-compose.override.yml
|
docker-compose*
|
||||||
|
env
|
||||||
|
test-configuration
|
||||||
.netbox/.git*
|
.netbox/.git*
|
||||||
.netbox/.travis.yml
|
.netbox/.pre-commit-config.yaml
|
||||||
|
.netbox/.readthedocs.yaml
|
||||||
|
.netbox/.tx
|
||||||
|
.netbox/contrib
|
||||||
.netbox/scripts
|
.netbox/scripts
|
||||||
|
.netbox/upgrade.sh
|
||||||
|
@ -9,3 +9,6 @@ indent_size = 2
|
|||||||
|
|
||||||
[*.py]
|
[*.py]
|
||||||
indent_size = 4
|
indent_size = 4
|
||||||
|
|
||||||
|
[VERSION]
|
||||||
|
insert_final_newline = false
|
||||||
|
@ -2,17 +2,12 @@
|
|||||||
"Verbose": false,
|
"Verbose": false,
|
||||||
"Debug": false,
|
"Debug": false,
|
||||||
"IgnoreDefaults": false,
|
"IgnoreDefaults": false,
|
||||||
"SpacesAftertabs": false,
|
"SpacesAfterTabs": false,
|
||||||
"NoColor": false,
|
"NoColor": false,
|
||||||
"Exclude": [
|
"Exclude": ["LICENSE", "\\.initializers", "\\.vscode"],
|
||||||
"LICENSE",
|
|
||||||
"\\.initializers",
|
|
||||||
"\\.vscode"
|
|
||||||
],
|
|
||||||
"AllowedContentTypes": [],
|
"AllowedContentTypes": [],
|
||||||
"PassedFiles": [],
|
"PassedFiles": [],
|
||||||
"Disable": {
|
"Disable": {
|
||||||
// set these options to true to disable specific checks
|
|
||||||
"EndOfLine": false,
|
"EndOfLine": false,
|
||||||
"Indentation": false,
|
"Indentation": false,
|
||||||
"InsertFinalNewline": false,
|
"InsertFinalNewline": false,
|
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
@ -1,8 +1,8 @@
|
|||||||
# These are supported funding model platforms
|
# These are supported funding model platforms
|
||||||
|
|
||||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||||
- cimnine
|
- cimnine
|
||||||
- tobiasge
|
- tobiasge
|
||||||
patreon: # Replace with a single Patreon username
|
patreon: # Replace with a single Patreon username
|
||||||
open_collective: # Replace with a single Open Collective username
|
open_collective: # Replace with a single Open Collective username
|
||||||
ko_fi: # Replace with a single Ko-fi username
|
ko_fi: # Replace with a single Ko-fi username
|
||||||
|
279
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
279
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@ -1,148 +1,147 @@
|
|||||||
name: Bug report
|
name: Bug report
|
||||||
description: Create a report about a malfunction of the Docker setup
|
description: Create a report about a malfunction of the Docker setup
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Please only raise an issue if you're certain that you've found a bug.
|
Please only raise an issue if you're certain that you've found a bug.
|
||||||
Else, see these other means to get help:
|
Else, see these other means to get help:
|
||||||
|
|
||||||
- See our troubleshooting section:
|
- See our troubleshooting section:
|
||||||
https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
|
https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
|
||||||
- Have a look at the rest of the wiki:
|
- Have a look at the rest of the wiki:
|
||||||
https://github.com/netbox-community/netbox-docker/wiki
|
https://github.com/netbox-community/netbox-docker/wiki
|
||||||
- Check the release notes:
|
- Check the release notes:
|
||||||
https://github.com/netbox-community/netbox-docker/releases
|
https://github.com/netbox-community/netbox-docker/releases
|
||||||
- Look through the issues already resolved:
|
- Look through the issues already resolved:
|
||||||
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
|
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
|
||||||
|
|
||||||
If you did not find what you're looking for,
|
If you did not find what you're looking for,
|
||||||
try the help of our community:
|
try the help of our community:
|
||||||
|
|
||||||
- Post to Github Discussions:
|
- Post to Github Discussions:
|
||||||
https://github.com/netbox-community/netbox-docker/discussions
|
https://github.com/netbox-community/netbox-docker/discussions
|
||||||
- Join the `#netbox-docker` channel on our Slack:
|
- Join the `#netbox-docker` channel on our Slack:
|
||||||
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
||||||
- Ask on the NetBox mailing list:
|
- Ask on the NetBox mailing list:
|
||||||
https://groups.google.com/d/forum/netbox-discuss
|
https://groups.google.com/d/forum/netbox-discuss
|
||||||
|
|
||||||
Please don't open an issue to open a PR.
|
Please don't open an issue to open a PR.
|
||||||
Just submit the PR, that's good enough.
|
Just submit the PR, that's good enough.
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: current-behavior
|
id: current-behavior
|
||||||
attributes:
|
attributes:
|
||||||
label: Current Behavior
|
label: Current Behavior
|
||||||
description: Please describe what you did and how you think it misbehaved
|
description: Please describe what you did and how you think it misbehaved
|
||||||
placeholder: I tried to … by doing …, but it …
|
placeholder: I tried to … by doing …, but it …
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: expected-behavior
|
id: expected-behavior
|
||||||
attributes:
|
attributes:
|
||||||
label: Expected Behavior
|
label: Expected Behavior
|
||||||
description: Please describe what you expected instead
|
description: Please describe what you expected instead
|
||||||
placeholder: I expected that … when I do …
|
placeholder: I expected that … when I do …
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
id: docker-compose-version
|
id: docker-compose-version
|
||||||
attributes:
|
attributes:
|
||||||
label: Docker Compose Version
|
label: Docker Compose Version
|
||||||
description: Please paste the output of `docker-compose version`
|
description: Please paste the output of `docker-compose version` (or `docker compose version`)
|
||||||
placeholder: Docker Compose version vX.Y.Z
|
placeholder: Docker Compose version vX.Y.Z
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: docker-version
|
id: docker-version
|
||||||
attributes:
|
attributes:
|
||||||
label: Docker Version
|
label: Docker Version
|
||||||
description: Please paste the output of `docker version`
|
description: Please paste the output of `docker version`
|
||||||
render: text
|
render: text
|
||||||
placeholder: |
|
placeholder: |
|
||||||
Client:
|
Client:
|
||||||
Cloud integration: 1.0.17
|
Cloud integration: 1.0.17
|
||||||
Version: 20.10.8
|
Version: 20.10.8
|
||||||
API version: 1.41
|
API version: 1.41
|
||||||
Go version: go1.16.6
|
Go version: go1.16.6
|
||||||
Git commit: 3967b7d
|
Git commit: 3967b7d
|
||||||
Built: Fri Jul 30 19:55:20 2021
|
Built: Fri Jul 30 19:55:20 2021
|
||||||
OS/Arch: darwin/amd64
|
OS/Arch: darwin/amd64
|
||||||
Context: default
|
Context: default
|
||||||
Experimental: true
|
Experimental: true
|
||||||
|
|
||||||
Server: Docker Engine - Community
|
Server: Docker Engine - Community
|
||||||
Engine:
|
Engine:
|
||||||
Version: 20.10.8
|
Version: 20.10.8
|
||||||
API version: 1.41 (minimum version 1.12)
|
API version: 1.41 (minimum version 1.12)
|
||||||
Go version: go1.16.6
|
Go version: go1.16.6
|
||||||
Git commit: 75249d8
|
Git commit: 75249d8
|
||||||
Built: Fri Jul 30 19:52:10 2021
|
Built: Fri Jul 30 19:52:10 2021
|
||||||
OS/Arch: linux/amd64
|
OS/Arch: linux/amd64
|
||||||
Experimental: false
|
Experimental: false
|
||||||
containerd:
|
containerd:
|
||||||
Version: 1.4.9
|
Version: 1.4.9
|
||||||
GitCommit: e25210fe30a0a703442421b0f60afac609f950a3
|
GitCommit: e25210fe30a0a703442421b0f60afac609f950a3
|
||||||
runc:
|
runc:
|
||||||
Version: 1.0.1
|
Version: 1.0.1
|
||||||
GitCommit: v1.0.1-0-g4144b63
|
GitCommit: v1.0.1-0-g4144b63
|
||||||
docker-init:
|
docker-init:
|
||||||
Version: 0.19.0
|
Version: 0.19.0
|
||||||
GitCommit: de40ad0
|
GitCommit: de40ad0
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
id: git-rev
|
id: git-rev
|
||||||
attributes:
|
attributes:
|
||||||
label: The git Revision
|
label: The git Revision
|
||||||
description: Please paste the output of `git rev-parse HEAD`
|
description: Please paste the output of `git rev-parse HEAD`
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: git-status
|
id: git-status
|
||||||
attributes:
|
attributes:
|
||||||
label: The git Status
|
label: The git Status
|
||||||
description: Please paste the output of `git status`
|
description: Please paste the output of `git status`
|
||||||
render: text
|
render: text
|
||||||
placeholder: |
|
placeholder: |
|
||||||
On branch main
|
On branch main
|
||||||
nothing to commit, working tree clean
|
nothing to commit, working tree clean
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
id: run-command
|
id: run-command
|
||||||
attributes:
|
attributes:
|
||||||
label: Startup Command
|
label: Startup Command
|
||||||
description: Please specify the command you used to start the project
|
description: Please specify the command you used to start the project
|
||||||
placeholder: docker compose up
|
placeholder: docker compose up
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: netbox-logs
|
id: netbox-logs
|
||||||
attributes:
|
attributes:
|
||||||
label: NetBox Logs
|
label: NetBox Logs
|
||||||
description: Please paste the output of `docker-compose logs netbox` (or `docker compose logs netbox`)
|
description: Please paste the output of `docker-compose logs netbox` (or `docker compose logs netbox`)
|
||||||
render: text
|
render: text
|
||||||
placeholder: |
|
placeholder: |
|
||||||
netbox_1 | ⚙️ Applying database migrations
|
netbox_1 | ⚙️ Applying database migrations
|
||||||
netbox_1 | 🧬 loaded config '/etc/netbox/config/configuration.py'
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/configuration.py'
|
||||||
netbox_1 | 🧬 loaded config '/etc/netbox/config/a.py'
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/a.py'
|
||||||
netbox_1 | 🧬 loaded config '/etc/netbox/config/extra.py'
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/extra.py'
|
||||||
netbox_1 | 🧬 loaded config '/etc/netbox/config/logging.py'
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/logging.py'
|
||||||
netbox_1 | 🧬 loaded config '/etc/netbox/config/plugins.py'
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/plugins.py'
|
||||||
...
|
...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: docker-compose-override-yml
|
id: docker-compose-override-yml
|
||||||
attributes:
|
attributes:
|
||||||
label: Content of docker-compose.override.yml
|
label: Content of docker-compose.override.yml
|
||||||
description: Please paste the output of `cat docker-compose.override.yml`
|
description: Please paste the output of `cat docker-compose.override.yml`
|
||||||
render: yaml
|
render: yaml
|
||||||
placeholder: |
|
placeholder: |
|
||||||
version: '3.4'
|
services:
|
||||||
services:
|
netbox:
|
||||||
netbox:
|
ports:
|
||||||
ports:
|
- '8080:8080'
|
||||||
- '8080:8080'
|
validations:
|
||||||
validations:
|
required: true
|
||||||
required: true
|
|
||||||
|
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -6,7 +6,7 @@ contact_links:
|
|||||||
|
|
||||||
- name: Chat
|
- name: Chat
|
||||||
url: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
url: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
||||||
about: 'Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel.'
|
about: "Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel."
|
||||||
|
|
||||||
- name: Community Wiki
|
- name: Community Wiki
|
||||||
url: https://github.com/netbox-community/netbox-docker/wiki
|
url: https://github.com/netbox-community/netbox-docker/wiki
|
||||||
|
120
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
120
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@ -1,68 +1,68 @@
|
|||||||
name: Feature or Change Request
|
name: Feature or Change Request
|
||||||
description: Request a new feature or a change of the current behavior
|
description: Request a new feature or a change of the current behavior
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
This issue type is to propose new features for the Docker setup.
|
This issue type is to propose new features for the Docker setup.
|
||||||
To just spin an idea, see the Github Discussions section, please.
|
To just spin an idea, see the Github Discussions section, please.
|
||||||
|
|
||||||
Before asking for help, see these links first:
|
Before asking for help, see these links first:
|
||||||
|
|
||||||
- See our troubleshooting section:
|
- See our troubleshooting section:
|
||||||
https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
|
https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
|
||||||
- Have a look at the rest of the wiki:
|
- Have a look at the rest of the wiki:
|
||||||
https://github.com/netbox-community/netbox-docker/wiki
|
https://github.com/netbox-community/netbox-docker/wiki
|
||||||
- Check the release notes:
|
- Check the release notes:
|
||||||
https://github.com/netbox-community/netbox-docker/releases
|
https://github.com/netbox-community/netbox-docker/releases
|
||||||
- Look through the issues already resolved:
|
- Look through the issues already resolved:
|
||||||
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
|
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
|
||||||
|
|
||||||
If you did not find what you're looking for,
|
If you did not find what you're looking for,
|
||||||
try the help of our community:
|
try the help of our community:
|
||||||
|
|
||||||
- Post to Github Discussions:
|
- Post to Github Discussions:
|
||||||
https://github.com/netbox-community/netbox-docker/discussions
|
https://github.com/netbox-community/netbox-docker/discussions
|
||||||
- Join the `#netbox-docker` channel on our Slack:
|
- Join the `#netbox-docker` channel on our Slack:
|
||||||
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
||||||
- Ask on the NetBox mailing list:
|
- Ask on the NetBox mailing list:
|
||||||
https://groups.google.com/d/forum/netbox-discuss
|
https://groups.google.com/d/forum/netbox-discuss
|
||||||
|
|
||||||
Please don't open an issue to open a PR.
|
Please don't open an issue to open a PR.
|
||||||
Just submit the PR, that's good enough.
|
Just submit the PR, that's good enough.
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: desired-behavior
|
id: desired-behavior
|
||||||
attributes:
|
attributes:
|
||||||
label: Desired Behavior
|
label: Desired Behavior
|
||||||
description: Please describe the desired behavior
|
description: Please describe the desired behavior
|
||||||
placeholder: To me, it would be useful, if … because …
|
placeholder: To me, it would be useful, if … because …
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: contrast-to-current
|
id: contrast-to-current
|
||||||
attributes:
|
attributes:
|
||||||
label: Contrast to Current Behavior
|
label: Contrast to Current Behavior
|
||||||
description: Please describe how the desired behavior is different from the current behavior
|
description: Please describe how the desired behavior is different from the current behavior
|
||||||
placeholder: The current behavior is …, but this lacks …
|
placeholder: The current behavior is …, but this lacks …
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: required-changes
|
id: required-changes
|
||||||
attributes:
|
attributes:
|
||||||
label: Required Changes
|
label: Required Changes
|
||||||
description: If you can, please elaborate what changes will be required to implement the desired behavior
|
description: If you can, please elaborate what changes will be required to implement the desired behavior
|
||||||
placeholder: I suggest to change the file …
|
placeholder: I suggest to change the file …
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: discussion
|
id: discussion
|
||||||
attributes:
|
attributes:
|
||||||
label: 'Discussion: Benefits and Drawbacks'
|
label: "Discussion: Benefits and Drawbacks"
|
||||||
description: |
|
description: |
|
||||||
Please make your case here:
|
Please make your case here:
|
||||||
- Why do you think this project and the community will benefit from your suggestion?
|
- Why do you think this project and the community will benefit from your suggestion?
|
||||||
- What are the drawbacks of this change? Is it backwards-compatible?
|
- What are the drawbacks of this change? Is it backwards-compatible?
|
||||||
- Anything else that you think is relevant to the discussion of this feature/change request.
|
- Anything else that you think is relevant to the discussion of this feature/change request.
|
||||||
placeholder: I suggest to change the file …
|
placeholder: I suggest to change the file …
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
|
6
.github/pull_request_template.md
vendored
6
.github/pull_request_template.md
vendored
@ -80,6 +80,6 @@ into the release notes.
|
|||||||
Please put an x into the brackets (like `[x]`) if you've completed that task.
|
Please put an x into the brackets (like `[x]`) if you've completed that task.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
* [ ] I have read the comments and followed the PR template.
|
- [ ] I have read the comments and followed the PR template.
|
||||||
* [ ] I have explained my PR according to the information in the comments.
|
- [ ] I have explained my PR according to the information in the comments.
|
||||||
* [ ] My PR targets the `develop` branch.
|
- [ ] My PR targets the `develop` branch.
|
||||||
|
59
.github/workflows/push.yml
vendored
59
.github/workflows/push.yml
vendored
@ -5,34 +5,43 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches-ignore:
|
branches-ignore:
|
||||||
- release
|
- release
|
||||||
|
- renovate/**
|
||||||
pull_request:
|
pull_request:
|
||||||
branches-ignore:
|
branches-ignore:
|
||||||
- release
|
- release
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-24.04
|
||||||
name: Checks syntax of our code
|
name: Checks syntax of our code
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: read
|
||||||
|
statuses: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
# Full git history is needed to get a proper
|
# Full git history is needed to get a proper
|
||||||
# list of changed files within `super-linter`
|
# list of changed files within `super-linter`
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- uses: actions/setup-python@v4
|
|
||||||
with:
|
|
||||||
python-version: '3.9'
|
|
||||||
- name: Lint Code Base
|
- name: Lint Code Base
|
||||||
uses: github/super-linter@v4
|
uses: super-linter/super-linter@v7
|
||||||
env:
|
env:
|
||||||
DEFAULT_BRANCH: develop
|
DEFAULT_BRANCH: develop
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
SUPPRESS_POSSUM: true
|
SUPPRESS_POSSUM: true
|
||||||
LINTER_RULES_PATH: /
|
LINTER_RULES_PATH: /
|
||||||
VALIDATE_ALL_CODEBASE: false
|
VALIDATE_ALL_CODEBASE: false
|
||||||
|
VALIDATE_CHECKOV: false
|
||||||
VALIDATE_DOCKERFILE: false
|
VALIDATE_DOCKERFILE: false
|
||||||
|
VALIDATE_GITLEAKS: false
|
||||||
|
VALIDATE_JSCPD: false
|
||||||
FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
|
FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
|
||||||
EDITORCONFIG_FILE_NAME: .ecrc
|
EDITORCONFIG_FILE_NAME: .editorconfig-checker.json
|
||||||
DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
|
DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
|
||||||
MARKDOWN_CONFIG_FILE: .markdown-lint.yml
|
MARKDOWN_CONFIG_FILE: .markdown-lint.yml
|
||||||
PYTHON_BLACK_CONFIG_FILE: pyproject.toml
|
PYTHON_BLACK_CONFIG_FILE: pyproject.toml
|
||||||
@ -47,32 +56,44 @@ jobs:
|
|||||||
- ./build-latest.sh
|
- ./build-latest.sh
|
||||||
- PRERELEASE=true ./build-latest.sh
|
- PRERELEASE=true ./build-latest.sh
|
||||||
- ./build.sh feature
|
- ./build.sh feature
|
||||||
- ./build.sh develop
|
- ./build.sh main
|
||||||
platform:
|
os:
|
||||||
- linux/amd64
|
- ubuntu-24.04
|
||||||
- linux/arm64
|
- ubuntu-24.04-arm
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
env:
|
env:
|
||||||
GH_ACTION: enable
|
GH_ACTION: enable
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
IMAGE_NAMES: docker.io/netboxcommunity/netbox
|
IMAGE_NAMES: docker.io/netboxcommunity/netbox
|
||||||
runs-on: ubuntu-latest
|
runs-on: ${{ matrix.os }}
|
||||||
name: Builds new NetBox Docker Images
|
name: Builds new NetBox Docker Images
|
||||||
steps:
|
steps:
|
||||||
- id: git-checkout
|
- id: git-checkout
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
- id: qemu-setup
|
|
||||||
name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v2
|
|
||||||
- id: buildx-setup
|
- id: buildx-setup
|
||||||
name: Set up Docker Buildx
|
name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v2
|
uses: docker/setup-buildx-action@v3
|
||||||
|
- id: arm-install-skopeo
|
||||||
|
name: Install 'skopeo' on ARM64
|
||||||
|
if: matrix.os == 'ubuntu-24.04-arm'
|
||||||
|
run: |
|
||||||
|
sudo apt-get install -y skopeo
|
||||||
|
- id: arm-buildx-platform
|
||||||
|
name: Set BUILDX_PLATFORM to ARM64
|
||||||
|
if: matrix.os == 'ubuntu-24.04-arm'
|
||||||
|
run: |
|
||||||
|
echo "BUILDX_PLATFORM=linux/arm64" >>"${GITHUB_ENV}"
|
||||||
- id: docker-build
|
- id: docker-build
|
||||||
name: Build the image for '${{ matrix.platform }}' with '${{ matrix.build_cmd }}'
|
name: Build the image for '${{ matrix.os }}' with '${{ matrix.build_cmd }}'
|
||||||
run: ${{ matrix.build_cmd }}
|
run: ${{ matrix.build_cmd }}
|
||||||
env:
|
env:
|
||||||
BUILDX_PLATFORM: ${{ matrix.platform }}
|
|
||||||
BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
|
BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
|
||||||
|
- id: arm-time-limit
|
||||||
|
name: Set Netbox container start_period higher on ARM64
|
||||||
|
if: matrix.os == 'ubuntu-24.04-arm'
|
||||||
|
run: |
|
||||||
|
echo "NETBOX_START_PERIOD=240s" >>"${GITHUB_ENV}"
|
||||||
- id: docker-test
|
- id: docker-test
|
||||||
name: Test the image
|
name: Test the image
|
||||||
run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
|
run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
|
||||||
|
65
.github/workflows/release.yml
vendored
65
.github/workflows/release.yml
vendored
@ -6,78 +6,83 @@ on:
|
|||||||
types:
|
types:
|
||||||
- published
|
- published
|
||||||
schedule:
|
schedule:
|
||||||
- cron: '45 5 * * *'
|
- cron: "45 5 * * *"
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
build_cmd:
|
build:
|
||||||
- ./build-latest.sh
|
- { "cmd": "./build-latest.sh", "branch": "release" }
|
||||||
- PRERELEASE=true ./build-latest.sh
|
- { "cmd": "./build.sh main", "branch": "release" }
|
||||||
- ./build.sh feature
|
# Build pre release images from our develop branch
|
||||||
- ./build.sh develop
|
# This is used to test the latest changes before they are merged into the main branch
|
||||||
|
- { "cmd": "PRERELEASE=true ./build-latest.sh", "branch": "develop" }
|
||||||
|
- { "cmd": "./build.sh feature", "branch": "develop" }
|
||||||
platform:
|
platform:
|
||||||
- linux/amd64,linux/arm64
|
- linux/amd64,linux/arm64
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-24.04
|
||||||
name: Builds new NetBox Docker Images
|
name: Builds new NetBox Docker Images
|
||||||
env:
|
env:
|
||||||
GH_ACTION: enable
|
GH_ACTION: enable
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
IMAGE_NAMES: docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox ghcr.io/netbox-community/netbox
|
IMAGE_NAMES: docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox ghcr.io/netbox-community/netbox
|
||||||
steps:
|
steps:
|
||||||
- id: source-checkout
|
- id: source-checkout
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ matrix.build.branch }}
|
||||||
- id: set-netbox-docker-version
|
- id: set-netbox-docker-version
|
||||||
name: Get Version of NetBox Docker
|
name: Get Version of NetBox Docker
|
||||||
run: echo "::set-output name=version::$(cat VERSION)"
|
run: echo "version=$(cat VERSION)" >>"$GITHUB_OUTPUT"
|
||||||
shell: bash
|
shell: bash
|
||||||
- id: qemu-setup
|
- id: check-build-needed
|
||||||
name: Set up QEMU
|
name: Check if the build is needed for '${{ matrix.build.cmd }}'
|
||||||
uses: docker/setup-qemu-action@v2
|
env:
|
||||||
- id: buildx-setup
|
CHECK_ONLY: "true"
|
||||||
name: Set up Docker Buildx
|
run: ${{ matrix.build.cmd }}
|
||||||
uses: docker/setup-buildx-action@v2
|
|
||||||
- id: docker-build
|
|
||||||
name: Build the image with '${{ matrix.build_cmd }}'
|
|
||||||
run: ${{ matrix.build_cmd }}
|
|
||||||
- id: test-image
|
|
||||||
name: Test the image
|
|
||||||
run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
|
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
|
||||||
# docker.io
|
# docker.io
|
||||||
- id: docker-io-login
|
- id: docker-io-login
|
||||||
name: Login to docker.io
|
name: Login to docker.io
|
||||||
uses: docker/login-action@v2
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
registry: docker.io
|
registry: docker.io
|
||||||
username: ${{ secrets.dockerhub_username }}
|
username: ${{ secrets.dockerhub_username }}
|
||||||
password: ${{ secrets.dockerhub_password }}
|
password: ${{ secrets.dockerhub_password }}
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
if: steps.check-build-needed.outputs.skipped != 'true'
|
||||||
|
- id: buildx-setup
|
||||||
|
name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
with:
|
||||||
|
version: "lab:latest"
|
||||||
|
driver: cloud
|
||||||
|
endpoint: "netboxcommunity/netbox-default"
|
||||||
|
if: steps.check-build-needed.outputs.skipped != 'true'
|
||||||
# quay.io
|
# quay.io
|
||||||
- id: quay-io-login
|
- id: quay-io-login
|
||||||
name: Login to Quay.io
|
name: Login to Quay.io
|
||||||
uses: docker/login-action@v2
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
registry: quay.io
|
registry: quay.io
|
||||||
username: ${{ secrets.quayio_username }}
|
username: ${{ secrets.quayio_username }}
|
||||||
password: ${{ secrets.quayio_password }}
|
password: ${{ secrets.quayio_password }}
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
if: steps.check-build-needed.outputs.skipped != 'true'
|
||||||
# ghcr.io
|
# ghcr.io
|
||||||
- id: ghcr-io-login
|
- id: ghcr-io-login
|
||||||
name: Login to GitHub Container Registry
|
name: Login to GitHub Container Registry
|
||||||
uses: docker/login-action@v2
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
registry: ghcr.io
|
registry: ghcr.io
|
||||||
username: ${{ github.repository_owner }}
|
username: ${{ github.repository_owner }}
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
if: steps.check-build-needed.outputs.skipped != 'true'
|
||||||
- id: build-and-push
|
- id: build-and-push
|
||||||
name: Push the image
|
name: Push the image
|
||||||
run: ${{ matrix.build_cmd }} --push
|
run: ${{ matrix.build.cmd }} --push
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
if: steps.check-build-needed.outputs.skipped != 'true'
|
||||||
env:
|
env:
|
||||||
BUILDX_PLATFORM: ${{ matrix.platform }}
|
BUILDX_PLATFORM: ${{ matrix.platform }}
|
||||||
BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
|
BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
|
||||||
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,6 +1,6 @@
|
|||||||
*.sql.gz
|
*.sql.gz
|
||||||
.netbox
|
.netbox
|
||||||
.initializers
|
.python-version
|
||||||
docker-compose.override.yml
|
docker-compose.override.yml
|
||||||
*.pem
|
*.pem
|
||||||
configuration/*
|
configuration/*
|
||||||
@ -11,5 +11,4 @@ configuration/ldap/*
|
|||||||
!configuration/ldap/ldap_config.py
|
!configuration/ldap/ldap_config.py
|
||||||
!configuration/logging.py
|
!configuration/logging.py
|
||||||
!configuration/plugins.py
|
!configuration/plugins.py
|
||||||
prometheus.yml
|
|
||||||
super-linter.log
|
super-linter.log
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
|
|
||||||
rules:
|
rules:
|
||||||
line-length:
|
line-length:
|
||||||
max: 120
|
max: 160
|
||||||
|
63
Dockerfile
63
Dockerfile
@ -1,6 +1,7 @@
|
|||||||
ARG FROM
|
ARG FROM
|
||||||
FROM ${FROM} as builder
|
FROM ${FROM} AS builder
|
||||||
|
|
||||||
|
COPY --from=ghcr.io/astral-sh/uv:0.7 /uv /usr/local/bin/
|
||||||
RUN export DEBIAN_FRONTEND=noninteractive \
|
RUN export DEBIAN_FRONTEND=noninteractive \
|
||||||
&& apt-get update -qq \
|
&& apt-get update -qq \
|
||||||
&& apt-get upgrade \
|
&& apt-get upgrade \
|
||||||
@ -13,18 +14,28 @@ RUN export DEBIAN_FRONTEND=noninteractive \
|
|||||||
libpq-dev \
|
libpq-dev \
|
||||||
libsasl2-dev \
|
libsasl2-dev \
|
||||||
libssl-dev \
|
libssl-dev \
|
||||||
|
libxml2-dev \
|
||||||
|
libxmlsec1 \
|
||||||
|
libxmlsec1-dev \
|
||||||
|
libxmlsec1-openssl \
|
||||||
|
libxslt-dev \
|
||||||
|
pkg-config \
|
||||||
python3-dev \
|
python3-dev \
|
||||||
python3-pip \
|
&& /usr/local/bin/uv venv /opt/netbox/venv
|
||||||
python3-venv \
|
|
||||||
&& python3 -m venv /opt/netbox/venv \
|
|
||||||
&& /opt/netbox/venv/bin/python3 -m pip install --upgrade \
|
|
||||||
pip \
|
|
||||||
setuptools \
|
|
||||||
wheel
|
|
||||||
|
|
||||||
ARG NETBOX_PATH
|
ARG NETBOX_PATH
|
||||||
COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
|
COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
|
||||||
RUN /opt/netbox/venv/bin/pip install \
|
ENV VIRTUAL_ENV=/opt/netbox/venv
|
||||||
|
RUN \
|
||||||
|
# Gunicorn is not needed because we use Nginx Unit
|
||||||
|
sed -i -e '/gunicorn/d' /requirements.txt && \
|
||||||
|
# We need 'social-auth-core[all]' in the Docker image. But if we put it in our own requirements-container.txt
|
||||||
|
# we have potential version conflicts and the build will fail.
|
||||||
|
# That's why we just replace it in the original requirements.txt.
|
||||||
|
sed -i -e 's/social-auth-core/social-auth-core\[all\]/g' /requirements.txt && \
|
||||||
|
# The same is true for 'django-storages'
|
||||||
|
sed -i -e 's/django-storages/django-storages\[azure,boto3,dropbox,google,libcloud,sftp\]/g' /requirements.txt && \
|
||||||
|
/usr/local/bin/uv pip install \
|
||||||
-r /requirements.txt \
|
-r /requirements.txt \
|
||||||
-r /requirements-container.txt
|
-r /requirements-container.txt
|
||||||
|
|
||||||
@ -33,8 +44,10 @@ RUN /opt/netbox/venv/bin/pip install \
|
|||||||
###
|
###
|
||||||
|
|
||||||
ARG FROM
|
ARG FROM
|
||||||
FROM ${FROM} as main
|
FROM ${FROM} AS main
|
||||||
|
|
||||||
|
COPY docker/unit.list /etc/apt/sources.list.d/unit.list
|
||||||
|
ADD --chmod=444 --chown=0:0 https://unit.nginx.org/keys/nginx-keyring.gpg /usr/share/keyrings/nginx-keyring.gpg
|
||||||
RUN export DEBIAN_FRONTEND=noninteractive \
|
RUN export DEBIAN_FRONTEND=noninteractive \
|
||||||
&& apt-get update -qq \
|
&& apt-get update -qq \
|
||||||
&& apt-get upgrade \
|
&& apt-get upgrade \
|
||||||
@ -46,21 +59,18 @@ RUN export DEBIAN_FRONTEND=noninteractive \
|
|||||||
curl \
|
curl \
|
||||||
libldap-common \
|
libldap-common \
|
||||||
libpq5 \
|
libpq5 \
|
||||||
|
libxmlsec1-openssl \
|
||||||
|
openssh-client \
|
||||||
openssl \
|
openssl \
|
||||||
python3 \
|
python3 \
|
||||||
python3-distutils \
|
|
||||||
tini \
|
tini \
|
||||||
&& curl -sL https://nginx.org/keys/nginx_signing.key \
|
unit-python3.12=1.34.2-1~noble \
|
||||||
> /etc/apt/trusted.gpg.d/nginx.asc && \
|
unit=1.34.2-1~noble \
|
||||||
echo "deb https://packages.nginx.org/unit/ubuntu/ jammy unit" \
|
|
||||||
> /etc/apt/sources.list.d/unit.list \
|
|
||||||
&& apt-get update -qq \
|
|
||||||
&& apt-get install \
|
|
||||||
--yes -qq --no-install-recommends \
|
|
||||||
unit=1.27.0-1~jammy \
|
|
||||||
unit-python3.10=1.27.0-1~jammy \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# Copy the modified 'requirements*.txt' files, to have the files actually used during installation
|
||||||
|
COPY --from=builder /requirements.txt /requirements-container.txt /opt/netbox/
|
||||||
|
COPY --from=builder /usr/local/bin/uv /usr/local/bin/
|
||||||
COPY --from=builder /opt/netbox/venv /opt/netbox/venv
|
COPY --from=builder /opt/netbox/venv /opt/netbox/venv
|
||||||
|
|
||||||
ARG NETBOX_PATH
|
ARG NETBOX_PATH
|
||||||
@ -73,19 +83,22 @@ COPY docker/housekeeping.sh /opt/netbox/housekeeping.sh
|
|||||||
COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
|
COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
|
||||||
COPY configuration/ /etc/netbox/config/
|
COPY configuration/ /etc/netbox/config/
|
||||||
COPY docker/nginx-unit.json /etc/unit/
|
COPY docker/nginx-unit.json /etc/unit/
|
||||||
|
COPY VERSION /opt/netbox/VERSION
|
||||||
|
|
||||||
WORKDIR /opt/netbox/netbox
|
WORKDIR /opt/netbox/netbox
|
||||||
|
|
||||||
# Must set permissions for '/opt/netbox/netbox/media' directory
|
# Must set permissions for '/opt/netbox/netbox/media' directory
|
||||||
# to g+w so that pictures can be uploaded to netbox.
|
# to g+w so that pictures can be uploaded to netbox.
|
||||||
RUN mkdir -p static /opt/unit/state/ /opt/unit/tmp/ \
|
RUN mkdir -p static /opt/unit/state/ /opt/unit/tmp/ \
|
||||||
&& chown -R unit:root media /opt/unit/ \
|
&& chown -R unit:root /opt/unit/ media reports scripts \
|
||||||
&& chmod -R g+w media /opt/unit/ \
|
&& chmod -R g+w /opt/unit/ media reports scripts \
|
||||||
&& cd /opt/netbox/ && SECRET_KEY="dummy" /opt/netbox/venv/bin/python -m mkdocs build \
|
&& cd /opt/netbox/ && SECRET_KEY="dummyKeyWithMinimumLength-------------------------" /opt/netbox/venv/bin/python -m mkdocs build \
|
||||||
--config-file /opt/netbox/mkdocs.yml --site-dir /opt/netbox/netbox/project-static/docs/ \
|
--config-file /opt/netbox/mkdocs.yml --site-dir /opt/netbox/netbox/project-static/docs/ \
|
||||||
&& SECRET_KEY="dummy" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input
|
&& DEBUG="true" SECRET_KEY="dummyKeyWithMinimumLength-------------------------" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input \
|
||||||
|
&& mkdir /opt/netbox/netbox/local \
|
||||||
|
&& echo "build: Docker-$(cat /opt/netbox/VERSION)" > /opt/netbox/netbox/local/release.yaml
|
||||||
|
|
||||||
ENV LANG=C.UTF-8 PATH=/opt/netbox/venv/bin:$PATH
|
ENV LANG=C.utf8 PATH=/opt/netbox/venv/bin:$PATH VIRTUAL_ENV=/opt/netbox/venv UV_NO_CACHE=1
|
||||||
ENTRYPOINT [ "/usr/bin/tini", "--" ]
|
ENTRYPOINT [ "/usr/bin/tini", "--" ]
|
||||||
|
|
||||||
CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
|
CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
|
||||||
|
19
MAINTAINERS.md
Normal file
19
MAINTAINERS.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Maintainers of _NetBox Docker_
|
||||||
|
|
||||||
|
This file lists all currently recognized maintainers of the _NetBox Docker_ project in alphabetical order:
|
||||||
|
|
||||||
|
- @cimnine
|
||||||
|
- @tobiasge
|
||||||
|
|
||||||
|
## Stepping Down
|
||||||
|
|
||||||
|
Every maintainer is a volunteer and may step down as maintainer at any time without providing any reason.
|
||||||
|
To make this explicit, the maintainer is asked to update this file.
|
||||||
|
|
||||||
|
The last maintainer stepping down is asked to archive the project on GitHub to indicate that the project is no longer maintained.
|
||||||
|
|
||||||
|
## Signing up
|
||||||
|
|
||||||
|
Everyone is welcome to sign up as maintainer by creating a PR and add their own username to the list.
|
||||||
|
The current maintainers shall discuss the application.
|
||||||
|
They may turn down an application if they don't feel confident that the new maintainer is a positive addition.
|
71
PRINCIPALS.md
Normal file
71
PRINCIPALS.md
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
# Development, Maintenance and Community Principals for _NetBox Docker_
|
||||||
|
|
||||||
|
These principals shall guide the development and the maintenance of _NetBox Docker_.
|
||||||
|
|
||||||
|
## Basic principals
|
||||||
|
|
||||||
|
This project is maintained on voluntary basis.
|
||||||
|
Everyone is asked to respect that.
|
||||||
|
|
||||||
|
This means, that …
|
||||||
|
|
||||||
|
- … sometimes features are not implemented as fast as one might like -- or not at all.
|
||||||
|
- … sometimes nobody is looking at bugs, or they are not fixed as fast as one might like -- or not at all.
|
||||||
|
- … sometimes PRs are not reviewed for an extended period.
|
||||||
|
|
||||||
|
Everyone is welcome to provide improvements and bugfixes to the benefit of everyone else.
|
||||||
|
|
||||||
|
## Development Principals
|
||||||
|
|
||||||
|
The goal of the _NetBox Docker_ project is to provide a container to run the basic NetBox project.
|
||||||
|
The container should feel like a native container -- as if it were provided by NetBox itself:
|
||||||
|
|
||||||
|
- Configuration via environment variables where feasible.
|
||||||
|
- Except: Whenever a complex type such as a `dict` is required as value of a configuration setting,
|
||||||
|
then it shall not be provided through an environment variable.
|
||||||
|
- Configuration of secrets via secret files.
|
||||||
|
- Log output to standard out (STDOUT/`&1`) / standard error (STDERR/`&2`).
|
||||||
|
- Volumes for data and cache directories.
|
||||||
|
- Otherwise, no mounts shall be necessary.
|
||||||
|
- Runs a non-root user by default.
|
||||||
|
- One process / role for each instance.
|
||||||
|
|
||||||
|
The container generally does not provide more features than the basic NetBox project itself provides.
|
||||||
|
It may provide additional Python dependencies than the upstream project,
|
||||||
|
so that all configurable features of NetBox can be used in the container without further modification.
|
||||||
|
The container may provide helpers, so that it feels and behaves like a native container.
|
||||||
|
|
||||||
|
The container does not bundle any community plugins.
|
||||||
|
|
||||||
|
## Maintenance Principals
|
||||||
|
|
||||||
|
The main goals of maintaining _NetBox Docker_ are:
|
||||||
|
|
||||||
|
- Keeping the project at a high quality level.
|
||||||
|
- Keeping the maintenance effort minimal.
|
||||||
|
- Coordinating development efforts.
|
||||||
|
|
||||||
|
The following guidelines help us to achieve these goals:
|
||||||
|
|
||||||
|
- As many maintenance tasks as possible shall be automated or scripted.
|
||||||
|
- All manual tasks must be documented.
|
||||||
|
- All changes are reviewed by at least one maintainer.
|
||||||
|
- Changes of maintainers are reviewed by at least one other maintainer.
|
||||||
|
(Except if there's only one maintainer left.)
|
||||||
|
- The infrastructure beyond what GitHub provides shall be kept to a minimum.
|
||||||
|
- On request, every maintainer shall get access to infrastructure that is beyond GitHub
|
||||||
|
(at the time of writing that's _Docker Hub_ and _Quay_ in particular).
|
||||||
|
|
||||||
|
## Community Principals
|
||||||
|
|
||||||
|
This project is developed by the NetBox community for the NetBox community.
|
||||||
|
We welcome contributions, as long as they are in line with the principals above.
|
||||||
|
|
||||||
|
The maintainers of NetBox Docker are not the support team.
|
||||||
|
The community is expected to help each other out.
|
||||||
|
|
||||||
|
Always remember:
|
||||||
|
Behind every screen (or screen-reader) on the other end is a fellow human.
|
||||||
|
Be nice and respectful, thankful for help,
|
||||||
|
and value ideas and contributions,
|
||||||
|
even when they don't fit the goals.
|
74
README.md
74
README.md
@ -3,16 +3,21 @@
|
|||||||
[][github-release]
|
[][github-release]
|
||||||
[][github-stargazers]
|
[][github-stargazers]
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
[][netbox-docker-license]
|
[][netbox-docker-license]
|
||||||
|
|
||||||
[The GitHub repository][netbox-docker-github] houses the components needed to build NetBox as a container.
|
[The GitHub repository][netbox-docker-github] houses the components needed to build NetBox as a container.
|
||||||
Images are built regularly using the code in that repository and are pushed to [Docker Hub][netbox-dockerhub], [Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr].
|
Images are built regularly using the code in that repository
|
||||||
|
and are pushed to [Docker Hub][netbox-dockerhub],
|
||||||
|
[Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr].
|
||||||
|
_NetBox Docker_ is a project developed and maintained by the _NetBox_ community.
|
||||||
|
|
||||||
Do you have any questions?
|
Do you have any questions?
|
||||||
Before opening an issue on Github,
|
Before opening an issue on GitHub,
|
||||||
please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel.
|
please join [our Slack][netbox-docker-slack]
|
||||||
|
and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel,
|
||||||
|
or start a new [GitHub Discussion][github-discussions].
|
||||||
|
|
||||||
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
|
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
|
||||||
[github-release]: https://github.com/netbox-community/netbox-docker/releases
|
[github-release]: https://github.com/netbox-community/netbox-docker/releases
|
||||||
@ -24,6 +29,7 @@ please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-d
|
|||||||
[netbox-docker-slack-channel]: https://netdev-community.slack.com/archives/C01P0GEVBU7
|
[netbox-docker-slack-channel]: https://netdev-community.slack.com/archives/C01P0GEVBU7
|
||||||
[netbox-slack-channel]: https://netdev-community.slack.com/archives/C01P0FRSXRV
|
[netbox-slack-channel]: https://netdev-community.slack.com/archives/C01P0FRSXRV
|
||||||
[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
|
[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
|
||||||
|
[github-discussions]: https://github.com/netbox-community/netbox-docker/discussions
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
@ -34,25 +40,27 @@ There is a more complete [_Getting Started_ guide on our wiki][wiki-getting-star
|
|||||||
git clone -b release https://github.com/netbox-community/netbox-docker.git
|
git clone -b release https://github.com/netbox-community/netbox-docker.git
|
||||||
cd netbox-docker
|
cd netbox-docker
|
||||||
tee docker-compose.override.yml <<EOF
|
tee docker-compose.override.yml <<EOF
|
||||||
version: '3.4'
|
|
||||||
services:
|
services:
|
||||||
netbox:
|
netbox:
|
||||||
ports:
|
ports:
|
||||||
- 8000:8080
|
- 8000:8080
|
||||||
EOF
|
EOF
|
||||||
docker-compose pull
|
docker compose pull
|
||||||
docker-compose up
|
docker compose up
|
||||||
```
|
```
|
||||||
|
|
||||||
The whole application will be available after a few minutes.
|
The whole application will be available after a few minutes.
|
||||||
Open the URL `http://0.0.0.0:8000/` in a web-browser.
|
Open the URL `http://0.0.0.0:8000/` in a web-browser.
|
||||||
You should see the NetBox homepage.
|
You should see the NetBox homepage.
|
||||||
In the top-right corner you can login.
|
|
||||||
The default credentials are:
|
|
||||||
|
|
||||||
* Username: **admin**
|
To create the first admin user run this command:
|
||||||
* Password: **admin**
|
|
||||||
* API Token: **0123456789abcdef0123456789abcdef01234567**
|
```bash
|
||||||
|
docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
|
||||||
|
```
|
||||||
|
|
||||||
|
If you need to restart Netbox from an empty database often,
|
||||||
|
you can also set the `SUPERUSER_*` variables in your `docker-compose.override.yml`.
|
||||||
|
|
||||||
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
|
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
|
||||||
|
|
||||||
@ -62,42 +70,39 @@ New container images are built and published automatically every ~24h.
|
|||||||
|
|
||||||
> We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production!
|
> We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production!
|
||||||
|
|
||||||
* `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:
|
- `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:
|
||||||
These are release builds containing _NetBox version_ `vX.Y.Z`.
|
These are release builds containing _NetBox version_ `vX.Y.Z`.
|
||||||
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
||||||
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
||||||
These images are automatically built from [the corresponding releases of NetBox][netbox-releases].
|
These images are automatically built from [the corresponding releases of NetBox][netbox-releases].
|
||||||
* `latest-a.b.c`:
|
- `latest-a.b.c`:
|
||||||
These are release builds, containing the latest stable version of NetBox.
|
These are release builds, containing the latest stable version of NetBox.
|
||||||
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
||||||
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
||||||
These images are automatically built from [the `master` branch of NetBox][netbox-master].
|
- `snapshot-a.b.c`:
|
||||||
* `snapshot-a.b.c`:
|
|
||||||
These are prerelease builds.
|
These are prerelease builds.
|
||||||
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
||||||
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
||||||
These images are automatically built from the [`develop` branch of NetBox][netbox-develop].
|
These images are automatically built from the [`main` branch of NetBox][netbox-main].
|
||||||
|
|
||||||
For each of the above tag, there is an extra tag:
|
For each of the above tag, there is an extra tag:
|
||||||
|
|
||||||
* `vX.Y.Z`, `vX.Y`:
|
- `vX.Y.Z`, `vX.Y`:
|
||||||
This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).
|
This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).
|
||||||
It always points to the latest version of _NetBox Docker_.
|
- `latest`
|
||||||
* `latest`
|
|
||||||
This is the same version as `latest-a.b.c`.
|
This is the same version as `latest-a.b.c`.
|
||||||
It always points to the latest version of _NetBox Docker_.
|
It always points to the latest version of _NetBox Docker_.
|
||||||
* `snapshot`
|
- `snapshot`
|
||||||
This is the same version as `snapshot-a.b.c`.
|
This is the same version as `snapshot-a.b.c`.
|
||||||
It always points to the latest version of _NetBox Docker_.
|
It always points to the latest version of _NetBox Docker_.
|
||||||
|
|
||||||
[netbox-releases]: https://github.com/netbox-community/netbox/releases
|
[netbox-releases]: https://github.com/netbox-community/netbox/releases
|
||||||
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
|
[netbox-main]: https://github.com/netbox-community/netbox/tree/main
|
||||||
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Please refer [to our wiki on GitHub][netbox-docker-wiki] for further information on how to use the NetBox Docker image properly.
|
Please refer [to our wiki on GitHub][netbox-docker-wiki] for further information on how to use the NetBox Docker image properly.
|
||||||
The wiki covers advanced topics such as using files for secrets, configuring TLS, deployment to Kubernetes, monitoring and configuring NAPALM and LDAP.
|
The wiki covers advanced topics such as using files for secrets, configuring TLS, deployment to Kubernetes, monitoring and configuring LDAP.
|
||||||
|
|
||||||
Our wiki is a community effort.
|
Our wiki is a community effort.
|
||||||
Feel free to correct errors, update outdated information or provide additional guides and insights.
|
Feel free to correct errors, update outdated information or provide additional guides and insights.
|
||||||
@ -108,7 +113,7 @@ Feel free to correct errors, update outdated information or provide additional g
|
|||||||
|
|
||||||
Feel free to ask questions in our [GitHub Community][netbox-community]
|
Feel free to ask questions in our [GitHub Community][netbox-community]
|
||||||
or [join our Slack][netbox-docker-slack] and ask [in our channel `#netbox-docker`][netbox-docker-slack-channel],
|
or [join our Slack][netbox-docker-slack] and ask [in our channel `#netbox-docker`][netbox-docker-slack-channel],
|
||||||
which is free to use and where there are almost always people online that can help you in the Slack channel.
|
which is free to use and where there are almost always people online that can help you.
|
||||||
|
|
||||||
If you need help with using NetBox or developing for it or against it's API
|
If you need help with using NetBox or developing for it or against it's API
|
||||||
you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.
|
you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.
|
||||||
@ -119,16 +124,16 @@ you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack ins
|
|||||||
|
|
||||||
This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
|
This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
|
||||||
|
|
||||||
* The _Docker version_ must be at least `20.10.10`.
|
- The _Docker version_ must be at least `20.10.10`.
|
||||||
* The _containerd version_ must be at least `1.5.6`.
|
- The _containerd version_ must be at least `1.5.6`.
|
||||||
* The _docker-compose version_ must be at least `1.28.0`.
|
- The _docker-compose version_ must be at least `1.28.0`.
|
||||||
|
|
||||||
To check the version installed on your system run `docker --version` and `docker-compose --version`.
|
To check the version installed on your system run `docker --version` and `docker compose version`.
|
||||||
|
|
||||||
## Updating
|
## Updating
|
||||||
|
|
||||||
Please read [the release notes][releases] carefully when updating to a new image version.
|
Please read [the release notes][releases] carefully when updating to a new image version.
|
||||||
Note that the version of the NetBox Docker container image must stay in sync with the code.
|
Note that the version of the NetBox Docker container image must stay in sync with the version of the Git repository.
|
||||||
|
|
||||||
If you update for the first time, be sure [to follow our _How To Update NetBox Docker_ guide in the wiki][netbox-docker-wiki-updating].
|
If you update for the first time, be sure [to follow our _How To Update NetBox Docker_ guide in the wiki][netbox-docker-wiki-updating].
|
||||||
|
|
||||||
@ -137,7 +142,8 @@ If you update for the first time, be sure [to follow our _How To Update NetBox D
|
|||||||
|
|
||||||
## Rebuilding the Image
|
## Rebuilding the Image
|
||||||
|
|
||||||
`./build.sh` can be used to rebuild the container image. See `./build.sh --help` for more information.
|
`./build.sh` can be used to rebuild the container image.
|
||||||
|
See `./build.sh --help` for more information or `./build-latest.sh` for an example.
|
||||||
|
|
||||||
For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
|
For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
|
||||||
|
|
||||||
@ -146,13 +152,15 @@ For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
|
|||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
We have a test script.
|
We have a test script.
|
||||||
It runs NetBox's own unit tests and ensures that all initializers work:
|
It runs NetBox's own unit tests and ensures that NetBox starts:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
IMAGE=netboxcommunity/netbox:latest ./test.sh
|
IMAGE=docker.io/netboxcommunity/netbox:latest ./test.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
This repository is currently maintained by the community.
|
This repository is currently maintained by the community.
|
||||||
|
The community is expected to help each other.
|
||||||
|
|
||||||
Please consider sponsoring the maintainers of this project.
|
Please consider sponsoring the maintainers of this project.
|
||||||
|
5
actionlint.yml
Normal file
5
actionlint.yml
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
paths:
|
||||||
|
.github/workflows/**/*.{yml,yaml}:
|
||||||
|
ignore:
|
||||||
|
- ".*ubuntu-24.04-arm.*"
|
9
build-functions/check-commands.sh
Normal file
9
build-functions/check-commands.sh
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
NEEDED_COMMANDS="curl jq docker skopeo"
|
||||||
|
for c in $NEEDED_COMMANDS; do
|
||||||
|
if ! command -v "$c" &>/dev/null; then
|
||||||
|
echo "⚠️ '$c' is not installed. Can't proceed with build."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
@ -1,82 +1,18 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Retrieves image configuration from public images in DockerHub
|
|
||||||
# Functions from https://gist.github.com/cirocosta/17ea17be7ac11594cb0f290b0a3ac0d1
|
check_if_tags_exists() {
|
||||||
# Optimised for our use case
|
local image=$1
|
||||||
|
local tag=$2
|
||||||
|
skopeo list-tags "docker://$image" | jq -r ".Tags | contains([\"$tag\"])"
|
||||||
|
}
|
||||||
|
|
||||||
get_image_label() {
|
get_image_label() {
|
||||||
local label=$1
|
local label=$1
|
||||||
local image=$2
|
local image=$2
|
||||||
local tag=$3
|
skopeo inspect "docker://$image" | jq -r ".Labels[\"$label\"]"
|
||||||
local token
|
|
||||||
token=$(_get_token "$image")
|
|
||||||
local digest
|
|
||||||
digest=$(_get_digest "$image" "$tag" "$token")
|
|
||||||
local retval="null"
|
|
||||||
if [ "$digest" != "null" ]; then
|
|
||||||
retval=$(_get_image_configuration "$image" "$token" "$digest" "$label")
|
|
||||||
fi
|
|
||||||
echo "$retval"
|
|
||||||
}
|
|
||||||
|
|
||||||
get_image_layers() {
|
|
||||||
local image=$1
|
|
||||||
local tag=$2
|
|
||||||
local token
|
|
||||||
token=$(_get_token "$image")
|
|
||||||
_get_layers "$image" "$tag" "$token"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
get_image_last_layer() {
|
get_image_last_layer() {
|
||||||
local image=$1
|
local image=$1
|
||||||
local tag=$2
|
skopeo inspect "docker://$image" | jq -r ".Layers | last"
|
||||||
local token
|
|
||||||
token=$(_get_token "$image")
|
|
||||||
local layers
|
|
||||||
mapfile -t layers < <(_get_layers "$image" "$tag" "$token")
|
|
||||||
echo "${layers[-1]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
_get_image_configuration() {
|
|
||||||
local image=$1
|
|
||||||
local token=$2
|
|
||||||
local digest=$3
|
|
||||||
local label=$4
|
|
||||||
curl \
|
|
||||||
--silent \
|
|
||||||
--location \
|
|
||||||
--header "Authorization: Bearer $token" \
|
|
||||||
"https://registry-1.docker.io/v2/$image/blobs/$digest" |
|
|
||||||
jq -r ".config.Labels.\"$label\""
|
|
||||||
}
|
|
||||||
|
|
||||||
_get_token() {
|
|
||||||
local image=$1
|
|
||||||
curl \
|
|
||||||
--silent \
|
|
||||||
"https://auth.docker.io/token?scope=repository:$image:pull&service=registry.docker.io" |
|
|
||||||
jq -r '.token'
|
|
||||||
}
|
|
||||||
|
|
||||||
_get_digest() {
|
|
||||||
local image=$1
|
|
||||||
local tag=$2
|
|
||||||
local token=$3
|
|
||||||
curl \
|
|
||||||
--silent \
|
|
||||||
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
|
|
||||||
--header "Authorization: Bearer $token" \
|
|
||||||
"https://registry-1.docker.io/v2/$image/manifests/$tag" |
|
|
||||||
jq -r '.config.digest'
|
|
||||||
}
|
|
||||||
|
|
||||||
_get_layers() {
|
|
||||||
local image=$1
|
|
||||||
local tag=$2
|
|
||||||
local token=$3
|
|
||||||
curl \
|
|
||||||
--silent \
|
|
||||||
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
|
|
||||||
--header "Authorization: Bearer $token" \
|
|
||||||
"https://registry-1.docker.io/v2/$image/manifests/$tag" |
|
|
||||||
jq -r '.layers[].digest'
|
|
||||||
}
|
}
|
||||||
|
@ -19,3 +19,14 @@ gh_env() {
|
|||||||
echo "${@}" >>"${GITHUB_ENV}"
|
echo "${@}" >>"${GITHUB_ENV}"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
###
|
||||||
|
# Prints the output to the file defined in ${GITHUB_OUTPUT}.
|
||||||
|
# Only executes if ${GH_ACTION} is defined.
|
||||||
|
# Example Usage: gh_env "FOO_VAR=bar_value"
|
||||||
|
###
|
||||||
|
gh_out() {
|
||||||
|
if [ -n "${GH_ACTION}" ]; then
|
||||||
|
echo "${@}" >>"$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
@ -1,26 +1,27 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Builds the latest released version
|
# Builds the latest released version
|
||||||
|
|
||||||
|
# Check if we have everything needed for the build
|
||||||
|
source ./build-functions/check-commands.sh
|
||||||
|
|
||||||
|
source ./build-functions/gh-functions.sh
|
||||||
|
|
||||||
echo "▶️ $0 $*"
|
echo "▶️ $0 $*"
|
||||||
|
|
||||||
###
|
CURL_ARGS=(
|
||||||
# Check for the jq library needed for parsing JSON
|
--silent
|
||||||
###
|
)
|
||||||
if ! command -v jq; then
|
|
||||||
echo "⚠️ jq command missing from \$PATH!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
###
|
###
|
||||||
# Checking for the presence of GITHUB_OAUTH_CLIENT_ID
|
# Checking for the presence of GITHUB_TOKEN
|
||||||
# and GITHUB_OAUTH_CLIENT_SECRET
|
|
||||||
###
|
###
|
||||||
if [ -n "${GITHUB_OAUTH_CLIENT_ID}" ] && [ -n "${GITHUB_OAUTH_CLIENT_SECRET}" ]; then
|
if [ -n "${GITHUB_TOKEN}" ]; then
|
||||||
echo "🗝 Performing authenticated Github API calls."
|
echo "🗝 Performing authenticated Github API calls."
|
||||||
GITHUB_OAUTH_PARAMS="client_id=${GITHUB_OAUTH_CLIENT_ID}&client_secret=${GITHUB_OAUTH_CLIENT_SECRET}"
|
CURL_ARGS+=(
|
||||||
|
--header "Authorization: Bearer ${GITHUB_TOKEN}"
|
||||||
|
)
|
||||||
else
|
else
|
||||||
echo "🕶 Performing unauthenticated Github API calls. This might result in lower Github rate limits!"
|
echo "🕶 Performing unauthenticated Github API calls. This might result in lower Github rate limits!"
|
||||||
GITHUB_OAUTH_PARAMS=""
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
###
|
###
|
||||||
@ -42,31 +43,27 @@ fi
|
|||||||
###
|
###
|
||||||
ORIGINAL_GITHUB_REPO="netbox-community/netbox"
|
ORIGINAL_GITHUB_REPO="netbox-community/netbox"
|
||||||
GITHUB_REPO="${GITHUB_REPO-$ORIGINAL_GITHUB_REPO}"
|
GITHUB_REPO="${GITHUB_REPO-$ORIGINAL_GITHUB_REPO}"
|
||||||
URL_RELEASES="https://api.github.com/repos/${GITHUB_REPO}/releases?${GITHUB_OAUTH_PARAMS}"
|
URL_RELEASES="https://api.github.com/repos/${GITHUB_REPO}/releases"
|
||||||
|
|
||||||
# Composing the JQ commans to extract the most recent version number
|
# Composing the JQ commans to extract the most recent version number
|
||||||
JQ_LATEST="group_by(.prerelease) | .[] | sort_by(.published_at) | reverse | .[0] | select(.prerelease==${PRERELEASE-false}) | .tag_name"
|
JQ_LATEST="group_by(.prerelease) | .[] | sort_by(.published_at) | reverse | .[0] | select(.prerelease==${PRERELEASE-false}) | .tag_name"
|
||||||
|
|
||||||
CURL="curl -sS"
|
CURL="curl"
|
||||||
|
|
||||||
# Querying the Github API to fetch the most recent version number
|
# Querying the Github API to fetch the most recent version number
|
||||||
VERSION=$($CURL "${URL_RELEASES}" | jq -r "${JQ_LATEST}")
|
VERSION=$($CURL "${CURL_ARGS[@]}" "${URL_RELEASES}" | jq -r "${JQ_LATEST}" 2>/dev/null)
|
||||||
|
|
||||||
###
|
###
|
||||||
# Check if the prerelease version is actually higher than stable version
|
# Check if the prerelease version is actually higher than stable version
|
||||||
###
|
###
|
||||||
if [ "${PRERELEASE}" == "true" ]; then
|
if [ "${PRERELEASE}" == "true" ]; then
|
||||||
JQ_STABLE="group_by(.prerelease) | .[] | sort_by(.published_at) | reverse | .[0] | select(.prerelease==false) | .tag_name"
|
JQ_STABLE="group_by(.prerelease) | .[] | sort_by(.published_at) | reverse | .[0] | select(.prerelease==false) | .tag_name"
|
||||||
STABLE_VERSION=$($CURL "${URL_RELEASES}" | jq -r "${JQ_STABLE}")
|
STABLE_VERSION=$($CURL "${CURL_ARGS[@]}" "${URL_RELEASES}" | jq -r "${JQ_STABLE}" 2>/dev/null)
|
||||||
|
|
||||||
# shellcheck disable=SC2003
|
MAJOR_STABLE=$(expr "${STABLE_VERSION}" : 'v\([0-9]\+\)')
|
||||||
MAJOR_STABLE=$(expr match "${STABLE_VERSION}" 'v\([0-9]\+\)')
|
MINOR_STABLE=$(expr "${STABLE_VERSION}" : 'v[0-9]\+\.\([0-9]\+\)')
|
||||||
# shellcheck disable=SC2003
|
MAJOR_UNSTABLE=$(expr "${VERSION}" : 'v\([0-9]\+\)')
|
||||||
MINOR_STABLE=$(expr match "${STABLE_VERSION}" 'v[0-9]\+\.\([0-9]\+\)')
|
MINOR_UNSTABLE=$(expr "${VERSION}" : 'v[0-9]\+\.\([0-9]\+\)')
|
||||||
# shellcheck disable=SC2003
|
|
||||||
MAJOR_UNSTABLE=$(expr match "${VERSION}" 'v\([0-9]\+\)')
|
|
||||||
# shellcheck disable=SC2003
|
|
||||||
MINOR_UNSTABLE=$(expr match "${VERSION}" 'v[0-9]\+\.\([0-9]\+\)')
|
|
||||||
|
|
||||||
if {
|
if {
|
||||||
[ "${MAJOR_STABLE}" -eq "${MAJOR_UNSTABLE}" ] &&
|
[ "${MAJOR_STABLE}" -eq "${MAJOR_UNSTABLE}" ] &&
|
||||||
@ -75,10 +72,7 @@ if [ "${PRERELEASE}" == "true" ]; then
|
|||||||
|
|
||||||
echo "❎ Latest unstable version '${VERSION}' is not higher than the latest stable version '$STABLE_VERSION'."
|
echo "❎ Latest unstable version '${VERSION}' is not higher than the latest stable version '$STABLE_VERSION'."
|
||||||
if [ -z "$DEBUG" ]; then
|
if [ -z "$DEBUG" ]; then
|
||||||
if [ -n "${GH_ACTION}" ]; then
|
gh_out "skipped=true"
|
||||||
echo "::set-output name=skipped::true"
|
|
||||||
fi
|
|
||||||
|
|
||||||
exit 0
|
exit 0
|
||||||
else
|
else
|
||||||
echo "⚠️ Would exit here with code '0', but DEBUG is enabled."
|
echo "⚠️ Would exit here with code '0', but DEBUG is enabled."
|
||||||
|
88
build.sh
88
build.sh
@ -39,9 +39,8 @@ SKIP_GIT If defined, git is not invoked and \${NETBOX_PATH} will not be alter
|
|||||||
|
|
||||||
TAG The version part of the image tag.
|
TAG The version part of the image tag.
|
||||||
${_GREEN}Default:${_CLEAR}
|
${_GREEN}Default:${_CLEAR}
|
||||||
When <branch>=master: latest
|
When <branch>=main: snapshot
|
||||||
When <branch>=develop: snapshot
|
Else: same as <branch>
|
||||||
Else: same as <branch>
|
|
||||||
|
|
||||||
IMAGE_NAMES The names used for the image including the registry
|
IMAGE_NAMES The names used for the image including the registry
|
||||||
Used for tagging the image.
|
Used for tagging the image.
|
||||||
@ -61,7 +60,7 @@ DOCKERFILE The name of Dockerfile to use.
|
|||||||
${_GREEN}Default:${_CLEAR} Dockerfile
|
${_GREEN}Default:${_CLEAR} Dockerfile
|
||||||
|
|
||||||
DOCKER_FROM The base image to use.
|
DOCKER_FROM The base image to use.
|
||||||
${_GREEN}Default:${_CLEAR} 'ubuntu:22.04'
|
${_GREEN}Default:${_CLEAR} 'ubuntu:24.04'
|
||||||
|
|
||||||
BUILDX_PLATFORMS
|
BUILDX_PLATFORMS
|
||||||
Specifies the platform(s) to build the image for.
|
Specifies the platform(s) to build the image for.
|
||||||
@ -103,23 +102,22 @@ GH_ACTION If defined, special 'echo' statements are enabled that set the
|
|||||||
- FINAL_DOCKER_TAG: The final value of the DOCKER_TAG env variable
|
- FINAL_DOCKER_TAG: The final value of the DOCKER_TAG env variable
|
||||||
${_GREEN}Default:${_CLEAR} undefined
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
|
|
||||||
|
CHECK_ONLY Only checks if the build is needed and sets the GH Action output.
|
||||||
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
|
|
||||||
${_BOLD}Examples:${_CLEAR}
|
${_BOLD}Examples:${_CLEAR}
|
||||||
|
|
||||||
${0} master
|
${0} main
|
||||||
This will fetch the latest 'master' branch, build a Docker Image and tag it
|
This will fetch the latest 'main' branch, build a Docker Image and tag it
|
||||||
'netboxcommunity/netbox:latest'.
|
|
||||||
|
|
||||||
${0} develop
|
|
||||||
This will fetch the latest 'develop' branch, build a Docker Image and tag it
|
|
||||||
'netboxcommunity/netbox:snapshot'.
|
'netboxcommunity/netbox:snapshot'.
|
||||||
|
|
||||||
${0} v2.6.6
|
${0} v4.2.0
|
||||||
This will fetch the 'v2.6.6' tag, build a Docker Image and tag it
|
This will fetch the 'v4.2.0' tag, build a Docker Image and tag it
|
||||||
'netboxcommunity/netbox:v2.6.6' and 'netboxcommunity/netbox:v2.6'.
|
'netboxcommunity/netbox:v4.2.0' and 'netboxcommunity/netbox:v4.2'.
|
||||||
|
|
||||||
${0} develop-2.7
|
${0} feature
|
||||||
This will fetch the 'develop-2.7' branch, build a Docker Image and tag it
|
This will fetch the 'feature' branch, build a Docker Image and tag it
|
||||||
'netboxcommunity/netbox:develop-2.7'.
|
'netboxcommunity/netbox:feature'.
|
||||||
|
|
||||||
SRC_ORG=cimnine ${0} feature-x
|
SRC_ORG=cimnine ${0} feature-x
|
||||||
This will fetch the 'feature-x' branch from https://github.com/cimnine/netbox.git,
|
This will fetch the 'feature-x' branch from https://github.com/cimnine/netbox.git,
|
||||||
@ -137,6 +135,10 @@ END_OF_HELP
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Check if we have everything needed for the build
|
||||||
|
source ./build-functions/check-commands.sh
|
||||||
|
# Load all build functions
|
||||||
|
source ./build-functions/get-public-image-config.sh
|
||||||
source ./build-functions/gh-functions.sh
|
source ./build-functions/gh-functions.sh
|
||||||
|
|
||||||
IMAGE_NAMES="${IMAGE_NAMES-docker.io/netboxcommunity/netbox}"
|
IMAGE_NAMES="${IMAGE_NAMES-docker.io/netboxcommunity/netbox}"
|
||||||
@ -170,7 +172,7 @@ if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ]; then
|
|||||||
REMOTE_EXISTS=$(git ls-remote --heads --tags "${URL}" "${NETBOX_BRANCH}" | wc -l)
|
REMOTE_EXISTS=$(git ls-remote --heads --tags "${URL}" "${NETBOX_BRANCH}" | wc -l)
|
||||||
if [ "${REMOTE_EXISTS}" == "0" ]; then
|
if [ "${REMOTE_EXISTS}" == "0" ]; then
|
||||||
echo "❌ Remote branch '${NETBOX_BRANCH}' not found in '${URL}'; Nothing to do"
|
echo "❌ Remote branch '${NETBOX_BRANCH}' not found in '${URL}'; Nothing to do"
|
||||||
gh_echo "::set-output name=skipped::true"
|
gh_out "skipped=true"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
echo "🌐 Checking out '${NETBOX_BRANCH}' of NetBox from the url '${URL}' into '${NETBOX_PATH}'"
|
echo "🌐 Checking out '${NETBOX_BRANCH}' of NetBox from the url '${URL}' into '${NETBOX_PATH}'"
|
||||||
@ -215,7 +217,7 @@ fi
|
|||||||
# Determining the value for DOCKER_FROM
|
# Determining the value for DOCKER_FROM
|
||||||
###
|
###
|
||||||
if [ -z "$DOCKER_FROM" ]; then
|
if [ -z "$DOCKER_FROM" ]; then
|
||||||
DOCKER_FROM="ubuntu:22.04"
|
DOCKER_FROM="docker.io/ubuntu:24.04"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
###
|
###
|
||||||
@ -253,10 +255,7 @@ DOCKER_REGISTRY="${DOCKER_REGISTRY-docker.io}"
|
|||||||
DOCKER_ORG="${DOCKER_ORG-netboxcommunity}"
|
DOCKER_ORG="${DOCKER_ORG-netboxcommunity}"
|
||||||
DOCKER_REPO="${DOCKER_REPO-netbox}"
|
DOCKER_REPO="${DOCKER_REPO-netbox}"
|
||||||
case "${NETBOX_BRANCH}" in
|
case "${NETBOX_BRANCH}" in
|
||||||
master)
|
main)
|
||||||
TAG="${TAG-latest}"
|
|
||||||
;;
|
|
||||||
develop)
|
|
||||||
TAG="${TAG-snapshot}"
|
TAG="${TAG-snapshot}"
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
@ -272,7 +271,7 @@ TARGET_DOCKER_TAG_PROJECT="${TARGET_DOCKER_TAG}-${PROJECT_VERSION}"
|
|||||||
|
|
||||||
###
|
###
|
||||||
# composing the additional DOCKER_SHORT_TAG,
|
# composing the additional DOCKER_SHORT_TAG,
|
||||||
# i.e. "v2.6.1" becomes "v2.6",
|
# i.e. "v4.2.0" becomes "v4.2",
|
||||||
# which is only relevant for version tags
|
# which is only relevant for version tags
|
||||||
# Also let "latest" follow the highest version
|
# Also let "latest" follow the highest version
|
||||||
###
|
###
|
||||||
@ -300,39 +299,37 @@ if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
|
|||||||
done
|
done
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
FINAL_DOCKER_TAG="${IMAGE_NAME_TAGS[0]}"
|
||||||
gh_env "FINAL_DOCKER_TAG=${IMAGE_NAME_TAGS[0]}"
|
gh_env "FINAL_DOCKER_TAG=${IMAGE_NAME_TAGS[0]}"
|
||||||
|
|
||||||
###
|
###
|
||||||
# Checking if the build is necessary,
|
# Checking if the build is necessary,
|
||||||
# meaning build only if one of those values changed:
|
# meaning build only if one of those values changed:
|
||||||
|
# - a new tag is beeing created
|
||||||
# - base image digest
|
# - base image digest
|
||||||
# - netbox git ref (Label: netbox.git-ref)
|
# - netbox git ref (Label: netbox.git-ref)
|
||||||
# - netbox-docker git ref (Label: org.opencontainers.image.revision)
|
# - netbox-docker git ref (Label: org.opencontainers.image.revision)
|
||||||
###
|
###
|
||||||
# Load information from registry (only for docker.io)
|
# Load information from registry (only for first registry in "IMAGE_NAMES")
|
||||||
SHOULD_BUILD="false"
|
SHOULD_BUILD="false"
|
||||||
BUILD_REASON=""
|
BUILD_REASON=""
|
||||||
if [ -z "${GH_ACTION}" ]; then
|
if [ -z "${GH_ACTION}" ]; then
|
||||||
# Asuming non Github builds should always proceed
|
# Asuming non Github builds should always proceed
|
||||||
SHOULD_BUILD="true"
|
SHOULD_BUILD="true"
|
||||||
BUILD_REASON="${BUILD_REASON} interactive"
|
BUILD_REASON="${BUILD_REASON} interactive"
|
||||||
elif [[ "${IMAGE_NAME_TAGS[0]}" = docker.io* ]]; then
|
elif [ "false" == "$(check_if_tags_exists "${IMAGE_NAMES[0]}" "$TARGET_DOCKER_TAG")" ]; then
|
||||||
source ./build-functions/get-public-image-config.sh
|
SHOULD_BUILD="true"
|
||||||
IFS=':' read -ra DOCKER_FROM_SPLIT <<<"${DOCKER_FROM}"
|
BUILD_REASON="${BUILD_REASON} newtag"
|
||||||
if ! [[ ${DOCKER_FROM_SPLIT[0]} =~ .*/.* ]]; then
|
else
|
||||||
# Need to use "library/..." for images the have no two part name
|
echo "Checking labels for '${FINAL_DOCKER_TAG}'"
|
||||||
DOCKER_FROM_SPLIT[0]="library/${DOCKER_FROM_SPLIT[0]}"
|
BASE_LAST_LAYER=$(get_image_last_layer "${DOCKER_FROM}")
|
||||||
fi
|
OLD_BASE_LAST_LAYER=$(get_image_label netbox.last-base-image-layer "${FINAL_DOCKER_TAG}")
|
||||||
IFS='/' read -ra ORG_REPO <<<"${IMAGE_NAMES[0]}"
|
NETBOX_GIT_REF_OLD=$(get_image_label netbox.git-ref "${FINAL_DOCKER_TAG}")
|
||||||
echo "Checking labels for '${ORG_REPO[1]}' and '${ORG_REPO[2]}'"
|
GIT_REF_OLD=$(get_image_label org.opencontainers.image.revision "${FINAL_DOCKER_TAG}")
|
||||||
BASE_LAST_LAYER=$(get_image_last_layer "${DOCKER_FROM_SPLIT[0]}" "${DOCKER_FROM_SPLIT[1]}")
|
|
||||||
mapfile -t IMAGES_LAYERS_OLD < <(get_image_layers "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
|
|
||||||
NETBOX_GIT_REF_OLD=$(get_image_label netbox.git-ref "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
|
|
||||||
GIT_REF_OLD=$(get_image_label org.opencontainers.image.revision "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
|
|
||||||
|
|
||||||
if ! printf '%s\n' "${IMAGES_LAYERS_OLD[@]}" | grep -q -P "^${BASE_LAST_LAYER}\$"; then
|
if [ "${BASE_LAST_LAYER}" != "${OLD_BASE_LAST_LAYER}" ]; then
|
||||||
SHOULD_BUILD="true"
|
SHOULD_BUILD="true"
|
||||||
BUILD_REASON="${BUILD_REASON} debian"
|
BUILD_REASON="${BUILD_REASON} ubuntu"
|
||||||
fi
|
fi
|
||||||
if [ "${NETBOX_GIT_REF}" != "${NETBOX_GIT_REF_OLD}" ]; then
|
if [ "${NETBOX_GIT_REF}" != "${NETBOX_GIT_REF_OLD}" ]; then
|
||||||
SHOULD_BUILD="true"
|
SHOULD_BUILD="true"
|
||||||
@ -342,20 +339,22 @@ elif [[ "${IMAGE_NAME_TAGS[0]}" = docker.io* ]]; then
|
|||||||
SHOULD_BUILD="true"
|
SHOULD_BUILD="true"
|
||||||
BUILD_REASON="${BUILD_REASON} netbox-docker"
|
BUILD_REASON="${BUILD_REASON} netbox-docker"
|
||||||
fi
|
fi
|
||||||
else
|
|
||||||
SHOULD_BUILD="true"
|
|
||||||
BUILD_REASON="${BUILD_REASON} no-check"
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ "${SHOULD_BUILD}" != "true" ]; then
|
if [ "${SHOULD_BUILD}" != "true" ]; then
|
||||||
echo "Build skipped because sources didn't change"
|
echo "Build skipped because sources didn't change"
|
||||||
echo "::set-output name=skipped::true"
|
gh_out "skipped=true"
|
||||||
exit 0 # Nothing to do -> exit
|
exit 0 # Nothing to do -> exit
|
||||||
else
|
else
|
||||||
gh_echo "::set-output name=skipped::false"
|
gh_out "skipped=false"
|
||||||
fi
|
fi
|
||||||
gh_echo "::endgroup::"
|
gh_echo "::endgroup::"
|
||||||
|
|
||||||
|
if [ "${CHECK_ONLY}" = "true" ]; then
|
||||||
|
echo "Only check if build needed was requested. Exiting"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
###
|
###
|
||||||
# Build the image
|
# Build the image
|
||||||
###
|
###
|
||||||
@ -393,6 +392,7 @@ fi
|
|||||||
if [ -n "${BUILD_REASON}" ]; then
|
if [ -n "${BUILD_REASON}" ]; then
|
||||||
BUILD_REASON=$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' <<<"$BUILD_REASON")
|
BUILD_REASON=$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' <<<"$BUILD_REASON")
|
||||||
DOCKER_BUILD_ARGS+=(--label "netbox.build-reason=${BUILD_REASON}")
|
DOCKER_BUILD_ARGS+=(--label "netbox.build-reason=${BUILD_REASON}")
|
||||||
|
DOCKER_BUILD_ARGS+=(--label "netbox.last-base-image-layer=${BASE_LAST_LAYER}")
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# --build-arg
|
# --build-arg
|
||||||
|
@ -58,6 +58,9 @@ _BASE_DIR = dirname(dirname(abspath(__file__)))
|
|||||||
#
|
#
|
||||||
# Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local']
|
# Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local']
|
||||||
ALLOWED_HOSTS = environ.get('ALLOWED_HOSTS', '*').split(' ')
|
ALLOWED_HOSTS = environ.get('ALLOWED_HOSTS', '*').split(' ')
|
||||||
|
# ensure that '*' or 'localhost' is always in ALLOWED_HOSTS (needed for health checks)
|
||||||
|
if '*' not in ALLOWED_HOSTS and 'localhost' not in ALLOWED_HOSTS:
|
||||||
|
ALLOWED_HOSTS.append('localhost')
|
||||||
|
|
||||||
# PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
|
# PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
|
||||||
# https://docs.djangoproject.com/en/stable/ref/settings/#databases
|
# https://docs.djangoproject.com/en/stable/ref/settings/#databases
|
||||||
@ -83,6 +86,10 @@ REDIS = {
|
|||||||
'tasks': {
|
'tasks': {
|
||||||
'HOST': environ.get('REDIS_HOST', 'localhost'),
|
'HOST': environ.get('REDIS_HOST', 'localhost'),
|
||||||
'PORT': _environ_get_and_map('REDIS_PORT', 6379, _AS_INT),
|
'PORT': _environ_get_and_map('REDIS_PORT', 6379, _AS_INT),
|
||||||
|
'SENTINELS': [tuple(uri.split(':')) for uri in _environ_get_and_map('REDIS_SENTINELS', '', _AS_LIST) if uri != ''],
|
||||||
|
'SENTINEL_SERVICE': environ.get('REDIS_SENTINEL_SERVICE', 'default'),
|
||||||
|
'SENTINEL_TIMEOUT': _environ_get_and_map('REDIS_SENTINEL_TIMEOUT', 10, _AS_INT),
|
||||||
|
'USERNAME': environ.get('REDIS_USERNAME', ''),
|
||||||
'PASSWORD': _read_secret('redis_password', environ.get('REDIS_PASSWORD', '')),
|
'PASSWORD': _read_secret('redis_password', environ.get('REDIS_PASSWORD', '')),
|
||||||
'DATABASE': _environ_get_and_map('REDIS_DATABASE', 0, _AS_INT),
|
'DATABASE': _environ_get_and_map('REDIS_DATABASE', 0, _AS_INT),
|
||||||
'SSL': _environ_get_and_map('REDIS_SSL', 'False', _AS_BOOL),
|
'SSL': _environ_get_and_map('REDIS_SSL', 'False', _AS_BOOL),
|
||||||
@ -91,6 +98,9 @@ REDIS = {
|
|||||||
'caching': {
|
'caching': {
|
||||||
'HOST': environ.get('REDIS_CACHE_HOST', environ.get('REDIS_HOST', 'localhost')),
|
'HOST': environ.get('REDIS_CACHE_HOST', environ.get('REDIS_HOST', 'localhost')),
|
||||||
'PORT': _environ_get_and_map('REDIS_CACHE_PORT', environ.get('REDIS_PORT', '6379'), _AS_INT),
|
'PORT': _environ_get_and_map('REDIS_CACHE_PORT', environ.get('REDIS_PORT', '6379'), _AS_INT),
|
||||||
|
'SENTINELS': [tuple(uri.split(':')) for uri in _environ_get_and_map('REDIS_CACHE_SENTINELS', '', _AS_LIST) if uri != ''],
|
||||||
|
'SENTINEL_SERVICE': environ.get('REDIS_CACHE_SENTINEL_SERVICE', environ.get('REDIS_SENTINEL_SERVICE', 'default')),
|
||||||
|
'USERNAME': environ.get('REDIS_CACHE_USERNAME', environ.get('REDIS_USERNAME', '')),
|
||||||
'PASSWORD': _read_secret('redis_cache_password', environ.get('REDIS_CACHE_PASSWORD', environ.get('REDIS_PASSWORD', ''))),
|
'PASSWORD': _read_secret('redis_cache_password', environ.get('REDIS_CACHE_PASSWORD', environ.get('REDIS_PASSWORD', ''))),
|
||||||
'DATABASE': _environ_get_and_map('REDIS_CACHE_DATABASE', '1', _AS_INT),
|
'DATABASE': _environ_get_and_map('REDIS_CACHE_DATABASE', '1', _AS_INT),
|
||||||
'SSL': _environ_get_and_map('REDIS_CACHE_SSL', environ.get('REDIS_SSL', 'False'), _AS_BOOL),
|
'SSL': _environ_get_and_map('REDIS_CACHE_SSL', environ.get('REDIS_SSL', 'False'), _AS_BOOL),
|
||||||
@ -131,17 +141,16 @@ if 'BANNER_BOTTOM' in environ:
|
|||||||
if 'BANNER_LOGIN' in environ:
|
if 'BANNER_LOGIN' in environ:
|
||||||
BANNER_LOGIN = environ.get('BANNER_LOGIN', None)
|
BANNER_LOGIN = environ.get('BANNER_LOGIN', None)
|
||||||
|
|
||||||
# Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
|
|
||||||
# BASE_PATH = 'netbox/'
|
|
||||||
BASE_PATH = environ.get('BASE_PATH', '')
|
|
||||||
|
|
||||||
# Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90)
|
# Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90)
|
||||||
if 'CHANGELOG_RETENTION' in environ:
|
if 'CHANGELOG_RETENTION' in environ:
|
||||||
CHANGELOG_RETENTION = _environ_get_and_map('CHANGELOG_RETENTION', None, _AS_INT)
|
CHANGELOG_RETENTION = _environ_get_and_map('CHANGELOG_RETENTION', None, _AS_INT)
|
||||||
|
|
||||||
# Maximum number of days to retain job results (scripts and reports). Set to 0 to retain job results in the database indefinitely. (Default: 90)
|
# Maximum number of days to retain job results (scripts and reports). Set to 0 to retain job results in the database indefinitely. (Default: 90)
|
||||||
if 'JOBRESULT_RETENTION' in environ:
|
if 'JOB_RETENTION' in environ:
|
||||||
JOBRESULT_RETENTION = _environ_get_and_map('JOBRESULT_RETENTION', None, _AS_INT)
|
JOB_RETENTION = _environ_get_and_map('JOB_RETENTION', None, _AS_INT)
|
||||||
|
# JOBRESULT_RETENTION was renamed to JOB_RETENTION in the v3.5.0 release of NetBox. For backwards compatibility, map JOBRESULT_RETENTION to JOB_RETENTION
|
||||||
|
elif 'JOBRESULT_RETENTION' in environ:
|
||||||
|
JOB_RETENTION = _environ_get_and_map('JOBRESULT_RETENTION', None, _AS_INT)
|
||||||
|
|
||||||
# API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be
|
# API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be
|
||||||
# allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or
|
# allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or
|
||||||
@ -179,15 +188,22 @@ EMAIL = {
|
|||||||
if 'ENFORCE_GLOBAL_UNIQUE' in environ:
|
if 'ENFORCE_GLOBAL_UNIQUE' in environ:
|
||||||
ENFORCE_GLOBAL_UNIQUE = _environ_get_and_map('ENFORCE_GLOBAL_UNIQUE', None, _AS_BOOL)
|
ENFORCE_GLOBAL_UNIQUE = _environ_get_and_map('ENFORCE_GLOBAL_UNIQUE', None, _AS_BOOL)
|
||||||
|
|
||||||
|
# By default, netbox sends census reporting data using a single HTTP request each time a worker starts.
|
||||||
|
# This data enables the project maintainers to estimate how many NetBox deployments exist and track the adoption of new versions over time.
|
||||||
|
# The only data reported by this function are the NetBox version, Python version, and a pseudorandom unique identifier.
|
||||||
|
# To opt out of census reporting, set CENSUS_REPORTING_ENABLED to False.
|
||||||
|
if 'CENSUS_REPORTING_ENABLED' in environ:
|
||||||
|
CENSUS_REPORTING_ENABLED = _environ_get_and_map('CENSUS_REPORTING_ENABLED', None, _AS_BOOL)
|
||||||
|
|
||||||
# Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and
|
# Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and
|
||||||
# by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models.
|
# by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models.
|
||||||
EXEMPT_VIEW_PERMISSIONS = _environ_get_and_map('EXEMPT_VIEW_PERMISSIONS', '', _AS_LIST)
|
EXEMPT_VIEW_PERMISSIONS = _environ_get_and_map('EXEMPT_VIEW_PERMISSIONS', '', _AS_LIST)
|
||||||
|
|
||||||
# HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks).
|
# HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks).
|
||||||
# HTTP_PROXIES = {
|
HTTP_PROXIES = {
|
||||||
# 'http': 'http://10.10.1.10:3128',
|
'http': environ.get('HTTP_PROXY', None),
|
||||||
# 'https': 'http://10.10.1.10:1080',
|
'https': environ.get('HTTPS_PROXY', None),
|
||||||
# }
|
}
|
||||||
|
|
||||||
# IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing
|
# IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing
|
||||||
# NetBox from an internal IP.
|
# NetBox from an internal IP.
|
||||||
@ -205,9 +221,9 @@ if 'GRAPHQL_ENABLED' in environ:
|
|||||||
# authenticated to NetBox indefinitely.
|
# authenticated to NetBox indefinitely.
|
||||||
LOGIN_PERSISTENCE = _environ_get_and_map('LOGIN_PERSISTENCE', 'False', _AS_BOOL)
|
LOGIN_PERSISTENCE = _environ_get_and_map('LOGIN_PERSISTENCE', 'False', _AS_BOOL)
|
||||||
|
|
||||||
# Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users
|
# When enabled, only authenticated users are permitted to access any part of NetBox.
|
||||||
# are permitted to access most data in NetBox (excluding secrets) but not make any changes.
|
# Disabling this will allow unauthenticated users to access most areas of NetBox (but not make any changes).
|
||||||
LOGIN_REQUIRED = _environ_get_and_map('LOGIN_REQUIRED', 'False', _AS_BOOL)
|
LOGIN_REQUIRED = _environ_get_and_map('LOGIN_REQUIRED', 'True', _AS_BOOL)
|
||||||
|
|
||||||
# The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to
|
# The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to
|
||||||
# re-authenticate. (Default: 1209600 [14 days])
|
# re-authenticate. (Default: 1209600 [14 days])
|
||||||
@ -234,20 +250,6 @@ MEDIA_ROOT = environ.get('MEDIA_ROOT', join(_BASE_DIR, 'media'))
|
|||||||
# Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics'
|
# Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics'
|
||||||
METRICS_ENABLED = _environ_get_and_map('METRICS_ENABLED', 'False', _AS_BOOL)
|
METRICS_ENABLED = _environ_get_and_map('METRICS_ENABLED', 'False', _AS_BOOL)
|
||||||
|
|
||||||
# Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM.
|
|
||||||
if 'NAPALM_USERNAME' in environ:
|
|
||||||
NAPALM_USERNAME = environ.get('NAPALM_USERNAME', None)
|
|
||||||
if 'NAPALM_PASSWORD' in environ:
|
|
||||||
NAPALM_PASSWORD = _read_secret('napalm_password', environ.get('NAPALM_PASSWORD', None))
|
|
||||||
|
|
||||||
# NAPALM timeout (in seconds). (Default: 30)
|
|
||||||
if 'NAPALM_TIMEOUT' in environ:
|
|
||||||
NAPALM_TIMEOUT = _environ_get_and_map('NAPALM_TIMEOUT', None, _AS_INT)
|
|
||||||
|
|
||||||
# # NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
|
|
||||||
# # be provided as a dictionary.
|
|
||||||
# NAPALM_ARGS = None
|
|
||||||
|
|
||||||
# Determine how many objects to display per page within a list. (Default: 50)
|
# Determine how many objects to display per page within a list. (Default: 50)
|
||||||
if 'PAGINATE_COUNT' in environ:
|
if 'PAGINATE_COUNT' in environ:
|
||||||
PAGINATE_COUNT = _environ_get_and_map('PAGINATE_COUNT', None, _AS_INT)
|
PAGINATE_COUNT = _environ_get_and_map('PAGINATE_COUNT', None, _AS_INT)
|
||||||
@ -284,29 +286,32 @@ if 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH' in environ:
|
|||||||
RACK_ELEVATION_DEFAULT_UNIT_WIDTH = _environ_get_and_map('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', None, _AS_INT)
|
RACK_ELEVATION_DEFAULT_UNIT_WIDTH = _environ_get_and_map('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', None, _AS_INT)
|
||||||
|
|
||||||
# Remote authentication support
|
# Remote authentication support
|
||||||
REMOTE_AUTH_ENABLED = _environ_get_and_map('REMOTE_AUTH_ENABLED', 'False', _AS_BOOL)
|
REMOTE_AUTH_AUTO_CREATE_GROUPS = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_GROUPS', 'False', _AS_BOOL)
|
||||||
REMOTE_AUTH_BACKEND = environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend')
|
REMOTE_AUTH_AUTO_CREATE_USER = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_USER', 'False', _AS_BOOL)
|
||||||
REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
|
REMOTE_AUTH_BACKEND = _environ_get_and_map('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend', _AS_LIST)
|
||||||
REMOTE_AUTH_AUTO_CREATE_USER = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_USER', 'True', _AS_BOOL)
|
|
||||||
REMOTE_AUTH_DEFAULT_GROUPS = _environ_get_and_map('REMOTE_AUTH_DEFAULT_GROUPS', '', _AS_LIST)
|
REMOTE_AUTH_DEFAULT_GROUPS = _environ_get_and_map('REMOTE_AUTH_DEFAULT_GROUPS', '', _AS_LIST)
|
||||||
# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
|
# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} # dicts can't be configured via environment variables. See extra.py instead.
|
||||||
|
REMOTE_AUTH_ENABLED = _environ_get_and_map('REMOTE_AUTH_ENABLED', 'False', _AS_BOOL)
|
||||||
|
REMOTE_AUTH_GROUP_HEADER = _environ_get_and_map('REMOTE_AUTH_GROUP_HEADER', 'HTTP_REMOTE_USER_GROUP')
|
||||||
|
REMOTE_AUTH_GROUP_SEPARATOR = _environ_get_and_map('REMOTE_AUTH_GROUP_SEPARATOR', '|')
|
||||||
|
REMOTE_AUTH_GROUP_SYNC_ENABLED = _environ_get_and_map('REMOTE_AUTH_GROUP_SYNC_ENABLED', 'False', _AS_BOOL)
|
||||||
|
REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
|
||||||
|
REMOTE_AUTH_USER_EMAIL = environ.get('REMOTE_AUTH_USER_EMAIL', 'HTTP_REMOTE_USER_EMAIL')
|
||||||
|
REMOTE_AUTH_USER_FIRST_NAME = environ.get('REMOTE_AUTH_USER_FIRST_NAME', 'HTTP_REMOTE_USER_FIRST_NAME')
|
||||||
|
REMOTE_AUTH_USER_LAST_NAME = environ.get('REMOTE_AUTH_USER_LAST_NAME', 'HTTP_REMOTE_USER_LAST_NAME')
|
||||||
|
REMOTE_AUTH_SUPERUSER_GROUPS = _environ_get_and_map('REMOTE_AUTH_SUPERUSER_GROUPS', '', _AS_LIST)
|
||||||
|
REMOTE_AUTH_SUPERUSERS = _environ_get_and_map('REMOTE_AUTH_SUPERUSERS', '', _AS_LIST)
|
||||||
|
REMOTE_AUTH_STAFF_GROUPS = _environ_get_and_map('REMOTE_AUTH_STAFF_GROUPS', '', _AS_LIST)
|
||||||
|
REMOTE_AUTH_STAFF_USERS = _environ_get_and_map('REMOTE_AUTH_STAFF_USERS', '', _AS_LIST)
|
||||||
|
|
||||||
# This repository is used to check whether there is a new release of NetBox available. Set to None to disable the
|
# This repository is used to check whether there is a new release of NetBox available. Set to None to disable the
|
||||||
# version check or use the URL below to check for release in the official NetBox repository.
|
# version check or use the URL below to check for release in the official NetBox repository.
|
||||||
RELEASE_CHECK_URL = environ.get('RELEASE_CHECK_URL', None)
|
RELEASE_CHECK_URL = environ.get('RELEASE_CHECK_URL', None)
|
||||||
# RELEASE_CHECK_URL = 'https://api.github.com/repos/netbox-community/netbox/releases'
|
# RELEASE_CHECK_URL = 'https://api.github.com/repos/netbox-community/netbox/releases'
|
||||||
|
|
||||||
# The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of
|
|
||||||
# this setting is derived from the installed location.
|
|
||||||
REPORTS_ROOT = environ.get('REPORTS_ROOT', '/etc/netbox/reports')
|
|
||||||
|
|
||||||
# Maximum execution time for background tasks, in seconds.
|
# Maximum execution time for background tasks, in seconds.
|
||||||
RQ_DEFAULT_TIMEOUT = _environ_get_and_map('RQ_DEFAULT_TIMEOUT', 300, _AS_INT)
|
RQ_DEFAULT_TIMEOUT = _environ_get_and_map('RQ_DEFAULT_TIMEOUT', 300, _AS_INT)
|
||||||
|
|
||||||
# The file path where custom scripts will be stored. A trailing slash is not needed. Note that the default value of
|
|
||||||
# this setting is derived from the installed location.
|
|
||||||
SCRIPTS_ROOT = environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts')
|
|
||||||
|
|
||||||
# The name to use for the csrf token cookie.
|
# The name to use for the csrf token cookie.
|
||||||
CSRF_COOKIE_NAME = environ.get('CSRF_COOKIE_NAME', 'csrftoken')
|
CSRF_COOKIE_NAME = environ.get('CSRF_COOKIE_NAME', 'csrftoken')
|
||||||
|
|
||||||
@ -318,6 +323,23 @@ CSRF_TRUSTED_ORIGINS = _environ_get_and_map('CSRF_TRUSTED_ORIGINS', '', _AS_LIST
|
|||||||
# The name to use for the session cookie.
|
# The name to use for the session cookie.
|
||||||
SESSION_COOKIE_NAME = environ.get('SESSION_COOKIE_NAME', 'sessionid')
|
SESSION_COOKIE_NAME = environ.get('SESSION_COOKIE_NAME', 'sessionid')
|
||||||
|
|
||||||
|
# If true, the `includeSubDomains` directive will be included in the HTTP Strict Transport Security (HSTS) header.
|
||||||
|
# This directive instructs the browser to apply the HSTS policy to all subdomains of the current domain.
|
||||||
|
SECURE_HSTS_INCLUDE_SUBDOMAINS = _environ_get_and_map('SECURE_HSTS_INCLUDE_SUBDOMAINS', 'False', _AS_BOOL)
|
||||||
|
|
||||||
|
# If true, the `preload` directive will be included in the HTTP Strict Transport Security (HSTS) header.
|
||||||
|
# This directive instructs the browser to preload the site in HTTPS. Browsers that use the HSTS preload list will force the
|
||||||
|
# site to be accessed via HTTPS even if the user types HTTP in the address bar.
|
||||||
|
SECURE_HSTS_PRELOAD = _environ_get_and_map('SECURE_HSTS_PRELOAD', 'False', _AS_BOOL)
|
||||||
|
|
||||||
|
# If set to a non-zero integer value, the SecurityMiddleware sets the HTTP Strict Transport Security (HSTS) header on all
|
||||||
|
# responses that do not already have it. This will instruct the browser that the website must be accessed via HTTPS,
|
||||||
|
# blocking any HTTP request.
|
||||||
|
SECURE_HSTS_SECONDS = _environ_get_and_map('SECURE_HSTS_SECONDS', 0, _AS_INT)
|
||||||
|
|
||||||
|
# If true, all non-HTTPS requests will be automatically redirected to use HTTPS.
|
||||||
|
SECURE_SSL_REDIRECT = _environ_get_and_map('SECURE_SSL_REDIRECT', 'False', _AS_BOOL)
|
||||||
|
|
||||||
# By default, NetBox will store session data in the database. Alternatively, a file path can be specified here to use
|
# By default, NetBox will store session data in the database. Alternatively, a file path can be specified here to use
|
||||||
# local file storage instead. (This can be useful for enabling authentication on a standby instance with read-only
|
# local file storage instead. (This can be useful for enabling authentication on a standby instance with read-only
|
||||||
# database access.) Note that the user as which NetBox runs must have read and write permissions to this path.
|
# database access.) Note that the user as which NetBox runs must have read and write permissions to this path.
|
||||||
@ -326,11 +348,5 @@ SESSION_FILE_PATH = environ.get('SESSION_FILE_PATH', environ.get('SESSIONS_ROOT'
|
|||||||
# Time zone (default: UTC)
|
# Time zone (default: UTC)
|
||||||
TIME_ZONE = environ.get('TIME_ZONE', 'UTC')
|
TIME_ZONE = environ.get('TIME_ZONE', 'UTC')
|
||||||
|
|
||||||
# Date/time formatting. See the following link for supported formats:
|
# If true disables miscellaneous functionality which depends on access to the Internet.
|
||||||
# https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date
|
ISOLATED_DEPLOYMENT = _environ_get_and_map('ISOLATED_DEPLOYMENT', 'False', _AS_BOOL)
|
||||||
DATE_FORMAT = environ.get('DATE_FORMAT', 'N j, Y')
|
|
||||||
SHORT_DATE_FORMAT = environ.get('SHORT_DATE_FORMAT', 'Y-m-d')
|
|
||||||
TIME_FORMAT = environ.get('TIME_FORMAT', 'g:i a')
|
|
||||||
SHORT_TIME_FORMAT = environ.get('SHORT_TIME_FORMAT', 'H:i:s')
|
|
||||||
DATETIME_FORMAT = environ.get('DATETIME_FORMAT', 'N j, Y g:i a')
|
|
||||||
SHORT_DATETIME_FORMAT = environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i')
|
|
||||||
|
@ -15,12 +15,6 @@
|
|||||||
# 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
|
# 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
|
||||||
# )
|
# )
|
||||||
|
|
||||||
|
|
||||||
## NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
|
|
||||||
## be provided as a dictionary.
|
|
||||||
# NAPALM_ARGS = {}
|
|
||||||
|
|
||||||
|
|
||||||
## Enable installed plugins. Add the name of each plugin to the list.
|
## Enable installed plugins. Add the name of each plugin to the list.
|
||||||
# from netbox.configuration.configuration import PLUGINS
|
# from netbox.configuration.configuration import PLUGINS
|
||||||
# PLUGINS.append('my_plugin')
|
# PLUGINS.append('my_plugin')
|
||||||
|
@ -49,20 +49,38 @@ AUTH_LDAP_START_TLS = environ.get('AUTH_LDAP_START_TLS', 'False').lower() == 'tr
|
|||||||
# ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
|
# ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
|
||||||
LDAP_IGNORE_CERT_ERRORS = environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true'
|
LDAP_IGNORE_CERT_ERRORS = environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true'
|
||||||
|
|
||||||
|
# Include this setting if you want to validate the LDAP server certificates against a CA certificate directory on your server
|
||||||
|
# Note that this is a NetBox-specific setting which sets:
|
||||||
|
# ldap.set_option(ldap.OPT_X_TLS_CACERTDIR, LDAP_CA_CERT_DIR)
|
||||||
|
LDAP_CA_CERT_DIR = environ.get('LDAP_CA_CERT_DIR', None)
|
||||||
|
|
||||||
|
# Include this setting if you want to validate the LDAP server certificates against your own CA.
|
||||||
|
# Note that this is a NetBox-specific setting which sets:
|
||||||
|
# ldap.set_option(ldap.OPT_X_TLS_CACERTFILE, LDAP_CA_CERT_FILE)
|
||||||
|
LDAP_CA_CERT_FILE = environ.get('LDAP_CA_CERT_FILE', None)
|
||||||
|
|
||||||
AUTH_LDAP_USER_SEARCH_BASEDN = environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '')
|
AUTH_LDAP_USER_SEARCH_BASEDN = environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '')
|
||||||
AUTH_LDAP_USER_SEARCH_ATTR = environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName')
|
AUTH_LDAP_USER_SEARCH_ATTR = environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName')
|
||||||
|
AUTH_LDAP_USER_SEARCH_FILTER: str = environ.get(
|
||||||
|
'AUTH_LDAP_USER_SEARCH_FILTER', f'({AUTH_LDAP_USER_SEARCH_ATTR}=%(user)s)'
|
||||||
|
)
|
||||||
|
|
||||||
AUTH_LDAP_USER_SEARCH = LDAPSearch(
|
AUTH_LDAP_USER_SEARCH = LDAPSearch(
|
||||||
AUTH_LDAP_USER_SEARCH_BASEDN,
|
AUTH_LDAP_USER_SEARCH_BASEDN, ldap.SCOPE_SUBTREE, AUTH_LDAP_USER_SEARCH_FILTER
|
||||||
ldap.SCOPE_SUBTREE,
|
|
||||||
"(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
|
# This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
|
||||||
# heirarchy.
|
# heirarchy.
|
||||||
|
|
||||||
AUTH_LDAP_GROUP_SEARCH_BASEDN = environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '')
|
AUTH_LDAP_GROUP_SEARCH_BASEDN = environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '')
|
||||||
AUTH_LDAP_GROUP_SEARCH_CLASS = environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group')
|
AUTH_LDAP_GROUP_SEARCH_CLASS = environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group')
|
||||||
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_SEARCH_BASEDN, ldap.SCOPE_SUBTREE,
|
|
||||||
"(objectClass=" + AUTH_LDAP_GROUP_SEARCH_CLASS + ")")
|
AUTH_LDAP_GROUP_SEARCH_FILTER: str = environ.get(
|
||||||
|
'AUTH_LDAP_GROUP_SEARCH_FILTER', f'(objectclass={AUTH_LDAP_GROUP_SEARCH_CLASS})'
|
||||||
|
)
|
||||||
|
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(
|
||||||
|
AUTH_LDAP_GROUP_SEARCH_BASEDN, ldap.SCOPE_SUBTREE, AUTH_LDAP_GROUP_SEARCH_FILTER
|
||||||
|
)
|
||||||
AUTH_LDAP_GROUP_TYPE = _import_group_type(environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType'))
|
AUTH_LDAP_GROUP_TYPE = _import_group_type(environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType'))
|
||||||
|
|
||||||
# Define a group required to login.
|
# Define a group required to login.
|
||||||
|
@ -1,5 +1,22 @@
|
|||||||
version: '3.4'
|
|
||||||
services:
|
services:
|
||||||
netbox:
|
netbox:
|
||||||
ports:
|
ports:
|
||||||
- 8000:8080
|
- "8000:8080"
|
||||||
|
# If you want the Nginx unit status page visible from the
|
||||||
|
# outside of the container add the following port mapping:
|
||||||
|
# - "8001:8081"
|
||||||
|
# healthcheck:
|
||||||
|
# Time for which the health check can fail after the container is started.
|
||||||
|
# This depends mostly on the performance of your database. On the first start,
|
||||||
|
# when all tables need to be created the start_period should be higher than on
|
||||||
|
# subsequent starts. For the first start after major version upgrades of NetBox
|
||||||
|
# the start_period might also need to be set higher.
|
||||||
|
# Default value in our docker-compose.yml is 60s
|
||||||
|
# start_period: 90s
|
||||||
|
# environment:
|
||||||
|
# SKIP_SUPERUSER: "false"
|
||||||
|
# SUPERUSER_API_TOKEN: ""
|
||||||
|
# SUPERUSER_EMAIL: ""
|
||||||
|
# SUPERUSER_NAME: ""
|
||||||
|
# SUPERUSER_PASSWORD: ""
|
||||||
|
|
||||||
|
5
docker-compose.test.override.yml
Normal file
5
docker-compose.test.override.yml
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
services:
|
||||||
|
netbox:
|
||||||
|
ports:
|
||||||
|
- "127.0.0.1:8000:8080"
|
||||||
|
|
@ -1,38 +1,70 @@
|
|||||||
version: '3.4'
|
|
||||||
services:
|
services:
|
||||||
netbox:
|
netbox: &netbox
|
||||||
image: ${IMAGE-netboxcommunity/netbox:latest}
|
image: ${IMAGE-docker.io/netboxcommunity/netbox:latest}
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgres
|
postgres:
|
||||||
- redis
|
condition: service_healthy
|
||||||
- redis-cache
|
redis:
|
||||||
|
condition: service_healthy
|
||||||
|
redis-cache:
|
||||||
|
condition: service_healthy
|
||||||
env_file: env/netbox.env
|
env_file: env/netbox.env
|
||||||
environment:
|
user: "unit:root"
|
||||||
SKIP_STARTUP_SCRIPTS: ${SKIP_STARTUP_SCRIPTS-false}
|
|
||||||
user: 'unit:root'
|
|
||||||
volumes:
|
volumes:
|
||||||
- ./configuration:/etc/netbox/config:z,ro
|
- ./test-configuration/test_config.py:/etc/netbox/config/test_config.py:z,ro
|
||||||
- ./test-configuration/logging.py:/etc/netbox/config/logging.py:z,ro
|
healthcheck:
|
||||||
- ./reports:/etc/netbox/reports:z,ro
|
test: curl -f http://localhost:8080/login/ || exit 1
|
||||||
- ./scripts:/etc/netbox/scripts:z,ro
|
start_period: ${NETBOX_START_PERIOD-120s}
|
||||||
- netbox-media-files:/opt/netbox/netbox/media:z
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
netbox-worker:
|
||||||
|
<<: *netbox
|
||||||
|
command:
|
||||||
|
- /opt/netbox/venv/bin/python
|
||||||
|
- /opt/netbox/netbox/manage.py
|
||||||
|
- rqworker
|
||||||
|
healthcheck:
|
||||||
|
test: ps -aux | grep -v grep | grep -q rqworker || exit 1
|
||||||
|
start_period: 40s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
netbox-housekeeping:
|
||||||
|
<<: *netbox
|
||||||
|
command:
|
||||||
|
- /opt/netbox/housekeeping.sh
|
||||||
|
healthcheck:
|
||||||
|
test: ps -aux | grep -v grep | grep -q housekeeping || exit 1
|
||||||
|
start_period: 40s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
|
||||||
postgres:
|
postgres:
|
||||||
image: postgres:14-alpine
|
image: docker.io/postgres:17-alpine
|
||||||
env_file: env/postgres.env
|
env_file: env/postgres.env
|
||||||
redis:
|
healthcheck:
|
||||||
image: redis:7-alpine
|
test: pg_isready -q -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER ## $$ because of docker-compose
|
||||||
|
start_period: 20s
|
||||||
|
interval: 1s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 5
|
||||||
|
|
||||||
|
redis: &redis
|
||||||
|
image: docker.io/valkey/valkey:8.1-alpine
|
||||||
command:
|
command:
|
||||||
- sh
|
- sh
|
||||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||||
- redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
- valkey-server --save "" --appendonly no --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
||||||
env_file: env/redis.env
|
env_file: env/redis.env
|
||||||
|
healthcheck:
|
||||||
|
test: '[ $$(valkey-cli --pass "$${REDIS_PASSWORD}" ping) = ''PONG'' ]'
|
||||||
|
start_period: 5s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 1s
|
||||||
|
retries: 5
|
||||||
redis-cache:
|
redis-cache:
|
||||||
image: redis:7-alpine
|
<<: *redis
|
||||||
command:
|
|
||||||
- sh
|
|
||||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
|
||||||
- redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
|
||||||
env_file: env/redis-cache.env
|
env_file: env/redis-cache.env
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
netbox-media-files:
|
netbox-media-files:
|
||||||
driver: local
|
driver: local
|
||||||
|
@ -1,69 +1,83 @@
|
|||||||
version: '3.4'
|
|
||||||
services:
|
services:
|
||||||
netbox: &netbox
|
netbox: &netbox
|
||||||
image: netboxcommunity/netbox:${VERSION-v3.3-2.3.0}
|
image: docker.io/netboxcommunity/netbox:${VERSION-v4.3-3.3.0}
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgres
|
- redis
|
||||||
- redis
|
- redis-cache
|
||||||
- redis-cache
|
|
||||||
- netbox-worker
|
|
||||||
env_file: env/netbox.env
|
env_file: env/netbox.env
|
||||||
user: 'unit:root'
|
user: "unit:root"
|
||||||
|
healthcheck:
|
||||||
|
test: curl -f http://localhost:8080/login/ || exit 1
|
||||||
|
start_period: 90s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
volumes:
|
volumes:
|
||||||
- ./configuration:/etc/netbox/config:z,ro
|
- ./configuration:/etc/netbox/config:z,ro
|
||||||
- ./reports:/etc/netbox/reports:z,ro
|
- netbox-media-files:/opt/netbox/netbox/media:rw
|
||||||
- ./scripts:/etc/netbox/scripts:z,ro
|
- netbox-reports-files:/opt/netbox/netbox/reports:rw
|
||||||
- netbox-media-files:/opt/netbox/netbox/media:z
|
- netbox-scripts-files:/opt/netbox/netbox/scripts:rw
|
||||||
netbox-worker:
|
netbox-worker:
|
||||||
<<: *netbox
|
<<: *netbox
|
||||||
depends_on:
|
depends_on:
|
||||||
- redis
|
netbox:
|
||||||
- postgres
|
condition: service_healthy
|
||||||
command:
|
command:
|
||||||
- /opt/netbox/venv/bin/python
|
- /opt/netbox/venv/bin/python
|
||||||
- /opt/netbox/netbox/manage.py
|
- /opt/netbox/netbox/manage.py
|
||||||
- rqworker
|
- rqworker
|
||||||
|
healthcheck:
|
||||||
|
test: ps -aux | grep -v grep | grep -q rqworker || exit 1
|
||||||
|
start_period: 20s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
netbox-housekeeping:
|
netbox-housekeeping:
|
||||||
<<: *netbox
|
<<: *netbox
|
||||||
depends_on:
|
depends_on:
|
||||||
- redis
|
netbox:
|
||||||
- postgres
|
condition: service_healthy
|
||||||
command:
|
command:
|
||||||
- /opt/netbox/housekeeping.sh
|
- /opt/netbox/housekeeping.sh
|
||||||
|
healthcheck:
|
||||||
# postgres
|
test: ps -aux | grep -v grep | grep -q housekeeping || exit 1
|
||||||
postgres:
|
start_period: 20s
|
||||||
image: postgres:14-alpine
|
timeout: 3s
|
||||||
env_file: env/postgres.env
|
interval: 15s
|
||||||
volumes:
|
|
||||||
- netbox-postgres-data:/var/lib/postgresql/data
|
|
||||||
|
|
||||||
# redis
|
# redis
|
||||||
redis:
|
redis:
|
||||||
image: redis:7-alpine
|
image: docker.io/valkey/valkey:8.1-alpine
|
||||||
command:
|
command:
|
||||||
- sh
|
- sh
|
||||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||||
- redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
- valkey-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
||||||
|
healthcheck: &redis-healthcheck
|
||||||
|
test: '[ $$(valkey-cli --pass "$${REDIS_PASSWORD}" ping) = ''PONG'' ]'
|
||||||
|
start_period: 5s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 1s
|
||||||
|
retries: 5
|
||||||
env_file: env/redis.env
|
env_file: env/redis.env
|
||||||
volumes:
|
volumes:
|
||||||
- netbox-redis-data:/data
|
- netbox-redis-data:/data
|
||||||
redis-cache:
|
redis-cache:
|
||||||
image: redis:7-alpine
|
image: docker.io/valkey/valkey:8.1-alpine
|
||||||
command:
|
command:
|
||||||
- sh
|
- sh
|
||||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||||
- redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
- valkey-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
||||||
|
healthcheck: *redis-healthcheck
|
||||||
env_file: env/redis-cache.env
|
env_file: env/redis-cache.env
|
||||||
volumes:
|
volumes:
|
||||||
- netbox-redis-cache-data:/data
|
- netbox-redis-cache-data:/data
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
netbox-media-files:
|
netbox-media-files:
|
||||||
driver: local
|
driver: local
|
||||||
netbox-postgres-data:
|
netbox-redis-cache-data:
|
||||||
driver: local
|
driver: local
|
||||||
netbox-redis-data:
|
netbox-redis-data:
|
||||||
driver: local
|
driver: local
|
||||||
netbox-redis-cache-data:
|
netbox-reports-files:
|
||||||
|
driver: local
|
||||||
|
netbox-scripts-files:
|
||||||
driver: local
|
driver: local
|
||||||
|
@ -46,6 +46,8 @@ if ! ./manage.py migrate --check >/dev/null 2>&1; then
|
|||||||
./manage.py remove_stale_contenttypes --no-input
|
./manage.py remove_stale_contenttypes --no-input
|
||||||
echo "⚙️ Removing expired user sessions"
|
echo "⚙️ Removing expired user sessions"
|
||||||
./manage.py clearsessions
|
./manage.py clearsessions
|
||||||
|
echo "⚙️ Building search index (lazy)"
|
||||||
|
./manage.py reindex --lazy
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Create Superuser if required
|
# Create Superuser if required
|
||||||
@ -70,24 +72,24 @@ else
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
./manage.py shell --interface python <<END
|
./manage.py shell --interface python <<END
|
||||||
from django.contrib.auth.models import User
|
from users.models import Token, User
|
||||||
from users.models import Token
|
|
||||||
if not User.objects.filter(username='${SUPERUSER_NAME}'):
|
if not User.objects.filter(username='${SUPERUSER_NAME}'):
|
||||||
u=User.objects.create_superuser('${SUPERUSER_NAME}', '${SUPERUSER_EMAIL}', '${SUPERUSER_PASSWORD}')
|
u = User.objects.create_superuser('${SUPERUSER_NAME}', '${SUPERUSER_EMAIL}', '${SUPERUSER_PASSWORD}')
|
||||||
Token.objects.create(user=u, key='${SUPERUSER_API_TOKEN}')
|
Token.objects.create(user=u, key='${SUPERUSER_API_TOKEN}')
|
||||||
END
|
END
|
||||||
|
|
||||||
echo "💡 Superuser Username: ${SUPERUSER_NAME}, E-Mail: ${SUPERUSER_EMAIL}"
|
echo "💡 Superuser Username: ${SUPERUSER_NAME}, E-Mail: ${SUPERUSER_EMAIL}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Print warning if startup scripts (and initializers) would've been run # Remove for next release
|
./manage.py shell --interface python <<END
|
||||||
if [ "$SKIP_STARTUP_SCRIPTS" == "true" ]; then
|
from users.models import Token
|
||||||
# Nothing to do
|
try:
|
||||||
echo "" # Empty block not allowed
|
old_default_token = Token.objects.get(key="0123456789abcdef0123456789abcdef01234567")
|
||||||
else
|
if old_default_token:
|
||||||
echo "⚠️⚠️⚠️ WARNING: The initializers have been moved to a plugin. See release notes."
|
print("⚠️ Warning: You have the old default admin API token in your database. This token is widely known; please remove it. Log in as your superuser and check API Tokens in your user menu.")
|
||||||
echo "⚠️⚠️⚠️ Set environment variable 'SKIP_STARTUP_SCRIPTS' to 'true' to remove this warning."
|
except Token.DoesNotExist:
|
||||||
fi
|
pass
|
||||||
|
END
|
||||||
|
|
||||||
echo "✅ Initialisation is done."
|
echo "✅ Initialisation is done."
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
SECONDS=${HOUSEKEEPING_INTERVAL:=86400}
|
SLEEP_SECONDS=${HOUSEKEEPING_INTERVAL:=86400}
|
||||||
echo "Interval set to ${SECONDS} seconds"
|
echo "Interval set to ${SLEEP_SECONDS} seconds"
|
||||||
while true; do
|
while true; do
|
||||||
date
|
date
|
||||||
/opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py housekeeping
|
/opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py housekeeping
|
||||||
sleep "${SECONDS}s"
|
sleep "${SLEEP_SECONDS}s"
|
||||||
done
|
done
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
UNIT_CONFIG="${UNIT_CONFIG-/etc/unit/nginx-unit.json}"
|
UNIT_CONFIG="${UNIT_CONFIG-/etc/unit/nginx-unit.json}"
|
||||||
|
# Also used in "nginx-unit.json"
|
||||||
UNIT_SOCKET="/opt/unit/unit.sock"
|
UNIT_SOCKET="/opt/unit/unit.sock"
|
||||||
|
|
||||||
load_configuration() {
|
load_configuration() {
|
||||||
@ -50,7 +51,7 @@ exec unitd \
|
|||||||
--control unix:$UNIT_SOCKET \
|
--control unix:$UNIT_SOCKET \
|
||||||
--pid /opt/unit/unit.pid \
|
--pid /opt/unit/unit.pid \
|
||||||
--log /dev/stdout \
|
--log /dev/stdout \
|
||||||
--state /opt/unit/state/ \
|
--statedir /opt/unit/state/ \
|
||||||
--tmp /opt/unit/tmp/ \
|
--tmpdir /opt/unit/tmp/ \
|
||||||
--user unit \
|
--user unit \
|
||||||
--group root
|
--group root
|
||||||
|
@ -1,27 +1,65 @@
|
|||||||
{
|
{
|
||||||
"listeners": {
|
"listeners": {
|
||||||
"*:8080": {
|
"0.0.0.0:8080": {
|
||||||
"pass": "routes"
|
"pass": "routes/main",
|
||||||
}
|
"forwarded": {
|
||||||
},
|
"client_ip": "X-Forwarded-For",
|
||||||
|
"protocol": "X-Forwarded-Proto",
|
||||||
"routes": [
|
"source": ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]
|
||||||
{
|
|
||||||
"match": {
|
|
||||||
"uri": "/static/*"
|
|
||||||
},
|
|
||||||
"action": {
|
|
||||||
"share": "/opt/netbox/netbox${uri}"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"0.0.0.0:8081": {
|
||||||
{
|
"pass": "routes/status",
|
||||||
"action": {
|
"forwarded": {
|
||||||
"pass": "applications/netbox"
|
"client_ip": "X-Forwarded-For",
|
||||||
|
"protocol": "X-Forwarded-Proto",
|
||||||
|
"source": ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"[::]:8080": {
|
||||||
|
"pass": "routes/main",
|
||||||
|
"forwarded": {
|
||||||
|
"client_ip": "X-Forwarded-For",
|
||||||
|
"protocol": "X-Forwarded-Proto",
|
||||||
|
"source": ["fc00::/7", "fe80::/10"]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"[::]:8081": {
|
||||||
|
"pass": "routes/status",
|
||||||
|
"forwarded": {
|
||||||
|
"client_ip": "X-Forwarded-For",
|
||||||
|
"protocol": "X-Forwarded-Proto",
|
||||||
|
"source": ["fc00::/7", "fe80::/10"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
},
|
||||||
|
"routes": {
|
||||||
|
"main": [
|
||||||
|
{
|
||||||
|
"match": {
|
||||||
|
"uri": "/static/*"
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"share": "/opt/netbox/netbox${uri}"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"action": {
|
||||||
|
"pass": "applications/netbox"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"status": [
|
||||||
|
{
|
||||||
|
"match": {
|
||||||
|
"uri": "/status/*"
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"proxy": "http://unix:/opt/unit/unit.sock"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"applications": {
|
"applications": {
|
||||||
"netbox": {
|
"netbox": {
|
||||||
"type": "python 3",
|
"type": "python 3",
|
||||||
@ -35,6 +73,5 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
"access_log": "/dev/stdout"
|
"access_log": "/dev/stdout"
|
||||||
}
|
}
|
||||||
|
1
docker/unit.list
Normal file
1
docker/unit.list
Normal file
@ -0,0 +1 @@
|
|||||||
|
deb [signed-by=/usr/share/keyrings/nginx-keyring.gpg] http://packages.nginx.org/unit/ubuntu/ noble unit
|
24
env/docker-compose.override.yml
vendored
Normal file
24
env/docker-compose.override.yml
vendored
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
version: '3.4'
|
||||||
|
services:
|
||||||
|
netbox:
|
||||||
|
ports:
|
||||||
|
- 8085:8080
|
||||||
|
volumes:
|
||||||
|
- /media/nfs/netbox/config:/etc/netbox/config:z,ro
|
||||||
|
- /media/nfs/netbox/media:/opt/netbox/netbox/media:z,rw
|
||||||
|
- /media/nfs/netbox/reports:/opt/netbox/netbox/reports:z,rw
|
||||||
|
- /media/nfs/netbox/scripts:/opt/netbox/netbox/scripts:z,rw
|
||||||
|
healthcheck:
|
||||||
|
retries: 15
|
||||||
|
netbox-worker:
|
||||||
|
volumes:
|
||||||
|
- /media/nfs/netbox/config:/etc/netbox/config:z,ro
|
||||||
|
- /media/nfs/netbox/media:/opt/netbox/netbox/media:z,rw
|
||||||
|
- /media/nfs/netbox/reports:/opt/netbox/netbox/reports:z,rw
|
||||||
|
- /media/nfs/netbox/scripts:/opt/netbox/netbox/scripts:z,rw
|
||||||
|
netbox-housekeeping:
|
||||||
|
volumes:
|
||||||
|
- /media/nfs/netbox/config:/etc/netbox/config:z,ro
|
||||||
|
- /media/nfs/netbox/media:/opt/netbox/netbox/media:z,rw
|
||||||
|
- /media/nfs/netbox/reports:/opt/netbox/netbox/reports:z,rw
|
||||||
|
- /media/nfs/netbox/scripts:/opt/netbox/netbox/scripts:z,rw
|
10
env/netbox.env
vendored
10
env/netbox.env
vendored
@ -1,7 +1,7 @@
|
|||||||
CORS_ORIGIN_ALLOW_ALL=True
|
CORS_ORIGIN_ALLOW_ALL=True
|
||||||
DB_HOST=postgres
|
DB_HOST=192.168.0.52
|
||||||
DB_NAME=netbox
|
DB_NAME=netbox
|
||||||
DB_PASSWORD=J5brHrAXFLQSif0K
|
DB_PASSWORD=netbox
|
||||||
DB_USER=netbox
|
DB_USER=netbox
|
||||||
EMAIL_FROM=netbox@bar.com
|
EMAIL_FROM=netbox@bar.com
|
||||||
EMAIL_PASSWORD=
|
EMAIL_PASSWORD=
|
||||||
@ -29,10 +29,6 @@ REDIS_INSECURE_SKIP_TLS_VERIFY=false
|
|||||||
REDIS_PASSWORD=H733Kdjndks81
|
REDIS_PASSWORD=H733Kdjndks81
|
||||||
REDIS_SSL=false
|
REDIS_SSL=false
|
||||||
RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
|
RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
|
||||||
SECRET_KEY=r8OwDznj!!dci#P9ghmRfdu1Ysxm0AiPeDCQhKE+N_rClfWNj
|
SECRET_KEY='r(m)9nLGnz$(_q3N4z1k(EFsMCjjjzx08x9VhNVcfd%6RF#r!6DE@+V5Zk2X'
|
||||||
SKIP_SUPERUSER=false
|
SKIP_SUPERUSER=false
|
||||||
SUPERUSER_API_TOKEN=0123456789abcdef0123456789abcdef01234567
|
|
||||||
SUPERUSER_EMAIL=admin@example.com
|
|
||||||
SUPERUSER_NAME=admin
|
|
||||||
SUPERUSER_PASSWORD=admin
|
|
||||||
WEBHOOKS_ENABLED=true
|
WEBHOOKS_ENABLED=true
|
||||||
|
@ -1,46 +0,0 @@
|
|||||||
from dcim.choices import DeviceStatusChoices
|
|
||||||
from dcim.models import ConsolePort, Device, PowerPort
|
|
||||||
from extras.reports import Report
|
|
||||||
|
|
||||||
|
|
||||||
class DeviceConnectionsReport(Report):
|
|
||||||
description = "Validate the minimum physical connections for each device"
|
|
||||||
|
|
||||||
def test_console_connection(self):
|
|
||||||
|
|
||||||
# Check that every console port for every active device has a connection defined.
|
|
||||||
active = DeviceStatusChoices.STATUS_ACTIVE
|
|
||||||
for console_port in ConsolePort.objects.prefetch_related('device').filter(device__status=active):
|
|
||||||
if console_port.connected_endpoint is None:
|
|
||||||
self.log_failure(
|
|
||||||
console_port.device,
|
|
||||||
"No console connection defined for {}".format(console_port.name)
|
|
||||||
)
|
|
||||||
elif not console_port.connection_status:
|
|
||||||
self.log_warning(
|
|
||||||
console_port.device,
|
|
||||||
"Console connection for {} marked as planned".format(console_port.name)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
self.log_success(console_port.device)
|
|
||||||
|
|
||||||
def test_power_connections(self):
|
|
||||||
|
|
||||||
# Check that every active device has at least two connected power supplies.
|
|
||||||
for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
|
|
||||||
connected_ports = 0
|
|
||||||
for power_port in PowerPort.objects.filter(device=device):
|
|
||||||
if power_port.connected_endpoint is not None:
|
|
||||||
connected_ports += 1
|
|
||||||
if not power_port.connection_status:
|
|
||||||
self.log_warning(
|
|
||||||
device,
|
|
||||||
"Power connection for {} marked as planned".format(power_port.name)
|
|
||||||
)
|
|
||||||
if connected_ports < 2:
|
|
||||||
self.log_failure(
|
|
||||||
device,
|
|
||||||
"{} connected power supplies found (2 needed)".format(connected_ports)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
self.log_success(device)
|
|
@ -1,5 +1,6 @@
|
|||||||
django-auth-ldap==4.1.0
|
django-auth-ldap==5.1.0
|
||||||
django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.13.1
|
dulwich==0.22.8
|
||||||
napalm==4.0.0
|
python3-saml==1.16.0
|
||||||
psycopg2==2.9.4
|
--no-binary lxml
|
||||||
social-auth-core[openidconnect]==4.3.0
|
--no-binary xmlsec
|
||||||
|
sentry-sdk[django]==2.27.0
|
||||||
|
@ -1,4 +0,0 @@
|
|||||||
LOGGING = {
|
|
||||||
'version': 1,
|
|
||||||
'disable_existing_loggers': True
|
|
||||||
}
|
|
12
test-configuration/test_config.py
Normal file
12
test-configuration/test_config.py
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
LOGGING = {
|
||||||
|
'version': 1,
|
||||||
|
'disable_existing_loggers': True
|
||||||
|
}
|
||||||
|
|
||||||
|
PLUGINS = [
|
||||||
|
'netbox.tests.dummy_plugin',
|
||||||
|
]
|
||||||
|
|
||||||
|
ALLOW_TOKEN_RETRIEVAL = True
|
||||||
|
|
||||||
|
DEFAULT_PERMISSIONS = {}
|
61
test.sh
61
test.sh
@ -14,6 +14,8 @@
|
|||||||
# exit when a command exits with an exit code != 0
|
# exit when a command exits with an exit code != 0
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
|
source ./build-functions/gh-functions.sh
|
||||||
|
|
||||||
# IMAGE is used by `docker-compose.yml` do determine the tag
|
# IMAGE is used by `docker-compose.yml` do determine the tag
|
||||||
# of the Docker Image that is to be used
|
# of the Docker Image that is to be used
|
||||||
if [ "${1}x" != "x" ]; then
|
if [ "${1}x" != "x" ]; then
|
||||||
@ -35,20 +37,72 @@ if [ -z "${IMAGE}" ]; then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
# The docker compose command to use
|
# The docker compose command to use
|
||||||
doco="docker-compose --file docker-compose.test.yml --project-name netbox_docker_test_${1}"
|
doco="docker compose --file docker-compose.test.yml --file docker-compose.test.override.yml --project-name netbox_docker_test"
|
||||||
|
|
||||||
test_setup() {
|
test_setup() {
|
||||||
|
gh_echo "::group:: Test setup"
|
||||||
echo "🏗 Setup up test environment"
|
echo "🏗 Setup up test environment"
|
||||||
|
$doco up --detach --quiet-pull --wait --force-recreate --renew-anon-volumes --no-start
|
||||||
|
$doco start postgres
|
||||||
|
$doco start redis
|
||||||
|
$doco start redis-cache
|
||||||
|
gh_echo "::endgroup::"
|
||||||
}
|
}
|
||||||
|
|
||||||
test_netbox_unit_tests() {
|
test_netbox_unit_tests() {
|
||||||
|
gh_echo "::group:: Netbox unit tests"
|
||||||
echo "⏱ Running NetBox Unit Tests"
|
echo "⏱ Running NetBox Unit Tests"
|
||||||
$doco run --rm netbox /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py test
|
$doco run --rm netbox /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py test
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
}
|
||||||
|
|
||||||
|
test_compose_db_setup() {
|
||||||
|
gh_echo "::group:: Netbox DB migrations"
|
||||||
|
echo "⏱ Running NetBox DB migrations"
|
||||||
|
$doco run --rm netbox /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py migrate
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
}
|
||||||
|
|
||||||
|
test_netbox_start() {
|
||||||
|
gh_echo "::group:: Start Netbox service"
|
||||||
|
echo "⏱ Starting NetBox services"
|
||||||
|
$doco up --detach --wait
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
}
|
||||||
|
|
||||||
|
test_netbox_web() {
|
||||||
|
gh_echo "::group:: Web service test"
|
||||||
|
echo "⏱ Starting web service test"
|
||||||
|
RESP_CODE=$(
|
||||||
|
curl \
|
||||||
|
--silent \
|
||||||
|
--output /dev/null \
|
||||||
|
--write-out '%{http_code}' \
|
||||||
|
--request GET \
|
||||||
|
--connect-timeout 5 \
|
||||||
|
--max-time 10 \
|
||||||
|
--retry 5 \
|
||||||
|
--retry-delay 0 \
|
||||||
|
--retry-max-time 40 \
|
||||||
|
http://127.0.0.1:8000/login/
|
||||||
|
)
|
||||||
|
if [ "$RESP_CODE" == "200" ]; then
|
||||||
|
echo "Webservice running"
|
||||||
|
else
|
||||||
|
echo "⚠️ Got response code '$RESP_CODE' but expected '200'"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
gh_echo "::endgroup::"
|
||||||
}
|
}
|
||||||
|
|
||||||
test_cleanup() {
|
test_cleanup() {
|
||||||
echo "💣 Cleaning Up"
|
echo "💣 Cleaning Up"
|
||||||
$doco down -v
|
gh_echo "::group:: Docker compose logs"
|
||||||
|
$doco logs --no-color
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
gh_echo "::group:: Docker compose down"
|
||||||
|
$doco down --volumes
|
||||||
|
gh_echo "::endgroup::"
|
||||||
}
|
}
|
||||||
|
|
||||||
echo "🐳🐳🐳 Start testing '${IMAGE}'"
|
echo "🐳🐳🐳 Start testing '${IMAGE}'"
|
||||||
@ -58,5 +112,8 @@ trap test_cleanup EXIT ERR
|
|||||||
test_setup
|
test_setup
|
||||||
|
|
||||||
test_netbox_unit_tests
|
test_netbox_unit_tests
|
||||||
|
test_compose_db_setup
|
||||||
|
test_netbox_start
|
||||||
|
test_netbox_web
|
||||||
|
|
||||||
echo "🐳🐳🐳 Done testing '${IMAGE}'"
|
echo "🐳🐳🐳 Done testing '${IMAGE}'"
|
||||||
|
Reference in New Issue
Block a user