OPNsense
  • Home
  • Help
  • Search
  • Login
  • Register

  • OPNsense Forum »
  • English Forums »
  • Documentation and Translation (Moderator: fabian) »
  • where can I download the full documentation to read it off-line ?
« previous next »
  • Print
Pages: [1]

Author Topic: where can I download the full documentation to read it off-line ?  (Read 5005 times)

opnnewbie

  • Newbie
  • *
  • Posts: 30
  • Karma: 1
    • View Profile
where can I download the full documentation to read it off-line ?
« on: December 02, 2021, 05:07:39 pm »
I am in the process of attempting my first opnSense installation to replace my current router.

In the meantime I have to move my WAN to the router and sometimes I get off-line.

I can't find a link to download the full docs in PDF or whatever format do you offer other than using a robot to download all the HTML links (very cumbersome to say the least).

Is there a place where the docs are available for direct download ?

I did search the directories on one of the mirrors and find nothing at all regarding docs.
Logged

Greelan

  • Hero Member
  • *****
  • Posts: 954
  • Karma: 65
    • View Profile
Re: where can I download the full documentation to read it off-line ?
« Reply #1 on: December 02, 2021, 08:24:00 pm »
Clone the GitHub repo? https://github.com/opnsense/docs
Logged

opnnewbie

  • Newbie
  • *
  • Posts: 30
  • Karma: 1
    • View Profile
Re: where can I download the full documentation to read it off-line ?
« Reply #2 on: December 02, 2021, 09:38:30 pm »
Thanks for your reply  ;)

I was inspecting the git source directories you pointed me to, and, for example, the manual files are in rst files supposedly to be transformed to HTML/and-whatnot via make html and the like (presumably requiring freeBSD as the base OS)

The problem is my desktop is running linux not BSD, and besides, I expected something more straightforward like the links on freeBSD documentation allowing you to download split/whole documents (eg: https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/).

I am not complaining, I just think that some links with ready-access docs will be help more people getting up and running without wasting time building docs and the like, furthermore, giving this distro is oftenly used as router/gateway to the net and even a subtle/minor not-quite-yet-understood change for a beginner can drop the internet connection. My two-cents.
Logged

marcquark

  • Jr. Member
  • **
  • Posts: 86
  • Karma: 4
    • View Profile
Re: where can I download the full documentation to read it off-line ?
« Reply #3 on: January 01, 2022, 10:58:54 am »
You can build the docs on Linux, just as an FYI. Fair point though, a downloadable documentation would be pretty neat.
Logged

fabian

  • Moderator
  • Hero Member
  • *****
  • Posts: 2768
  • Karma: 199
  • OPNsense Contributor (Language, VPN, Proxy, etc.)
    • View Profile
    • Personal Homepage
Re: where can I download the full documentation to read it off-line ?
« Reply #4 on: January 01, 2022, 11:41:46 am »
If GNU make does not work, try to install bmake (BSD make). The build itself requires just python and some pip packages.
Logged

  • Print
Pages: [1]
« previous next »
  • OPNsense Forum »
  • English Forums »
  • Documentation and Translation (Moderator: fabian) »
  • where can I download the full documentation to read it off-line ?
 

OPNsense is an OSS project © Deciso B.V. 2015 - 2023 All rights reserved
  • SMF 2.0.19 | SMF © 2021, Simple Machines
    Privacy Policy
    | XHTML | RSS | WAP2