ditch howto and manual sections, add plugins and move final documents around.

pull/171/head
Ad Schellevis 5 years ago
parent 346e2297c3
commit e1a1600cd1

@ -19,5 +19,20 @@ These are all combined in the firewall section.
manual/nat
manual/aliases
manual/nptv6
manual/shaping
manual/how-tos/shaper
manual/how-tos/carp
manual/diagnostics
manual/logging
---------------
Setup guides
---------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/how-tos/fwcategory
manual/how-tos/edrop

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB

@ -28,7 +28,9 @@ Table of Contents
system
interfaces
firewall
manual
manual/vpnet
services
plugins
develop
relations
legal

@ -19,6 +19,8 @@ All traffic flowing through your appliance is using (virtual) interfaces, this i
manual/diagnostics
manual/interfaces_settings
manual/other-interfaces
manual/mobile_wan
manual/ipv6
---------------
Setup guides

@ -18,3 +18,4 @@ and end your session. After initial installation, this is the first place you wi
manual/gui
manual/dashboard
manual/opnsense_tools

@ -1,31 +0,0 @@
====================================
User Manual
====================================
.. image:: images/manual_guy.png
:width: 600px
:align: center
----------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/dhcp
manual/ipv6
manual/logging
manual/vpnet
manual/ips
manual/etpro_telemetry
manual/proxy
manual/reverse_proxy
manual/antivirus
manual/shaping
manual/mobile_wan
manual/captiveportal
manual/dynamic_routing
manual/opnsense_tools
manual/monit
manual/dynamic_dns
manual/howtos

@ -1,56 +0,0 @@
====================================
How-tos
====================================
.. toctree::
:maxdepth: 2
:titlesonly:
:glob:
how-tos/accounting
how-tos/bind
how-tos/c-icap
how-tos/cachingproxy
how-tos/clamav
how-tos/dnscrypt-proxy
how-tos/dynamicrouting_howto
how-tos/dynamicrouting_ospf
how-tos/dynamicrouting_rip
how-tos/dynamicrouting_zebra
how-tos/edrop
how-tos/freeradius
how-tos/fwcategory
how-tos/guestnet
how-tos/haproxy
how-tos/haproxy_howtos
how-tos/ips-feodo
how-tos/ips-geoip
how-tos/ips-sslfingerprint
how-tos/ipsec-road
how-tos/ipsec-s2s
how-tos/ipsec-s2s-binat
how-tos/mailgateway
how-tos/multicast-dns
how-tos/nginx
how-tos/nginx_header_hardening
how-tos/nginx_hosting
how-tos/nginx_basic_auth
how-tos/nginx_ip_acl
how-tos/nginx_tls_fingerprints
how-tos/nginx_tls_auth
how-tos/nginx_waf
how-tos/nginx_streams
how-tos/ntopng
how-tos/openconnect
how-tos/pac
how-tos/proxyicapantivirus
how-tos/proxyicapantivirusinternal
how-tos/proxytransparent
how-tos/proxywebfilter
how-tos/sslvpn_client
how-tos/sslvpn_s2s
how-tos/tor
how-tos/wireguard-client
how-tos/wireguard-client-azire
how-tos/wireguard-client-mullvad
how-tos/zerotier

@ -59,46 +59,20 @@ Configuration
-------------
Please read our how-tos for configuration examples and more detailed information.
IPsec Road Warrior
-------------------
:doc:`how-tos/ipsec-road`
IPsec Site-to-Site (policy-based)
---------------------------------
:doc:`how-tos/ipsec-s2s`
IPsec Site-to-Site (route-based)
---------------------------------
:doc:`how-tos/ipsec-s2s-route`
IPsec Site-to-Site with BINAT
-----------------------------
:doc:`how-tos/ipsec-s2s-binat`
OpenVPN/SSL Road Warrior
------------------------
:doc:`how-tos/sslvpn_client`
OpenVPN/SSL Site-to-Site
------------------------
:doc:`how-tos/sslvpn_s2s`
OpenConnect Client
------------------
:doc:`how-tos/openconnect`
WireGuard Site-to-Site
----------------------------
:doc:`how-tos/wireguard-s2s`
WireGuard Road Warrior
----------------------
:doc:`how-tos/wireguard-client`
:doc:`how-tos/wireguard-client-azire`
:doc:`how-tos/wireguard-client-mullvad`
Zerotier
--------
:doc:`how-tos/zerotier`
.. toctree::
:maxdepth: 2
:titlesonly:
how-tos/ipsec-road
how-tos/ipsec-s2s
how-tos/ipsec-s2s-route
how-tos/ipsec-s2s-binat
how-tos/sslvpn_client
how-tos/sslvpn_s2s
how-tos/openconnect
how-tos/wireguard-s2s
how-tos/wireguard-client
how-tos/wireguard-client-azire
how-tos/wireguard-client-mullvad
how-tos/zerotier

@ -0,0 +1,97 @@
====================================
Plugins
====================================
.. image:: images/manual_guy.png
:width: 600px
:align: center
Plugins help extending your security product with additional functionality, some plugins are maintained and supported by
the OPNsense team, a lot are supported by the community.
This section houses the documentation available for some of these plugins, not all come with documentation, some might
not even need it given the complexity of the functionality.
--------------------
DNS
--------------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/dynamic_dns
manual/how-tos/bind
manual/how-tos/dnscrypt-proxy
manual/how-tos/multicast-dns
--------------------
VPN & Connectivity
--------------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/how-tos/openconnect
manual/how-tos/wireguard-s2s
manual/how-tos/wireguard-client
manual/how-tos/wireguard-client-azire
manual/how-tos/wireguard-client-mullvad
manual/how-tos/zerotier
manual/how-tos/dynamicrouting_howto
manual/how-tos/dynamicrouting_ospf
manual/how-tos/dynamicrouting_rip
manual/how-tos/dynamicrouting_zebra
manual/how-tos/tor
----------------
Web
----------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/reverse_proxy
manual/antivirus
manual/how-tos/c-icap
manual/how-tos/clamav
manual/how-tos/haproxy
manual/how-tos/haproxy_howtos
manual/how-tos/nginx
manual/how-tos/nginx_header_hardening
manual/how-tos/nginx_hosting
manual/how-tos/nginx_basic_auth
manual/how-tos/nginx_ip_acl
manual/how-tos/nginx_tls_fingerprints
manual/how-tos/nginx_tls_auth
manual/how-tos/nginx_waf
manual/how-tos/nginx_streams
----------------
Other
----------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/how-tos/dynamicrouting_howto
manual/how-tos/dynamicrouting_ospf
manual/how-tos/dynamicrouting_rip
manual/how-tos/dynamicrouting_zebra
manual/how-tos/freeradius
manual/how-tos/accounting
manual/how-tos/mailgateway
----------------
Reporting
----------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/how-tos/ntopng

@ -0,0 +1,41 @@
====================================
Services
====================================
.. image:: images/black-black-and-white-close-up-1496139.jpg
:width: 600px
:align: center
Your security appliance comes with quite some services to ease network operation, these can be found in the services menu.
----------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/captiveportal
manual/dhcp
manual/ips
manual/etpro_telemetry
manual/proxy
manual/dynamic_routing
manual/monit
---------------
Setup guides
---------------
.. toctree::
:maxdepth: 2
:titlesonly:
manual/how-tos/pac
manual/how-tos/proxyicapantivirus
manual/how-tos/proxyicapantivirusinternal
manual/how-tos/proxytransparent
manual/how-tos/proxywebfilter
manual/how-tos/guestnet
manual/how-tos/cachingproxy
Loading…
Cancel
Save