[PR #4287] [MERGED] Closes #3949: Revise installation docs to use a Python virtual environment #12807

New Issue

adam · 2025-12-29T22:23:44+01:00

adam commented

2025-12-29 22:23:44 +01:00

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/4287
Author: @jeremystretch
Created: 2/26/2020
Status: ✅ Merged
Merged: 2/26/2020
Merged by: @jeremystretch

Base: develop ← Head: 3949-virtualenv-install

📝 Commits (10+)

c78df40 Refactor installtion docs
1b64f67 Update installation instructions to use a Python virtual environment
0851b97 Update the upgrade script & instructions to use a virtual environment
2ee06c1 Remove Python 2 migration guide
015a339 Update systemd migration guide
798ecfc Clean up the upgrade guide
be9df3c Simplify the systemctl commands
1abc82e Update upgrade script & instructions to better accomodate moving to a venv
64c9bf2 Fix exit statement in upgrade script
215dbef Improved formatting of upgrade script messages

📊 Changes

18 files changed (+201 additions, -190 deletions)

View changed files

📝 .gitignore (+4 -4)
📝 base_requirements.txt (+8 -0)
📝 contrib/netbox-rq.service (+1 -1)
📝 contrib/netbox.service (+1 -1)
📝 docs/additional-features/napalm.md (+1 -1)
📝 docs/installation/1-postgresql.md (+10 -9)
➕ docs/installation/2-redis.md (+22 -0)
📝 docs/installation/3-netbox.md (+42 -36)
📝 docs/installation/4-http-daemon.md (+8 -19)
📝 docs/installation/5-ldap.md (+8 -8)
📝 docs/installation/index.md (+4 -5)
➖ docs/installation/migrating-to-python3.md (+0 -38)
📝 docs/installation/migrating-to-systemd.md (+10 -14)
📝 docs/installation/upgrading.md (+16 -13)
📝 docs/release-notes/version-2.7.md (+6 -0)
📝 mkdocs.yml (+12 -10)
📝 requirements.txt (+2 -0)
📝 upgrade.sh (+46 -31)

📄 Description

Fixes: #3949

Revises the NetBox documentation to employ a Python virtual environment during installation

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/4287 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 2/26/2020 **Status:** ✅ Merged **Merged:** 2/26/2020 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `develop` ← **Head:** `3949-virtualenv-install` --- ### 📝 Commits (10+) - [`c78df40`](https://github.com/netbox-community/netbox/commit/c78df40cb005a13595446a93fe80785c9dd404e3) Refactor installtion docs - [`1b64f67`](https://github.com/netbox-community/netbox/commit/1b64f67f2b830e8913a0c05603126d0fd5f78710) Update installation instructions to use a Python virtual environment - [`0851b97`](https://github.com/netbox-community/netbox/commit/0851b97ba5445583a9c8452009b5b45a2e9f110e) Update the upgrade script & instructions to use a virtual environment - [`2ee06c1`](https://github.com/netbox-community/netbox/commit/2ee06c13f9bd38c0b4fa77282ee287a52112d215) Remove Python 2 migration guide - [`015a339`](https://github.com/netbox-community/netbox/commit/015a339202193633f10cfd9e958407d56c87f639) Update systemd migration guide - [`798ecfc`](https://github.com/netbox-community/netbox/commit/798ecfc8f0467d2cee47e617825bb4aa16c63a96) Clean up the upgrade guide - [`be9df3c`](https://github.com/netbox-community/netbox/commit/be9df3c07d3d7c4d36c125bc070080bcf1666e1d) Simplify the systemctl commands - [`1abc82e`](https://github.com/netbox-community/netbox/commit/1abc82e7185826e08ae185a6344e89cd084f2a8c) Update upgrade script & instructions to better accomodate moving to a venv - [`64c9bf2`](https://github.com/netbox-community/netbox/commit/64c9bf27c10e88a27b7f58c0ca8405bbf8606163) Fix exit statement in upgrade script - [`215dbef`](https://github.com/netbox-community/netbox/commit/215dbef7a04c90f8f84720361bba1e0c7a736306) Improved formatting of upgrade script messages ### 📊 Changes **18 files changed** (+201 additions, -190 deletions) <details> <summary>View changed files</summary> 📝 `.gitignore` (+4 -4) 📝 `base_requirements.txt` (+8 -0) 📝 `contrib/netbox-rq.service` (+1 -1) 📝 `contrib/netbox.service` (+1 -1) 📝 `docs/additional-features/napalm.md` (+1 -1) 📝 `docs/installation/1-postgresql.md` (+10 -9) ➕ `docs/installation/2-redis.md` (+22 -0) 📝 `docs/installation/3-netbox.md` (+42 -36) 📝 `docs/installation/4-http-daemon.md` (+8 -19) 📝 `docs/installation/5-ldap.md` (+8 -8) 📝 `docs/installation/index.md` (+4 -5) ➖ `docs/installation/migrating-to-python3.md` (+0 -38) 📝 `docs/installation/migrating-to-systemd.md` (+10 -14) 📝 `docs/installation/upgrading.md` (+16 -13) 📝 `docs/release-notes/version-2.7.md` (+6 -0) 📝 `mkdocs.yml` (+12 -10) 📝 `requirements.txt` (+2 -0) 📝 `upgrade.sh` (+46 -31) </details> ### 📄 Description ### Fixes: #3949 Revises the NetBox documentation to employ a Python virtual environment during installation --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

adam added the pull-request label 2025-12-29 22:23:44 +01:00

adam closed this issue

2025-12-29 22:23:44 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#12807