Embedded Documentation Link 404 Not Found

[darrenwoods3]

I have added DOCS_ROOT = '/netbox/docs' to the configuration.py file and still get the 404 Not Found message. Any help would be greatly appreciated.

404 Not Found
nginx/1.18.0 (Ubuntu)

[candlerb]

• What version of Netbox are you running?
• Have you changed anything else significant in configuration.py - in particular have you changed BASE_PATH? If so, have you made corresponding changes to your nginx config?
• What page are you accessing when you get that 404 error (what's visible in the URL bar?)
• What do you mean by "still get"? Was it not working before you started making config changes?

If you install Netbox in the standard way, the documentation will be available in the standard location without changing any configs. In my case, if I click on the "Docs" link on the home page, it takes me to https://netbox.example.net/static/docs/ and I see the documentation as expected.

Note that DOCS_ROOT is a filesystem path, not a URL path. Putting /netbox/docs implies that you've installed netbox in the root directory of your filesystem. If you're not using the default location of /opt/netbox then it can work: you'll have other things to change (e.g. paths in your systemd unit file for a start). Even then, you don't need to set DOCS_ROOT because the default value is relative to where you installed netbox.

[darrenwoods3]

Brian, Thanks for the reply. * Running version 3.2.5 * Only changes I have made to the config are the required and EMAIL, LOGIN_REQUIRED, RELEASE_CHECK_URL, TIME_ZONE and added the following to get fqdn to work. CSRF_TRUSTED_ORIGINS = ( 'http://netbox.alamo.edu', 'https://netbox.alamo.edu', ) * This is a brand new install, BASE_PATH has not been changed BASE_PATH = '' * Visible URL is http://netbox.alamo.edu/static/docs/ * It has not worked at all ***@***.***<https://www.alamo.edu/> Darren L. Woods Lead Enterprise Network Analyst Information Technology Services Alamo Colleges District 2222 N. Alamo | San Antonio, TX 78215 210-485-0508 (Direct) | 210-485-0000 (Main) | alamo.edu<https://www.alamo.edu/> ***@***.*** ***@***.*** From: Brian Candler ***@***.***> Sent: Tuesday, July 12, 2022 5:33 AM To: netbox-community/netbox ***@***.***> Cc: Woods, Darren L ***@***.***>; Author ***@***.***> Subject: Re: [netbox-community/netbox] Embedded Documentation Link 404 Not Found (Discussion #9709) **THIS EMAIL IS FROM AN EXTERNAL SENDER OUTSIDE OF THE ALAMO COLLEGES. Be cautious before clicking links or opening attachments from unknown sources. Do not provide personal or confidential information.** * What version of Netbox are you running? * Have you changed anything else significant in configuration.py - in particular have you changed BASE_PATH? If so, have you made corresponding changes to your nginx config? * What page are you accessing when you get that 404 error (what's visible in the URL bar?) * What do you mean by "still get"? Was it not working before you started making config changes? If you install Netbox in the standard way, the documentation will be available in the standard location without changing any configs. In my case, if I click on the "Docs" link on the home page, it takes me to /static/docs/ and I see the documentation as expected. Note that DOCS_ROOT<https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fnetbox.home.deploy2.net%2fstatic%2fdocs%2fconfiguration%2foptional%2dsettings%2f%23docs%5froot&umid=661e2fd8-8597-4013-9eca-77481837483c&auth=5637abac4c5fb1b56bcb3ba82afee6090f0268a2-2275aa58e8701311aa1e1b42ecd3957ec10d7a6c> is a filesystem path, not a URL path. Putting /netbox/docs implies that you've installed netbox in the root directory of your filesystem. If you're not using the default location of /opt/netbox then it can work, but you'll have other things to change (e.g. paths in your systemd unit file for a start) — Reply to this email directly, view it on GitHub<https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fgithub.com%2fnetbox%2dcommunity%2fnetbox%2fdiscussions%2f9709%23discussioncomment%2d3128218&umid=661e2fd8-8597-4013-9eca-77481837483c&auth=5637abac4c5fb1b56bcb3ba82afee6090f0268a2-48b4526fc05ba68794713a192562b0051f22fd6e>, or unsubscribe<https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fgithub.com%2fnotifications%2funsubscribe%2dauth%2fA2AHQCDAL77GFF3PR3K57YDVTVCWBANCNFSM53I5G24Q&umid=661e2fd8-8597-4013-9eca-77481837483c&auth=5637abac4c5fb1b56bcb3ba82afee6090f0268a2-91095442f24d63d6b7ba1a5c84b457e42c095fd4>. You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>>

[candlerb]

It has not worked at all

OK, then something has gone wrong. First, remove DOCS_ROOT from your configuration.py to make things as close as possible to defaults.

Next: do you have any files in /opt/netbox/netbox/static/docs/? If not, then you probably missed the step of running the upgrade script, or there was an error which occurred while this ran which you did not notice. Run it again, and check the output.

If you do have those files, then it probably means your nginx config is wrong. There is a working one here.

[darrenwoods3]

Brian there was not docs directory in /opt/netbox/netbox/static. I ran the upgrade.sh script and that resolved this issue. Thank you so much for troubleshooting and helping me get this resolved. ***@***.***<https://www.alamo.edu/> Darren L. Woods Lead Enterprise Network Analyst Information Technology Services Alamo Colleges District 2222 N. Alamo | San Antonio, TX 78215 210-485-0508 (Direct) | 210-485-0000 (Main) | alamo.edu<https://www.alamo.edu/> ***@***.*** ***@***.*** From: Brian Candler ***@***.***> Sent: Tuesday, July 12, 2022 7:48 AM To: netbox-community/netbox ***@***.***> Cc: Woods, Darren L ***@***.***>; Author ***@***.***> Subject: Re: [netbox-community/netbox] Embedded Documentation Link 404 Not Found (Discussion #9709) **THIS EMAIL IS FROM AN EXTERNAL SENDER OUTSIDE OF THE ALAMO COLLEGES. Be cautious before clicking links or opening attachments from unknown sources. Do not provide personal or confidential information.** It has not worked at all OK, then something has gone wrong. First, remove DOCS_ROOT from your configuration.py to make things as close as possible to defaults. Next: do you have any files in /opt/netbox/netbox/static/docs/? If not, then you probably missed the step of running the upgrade script<https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fdocs.netbox.dev%2fen%2fstable%2finstallation%2f3%2dnetbox%2f%23run%2dthe%2dupgrade%2dscript&umid=9649840b-393a-4e25-aed4-4ee87181462b&auth=bff3c4f13882154edb0343b2d9b1dd102ae1c399-f4844fd2028be18bd5e6f4105588c6eafffb539c>, or there was an error which occurred while this ran which you did not notice. Run it again, and check the output. If you do have those files, then it probably means your nginx config is wrong. There is a working one here<https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fgithub.com%2fnetbox%2dcommunity%2fnetbox%2fblob%2fdevelop%2fcontrib%2fnginx.conf&umid=9649840b-393a-4e25-aed4-4ee87181462b&auth=bff3c4f13882154edb0343b2d9b1dd102ae1c399-374318bbfccd5ee233fca9901e17596bb424a93d>. — Reply to this email directly, view it on GitHub<https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fgithub.com%2fnetbox%2dcommunity%2fnetbox%2fdiscussions%2f9709%23discussioncomment%2d3129021&umid=9649840b-393a-4e25-aed4-4ee87181462b&auth=bff3c4f13882154edb0343b2d9b1dd102ae1c399-ad8aa1e28bd33f3ed896025a9ffa76b8e7a96962>, or unsubscribe<https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fgithub.com%2fnotifications%2funsubscribe%2dauth%2fA2AHQCFS3AAMQTQ4FHZOSTLVTVSRLANCNFSM53I5G24Q&umid=9649840b-393a-4e25-aed4-4ee87181462b&auth=bff3c4f13882154edb0343b2d9b1dd102ae1c399-263f0511c78bce26fcbe4fe0d12b1e164b8a1ba6>. You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>>