Commit Graph

298 Commits

Author SHA1 Message Date
jeremystretch c7e0abc3fb Merge v2.11.10 2021-07-28 16:26:04 -04:00
Jeremy Stretch 6e79e5608e
Merge pull request #6810 from tamaszl/patch-1
Update 6-ldap.md - AUTH_LDAP_USER_DN_TEMPLATE to none for windows 2012+
2021-07-27 16:12:36 -04:00
bluikko 4f6944424b
Add dev server firewall configuration for EL distros (#6772)
* Add dev server firewall configuration for EL distros

* Fix typo in previous

* Indent the firewall block in install docs
2021-07-26 13:26:46 -04:00
tamaszl 7ab916b527
Update 6-ldap.md - AUTH_LDAP_USER_DN_TEMPLATE to none for windows 2012+
changed     When using Windows Server 2012, `AUTH_LDAP_USER_DN_TEMPLATE` should be set to None.
to Windows Server 2012+
2021-07-25 18:44:21 -07:00
jeremystretch 8898d3b558 Update installation docs 2021-07-22 16:38:35 -04:00
jeremystretch 803f9b6913 Merge branch 'develop' into feature 2021-07-20 17:06:18 -04:00
jeremystretch 47ef8b9cac Upgrade script now looks for Python path as env var 2021-07-19 15:13:30 -04:00
Jeremy Stretch 7058d6ca5a
Closes #6328: Local docs build (#6769)
* Incorporate local documentation build in upgrade script

* Add docs build to CI

* Include docs build path in revision control

* Update footer dcos link

* Changelog for #6328

* Clean up errant links
2021-07-19 14:18:08 -04:00
jeremystretch 31e41f8f02 Closes #6767: Add support for Python 3.9 2021-07-19 10:43:52 -04:00
Hans Erasmus 0ed82af99a
Update 3-netbox.md 2021-07-09 11:43:50 +02:00
Hans Erasmus 4fb3a2e0a0
Update installation
Just separated it so the user can easily click the copy button, and only be presented with the command.
2021-06-22 09:59:01 +02:00
jeremystretch d87ec82fe3 Closes #6590: Introduce a nightly housekeeping command to clear expired sessions and change records 2021-06-11 10:44:17 -04:00
jeremystretch da1fb4f969 Replace references to v2.12 with v3.0 2021-05-25 15:05:02 -04:00
jeremystretch 648b9dd7d8 Closes #6239: Fix sudo invokations of echo 2021-04-22 14:11:58 -04:00
jeremystretch e543b305c3 Docs cleanup 2021-04-05 21:46:48 -04:00
jeremystretch 237dfce8a0 Fix tab headers 2021-04-02 15:44:15 -04:00
Jeremy Stretch c828806b67 Merge branch 'develop' into feature 2021-03-25 16:09:28 -04:00
Marcus Crane 335cfcde57
Use relative links that work locally and in production
At present, a mix of link types are used in the Netbox
documentation from markdown file links to relative and
absolute anchor links.

Of the three types, linking to markdown files is the
most ideal because it allows navigation locally on disk,
as well as being translated into working links at render
time.

While not obvious, mkdocs handles converting markdown
links to valid URLs.

Signed-Off-by: Marcus Crane <marcu.crane@daimler.com>
2021-03-18 19:39:03 +13:00
Jeremy Stretch bac2387f50 Merge branch 'develop' into feature 2021-03-09 20:04:20 -05:00
Jeremy Stretch 835e11d10f Fixes #5920: Revert #5760 (do not force database encoding) 2021-03-08 16:54:28 -05:00
Jeremy Stretch 14bc3a3cf8 Closes #5938: Deprecate support for Python 3.6 2021-03-08 13:36:56 -05:00
Jeremy Stretch 3208c8317d Switch docs to mkdocs-material 2021-02-24 21:21:17 -05:00
Brian Candler 3b53cf5e84 Update docs to to create database explicitly with UTF8 encoding.
Fixes #5760
2021-02-07 19:46:30 +00:00
Robin Schneider 5fbe766a0a
NetBox should always be referred to as NetBox
Fix all instances of "Netbox" except the one that is used as an example
how not to write it.

Ref: docs/development/style-guide.md
2021-02-04 21:39:55 +01:00
Jeremy Stretch 0994719b91 Add NetBox installation video to docs 2021-01-20 15:36:04 -05:00
Jeremy Stretch e13d96a6f2 Don't pin Ubuntu installations to Python 3.6 2021-01-17 14:08:59 -05:00
Jeremy Stretch dc6dbdf3c4 Update documentation to reference the feature branch 2020-12-22 13:12:38 -05:00
Robin Schneider c5a265e828
Use HTTPS URL schema everywhere (#5505)
* Use HTTPS everywhere (mechanical edit using util from https-everywhere)

```Shell
node ~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
git checkout netbox/project-static/
```

A few additional changes where reset manually before the commit.

* Use HTTPS everywhere (mechanical edit using util from opening_hours.js)

```Shell
make -f ~/src/opening-hours/opening_hours.js/Makefile qa-https-everywhere
git checkout netbox/project-static/
git checkout netbox/*/tests
```
2020-12-21 12:02:30 -05:00
Jeremy Stretch 43d7d5570e Merge branch 'develop' into develop-2.10 2020-12-10 10:26:15 -05:00
Jeremy Stretch a4b2e1f2e2 Fix typo (from PR #5393) 2020-12-03 12:13:08 -05:00
Jeremy Stretch c1c4f28f29 Update installation docs to use CentOS 8 2020-11-17 13:23:07 -05:00
Jeremy Stretch 59df724844 Updated installation docs 2020-11-17 12:01:10 -05:00
Jeremy Stretch 39b322ae6b Closes #5313: Denote official support for Python 3.8 2020-11-05 16:08:33 -05:00
Jeremy Stretch 6d28eae5dc
Merge pull request #5290 from nniehoff/5282-ldap-logging
Fixing #5282 - moving logging configuration from to configuration.py
2020-10-30 09:11:12 -04:00
Nick Niehoff 97ea15e978 Removing logfile variable 2020-10-30 06:32:12 -06:00
Nick Niehoff 2b154dcfdf Fixing #5282 - moving logging configuration from authentication.py to configuration.py 2020-10-29 15:14:52 -06:00
Jeremy Stretch 1000039c74
Merge pull request #5277 from systeembeheerder/develop
Update upgrading.md
2020-10-29 17:11:04 -04:00
systeembeheerder 8ac2ee7b49
Update upgrading.md
make destination path for cp media absolute
2020-10-29 22:05:19 +01:00
Markku Leinio 02f348b15f Fix typo in weekday 2020-10-28 21:06:20 +02:00
Markku Leinio 4672f16fda Fix #5265: Change systemctl status outputs to venv era 2020-10-28 21:03:35 +02:00
systeembeheerder 6404657f99
Update upgrading.md
confirm 5275; use absolute paths
2020-10-27 16:07:38 +01:00
Jeremy Stretch 90dbe9bf60 Closes #5171: Introduce the RQ_DEFAULT_TIMEOUT configuration parameter 2020-09-23 13:28:05 -04:00
Jeremy Stretch b3b7e08c50 Closes #5076: Specify pip3 2020-09-01 10:24:17 -04:00
Jeremy Stretch aedba0e8be Closes #5030: Call out required minimum versions for depdencies in upgrade documentation 2020-08-22 20:53:21 -04:00
Jeremy Stretch 65b42c93b0 Merge branch 'develop' into develop-2.9 2020-08-05 09:15:10 -04:00
systeembeheerder c358097d52
Update upgrading.md (#4937)
include the local_requirements.txt file to keep ldap from breaking during upgrades.

Co-authored-by: Jeremy Stretch <jeremy.stretch@networktocode.com>
2020-08-04 12:26:21 -04:00
Jeremy Stretch fd564f09d1 #4923: Separate user creation instructions for Ubuntu/CentOS 2020-07-30 09:15:20 -04:00
Jeremy Stretch 0ef016db07 Update installation docs 2020-07-20 16:53:04 -04:00
Jeremy Stretch a4829198ff Update dependencies for v2.9 2020-07-16 11:28:19 -04:00
Jeremy Stretch dc161d9f2f Update LDAP configuration documentation 2020-06-03 15:57:11 -04:00
Jeremy Stretch cd236aa886 Closes #4645: Update minimum required version of PostgreSQL to 9.6 2020-05-15 10:11:36 -04:00
Daniel Sheppard 41361ce2a2 Fixes: #4618 - Add group creation and correct user creation group syntax 2020-05-11 16:10:23 -05:00
Jeremy Stretch 6e2c68ef42 Fixes #4652: Update repo RPM link for PosgtreSQL on CentOS 2020-05-05 13:05:54 -04:00
koratfood e6598fac20
Replace supervisord with systemd in LDAP troubleshooting (#4569)
Update the LDAP troubleshooting steps so that they are consistent with the rest of the documentaiton, which nowadays expects us to be running netbox via systemd instead of supervisord. Fixes #4504.
2020-05-04 09:56:03 -04:00
Jeremy Stretch 9ed0494b45 Clarify requirement for Python 3.6 or later 2020-04-13 14:22:17 -04:00
Jeremy Stretch c593eca936 Minor improvements to installation docs 2020-04-09 14:43:22 -04:00
Petr Klíma 2daf1e2004
#4470 wrong Ubuntu package name 2020-04-09 16:02:57 +02:00
Jeremy Stretch 5f6b63e978 Remove extraneous package from Apache installation instructions 2020-04-03 16:03:50 -04:00
Jeremy Stretch ad08935c57 Move nginx/Apache configs to discrete files 2020-04-03 15:46:48 -04:00
Jeremy Stretch af405a8ab2 Closes #4391: Extend installation docs to include enabling SSL 2020-04-03 15:35:45 -04:00
Jeremy Stretch 3590ed378d Rename 'webhooks' REDIS config to 'tasks' 2020-03-17 10:22:56 -04:00
Jeremy Stretch bc19072dc6 Update upgrade documentation for non-git installations 2020-03-10 13:24:10 -04:00
Jeremy Stretch ab2ea5697f Closes #4322: Introduce and document local_requirements.txt support for installation/upgrade of optional dependencies 2020-03-09 14:22:27 -04:00
Jeremy Stretch a7c133daa6 Reset documentation hierarchy 2020-03-05 17:23:56 -05:00
Jeremy Stretch 746bfd8bca Closes #4119: Extend upgrade script to clear expired user sessions 2020-03-04 10:29:22 -05:00
Jeremy Stretch 22ec11c766 Fix up CentOS installation instructions; add troubleshooting guide 2020-02-28 17:31:51 -05:00
Jeremy Stretch 1b6f721e50 Extend installation docs to include creation of a specific netbox user 2020-02-28 16:25:43 -05:00
Jeremy Stretch 9c88f12abe Add note about Redis config to installation instructions 2020-02-28 15:58:55 -05:00
Jeremy Stretch 1abc82e718 Update upgrade script & instructions to better accomodate moving to a venv 2020-02-26 15:26:12 -05:00
Jeremy Stretch be9df3c07d Simplify the systemctl commands 2020-02-26 14:38:25 -05:00
Jeremy Stretch 798ecfc8f0 Clean up the upgrade guide 2020-02-26 14:09:54 -05:00
Jeremy Stretch 015a339202 Update systemd migration guide 2020-02-26 14:09:27 -05:00
Jeremy Stretch 2ee06c13f9 Remove Python 2 migration guide 2020-02-26 13:56:44 -05:00
Jeremy Stretch 0851b97ba5 Update the upgrade script & instructions to use a virtual environment 2020-02-26 13:54:07 -05:00
Jeremy Stretch 1b64f67f2b Update installation instructions to use a Python virtual environment 2020-02-26 12:28:35 -05:00
Jeremy Stretch c78df40cb0 Refactor installtion docs 2020-02-26 11:40:31 -05:00
Jeremy Stretch 81d001d49e Add a note about X-Frame-Options to the HTTP daemon instructions 2020-02-24 14:30:03 -05:00
Daniel Sheppard ab378ed218 Fixes: #4130
Corrects service name for the RQ worker service in docs/installation/upgrading.md
2020-02-11 20:39:50 -06:00
Anton Tokarev 55886d6793
fix typo (#4135)
Co-authored-by: Jeremy Stretch <jeremy.stretch@networktocode.com>
2020-02-11 14:22:32 -05:00
Daniel Sheppard d746448d7d Fixes: #3961 - Edit migrate-to-systemd.md to closely match installation instructions under 3-http-daemon.md 2020-01-31 09:39:27 -06:00
agrrajag d0d2af4cab
Update 3-http-daemon.md (#4055)
There was no documentation to move back into the netbox folder after installing/configuring nginx. You would move into nginx on line 42 then try and figure out why you couldn't copy gunicorn on line 113.
2020-01-30 14:00:37 -05:00
Jeremy Stretch 943c644dc9
Merge pull request #4037 from newlandk/patch-1
Fixes #4039: LDAP Documentation
2020-01-29 10:09:07 -05:00
Kevin Newland 6fefa3c7dd
update ldap documentation
use new ldap cache configuration in documentation
https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/settings.py#L360
2020-01-28 18:34:26 -06:00
Samuel Mutel 73b35e72d8 Update nginx documentation 2020-01-27 21:10:10 +01:00
Jeremy Stretch 1d63a30b7a Merge branch 'develop' into develop-2.7 2020-01-02 17:21:15 -05:00
Saria Hajjar 7dc0591e3e Note about the group existance 2020-01-01 22:38:02 +00:00
Jeremy Stretch 5fedcd1f4e Fixes #3789: Typo 2019-12-26 10:19:32 -05:00
Markku Leiniö 3a18d1df8c Fix gunicorn.conf remains to gunicorn.py 2019-12-14 21:14:48 +02:00
Jeremy Stretch 85563e21db Remove obsolete initial_data fixtures (no longer maintained) 2019-12-12 14:30:43 -05:00
Jeremy Stretch 9352867cec Fix up the installation docs 2019-12-12 14:27:12 -05:00
Jeremy Stretch 9f204f72ef Changelog and documentation for #1814 2019-12-11 11:01:31 -05:00
Jeremy Stretch 45917f8014 Closes #3408: Remove WEBHOOKS_ENABLE configuration setting 2019-12-06 11:52:28 -05:00
Sander Steffann adb25fd7d7 822 bulk import of device components (#3711)
Closes #822: CSV import for device components

* Implement CSV import for netbox-community#822

* Comment out default_return_url until there is a proper target

* Fix the default value of `enabled` when not included in the import

* rear_port is definitely required here

* Power Ports don't have a type (yet)

* Add import for console-ports and console-server-ports

* Add import for device-bays
2019-12-05 15:36:11 -05:00
Bernhard Bock 1aaa101fb5 Docs: Remove obsolete P3P policy
P3P is obsolete (https://www.w3.org/TR/P3P11/), therefore the HTTP header
should be removed from the recommended config in the installation docs.
2019-11-08 15:13:32 +01:00
Jeremy Stretch b8f1585976 Merge branch 'develop' into develop-2.7 2019-11-01 16:19:36 -04:00
Tyler Bigler 2a8fa01a57 Increase request counts for max_requests 2019-11-01 12:09:44 -04:00
Tyler Bigler 7bf09a3085 Remove redundant word 2019-11-01 10:26:53 -04:00
Tyler Bigler a0de0696c5 Add max_requests details to example config 2019-11-01 10:23:25 -04:00
Tyler Bigler eaeb52de20 Add CONN_MAX_AGE to documentation (#3642)
* Add CONN_MAX_AGE to sample configurations

* Correct alignment

* Restore ghost space

* Correct alignment.

* Use stable docs url
2019-10-25 13:11:48 -04:00
John Anderson 0d15ac15ae implements #3282 - seperate webhooks and caching redis configs 2019-10-13 02:49:54 -04:00
Jeremy Stretch aeeb49a6a7 Merge branch 'develop' into develop-2.7 2019-10-10 13:41:10 -04:00
Jeremy Stretch 70ad705380 Provide index link to most recent version for release note 2019-10-10 12:10:35 -04:00
Jeremy Stretch 4e6b60b0f4 Rearranged release notes 2019-10-10 12:02:53 -04:00
kobayashi b2ac81a78f fixed broken links 2019-09-28 00:41:09 -04:00
Jeremy Stretch 56dcadb69b Merged v2.6.4 2019-09-20 08:35:14 -04:00
Jeremy Stretch 37aaf6f4ab Fixes #3429: Update installation docs for Redis 2019-09-18 16:35:45 -04:00
Daniel Sheppard 9e258dd31e
Fixes: #2902 - Implements systemd (#3017)
* Closes #2902 - Migrate to systemd from supervisord
* Closes #2902 - Migrate to systemd from supervisord

* Update systemd unit and environment file
* Add gunicorn.conf
* Update documentation and CHANGELOG.  Moved parameters around on service file
* Update Gitignore
2019-09-06 11:46:35 -05:00
Jeremy Stretch dccda62f2d Closes #2745: Remove topology maps 2019-08-08 21:33:20 -04:00
Robert Ellegate 30ef4b208c
Replacing references to digitalocean org
s/(?<=:\/\/github.com\/)digitalocean(?=\/netbox)/netbox-community/g
2019-07-10 09:23:43 -04:00
Jeremy Stretch 06245f6422 Promote django-rq to a required dependency 2019-04-25 14:25:16 -04:00
Jeremy Stretch 7acbeb55bc Minor tweaks 2018-12-20 09:54:59 -05:00
Jeremy Stretch 8498e0088b
Merge pull request #2667 from Jemikwa/develop
#2656 Updating LDAP documentation
2018-12-20 09:53:21 -05:00
Jeremy Stretch b44a76e6bd Closes #2537: Added AUTH_LDAP_MIRROR_GROUPS setting to LDAP docs 2018-12-19 16:24:41 -05:00
Jemikwa 064dd9bef2
Updating LDAP documentation
Adding information on service restarts and logging LDAP queries for troubleshooting.
2018-12-11 11:45:45 -06:00
Jeremy Stretch 4e6652d811 Change pip command to pip3 2018-12-10 09:57:37 -05:00
Jeremy Stretch 2bd9f8a11f Updated installation docs for v2.5 release 2018-12-07 15:29:18 -05:00
Jeremy Stretch 65edffea63 Merge v2.5 work 2018-12-07 10:51:28 -05:00
mmahacek 232e6f5076 #2635 - Update documentation for python3 update (#2636)
Add reference to reinstalling the django-rq module
2018-12-03 09:56:43 -05:00
Jeremy Stretch 879d879e56 Closes #2617: Explicitly mention that test service runs on port 8000 2018-11-28 09:35:33 -05:00
Jeremy Stretch 4cfe9fe182 Merge branch 'develop' into develop-2.5 2018-10-19 13:34:03 -04:00
mmahacek 409a9256a1 Expand Webhook Documentation #2347 (#2524)
* #2347 - Expand Webhook Documentation

Move "Install Python Packages" section up one header level.  Should make Napalm/Webhook sections appear in table of contents for direct linking.

*  #2347 - Expand Webhook Documentation

Add text for installation to link to other documentation sections with instructions.
2018-10-16 13:19:33 -04:00
Jeremy Stretch 2ac60bdf48 Merge branch 'develop' into develop-2.5 (v2.4.4 release) 2018-08-22 12:10:44 -04:00
Jeremy Stretch b917e8d3b0 #2376: Add libapache2-mod-wsgi-py3 to CentOS installation section 2018-08-22 11:46:13 -04:00
Jeremy Stretch ac546a9711 Closes #2000: Remove support for Python 2 2018-08-14 11:48:12 -04:00
Jeremy Stretch d6ce4fc9f3 Docs fixes 2018-07-30 17:19:22 -04:00
Jeremy Stretch 688c421c55 Tweaked Python3 guide to be less disruptive 2018-07-18 17:40:08 -04:00
Jeremy Stretch d77214fef6 Started v2.4 documentation refresh 2018-07-17 17:23:10 -04:00
Jeremy Stretch 277197edd4 Split webhooks documentation into the data model and installation sections 2018-07-16 16:21:46 -04:00
Jeremy Stretch d7e40de9da Merged v2.3.6 2018-07-16 12:03:32 -04:00
Alex Hart f70b7cab21
More verbose LDAP nested groups documentation 2018-07-03 15:53:58 -07:00
Jeremy Stretch 104bd1b45f Closes #2211: Removed Python 2 instructions from the installation docs 2018-07-02 16:33:18 -04:00
Reimann, Timo 131436fc20 Changed upgrading documentation for ease of use 2018-05-22 16:20:10 -04:00
Jeremy Stretch 966c188977
Merge pull request #1939 from dougthor42/patch-1
Add note about copying reports to `upgrading.md`
2018-05-22 16:16:43 -04:00
Jeremy Stretch 6a4d17b8a5
Merge pull request #1985 from lampwins/docs/apache-header
added X-Forwarded-Proto header to apache config
2018-03-22 11:43:43 -04:00
John Anderson 1c5239a4d0
added X-Forwarded-Proto header to apache config 2018-03-22 10:51:12 -04:00
Douglas Thor 8d9543cb6a
Add note about copying reports to `upgrading.md`
The `upgrading.md` file does not mention reports. If the user created reports in the old version's default directory (`./netbox/reports`), then the reports will not be transferred to the new version.
2018-03-01 15:05:51 -08:00
Jeremy Stretch 36de9f10d6 Closes #1918: Add note about copying media directory to upgrade doc 2018-02-27 15:54:25 -05:00
Jeremy Stretch 972f9be291 Formatting correction 2018-02-26 13:20:28 -05:00
John Eismeier e6bcc4a3fe Propose fix typos (#1897) 2018-02-21 12:39:29 -05:00
Jeremy Stretch 53998e0fff Closes #1828: Added warning about media directory permissions 2018-01-22 16:04:19 -05:00
Adrian Frühwirth 935da0d51f Fixes #1802: Typo in ldap.md 2017-12-29 13:29:07 +01:00
Jeremy Stretch ac71416eb9 Closes #1775: Added instructions for enabling STARTTLS for LDAP authentication 2017-12-20 14:48:42 -05:00
Jeremy Stretch 40f555a3b6 Merge pull request #1545 from digitalocean/mdl-ldap-docs-formatting
Minor LDAP documentation formatting cleanup
2017-10-12 23:42:29 -04:00
Jeremy Stretch a7f0b5adb3 Refreshed installation docs 2017-10-12 13:38:23 -04:00
Jeremy Stretch 392b45e6cb Added warning for PostgreSQL 9.4 requirement 2017-10-11 16:20:50 -04:00
Jeremy Stretch 043f2cb214 Tweaked PostgreSQL version number in example 2017-10-11 13:12:49 -04:00
Jeremy Stretch baa277c592 Updated install docs to install pip using setuptools 2017-10-11 12:22:35 -04:00
Jeremy Stretch 9c673d2a2e Updated the docs to call out PostgreSQL 9.4+ as a requirement 2017-09-29 14:36:55 -04:00
Matt Layher a01c9ff379
Minor LDAP documentation formatting cleanup 2017-09-29 13:22:42 -04:00
Lars Hartmann 466ab0b404 mentioned support of nested groups in LDAP installation documentation. 2017-09-21 16:36:25 +02:00