Skip to content

Commit 5153e68

Browse files
authored
Typo fixes in caddy and nat_reflection (opnsense#563)
* Update caddy.rst - Fix a few typos, references for some items added * Update nat_reflection.rst - Fixed menuselection typo
1 parent 0f558cd commit 5153e68

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

source/manual/how-tos/caddy.rst

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Installation
3535

3636
* Install "os-caddy" from the OPNsense Plugins.
3737

38+
.. _prepare-opnsense-caddy:
39+
3840

3941
---------------------------------------------
4042
Prepare OPNsense for Caddy After Installation
@@ -88,7 +90,7 @@ FAQ
8890
.. spacer::
8991
* Firewall rules to allow Caddy to reach upstream destinations are not required. OPNsense has a default rule that allows all traffic originating from it to be allowed.
9092
.. spacer::
91-
* ACME Clients on reverse proxied upstream destinations will not be able to issue certificates. Caddy intercepts ``/.well-known/acme-challenge``. This can be solved by using the `HTTP-01 challenge redirection` option in the advanced mode of domains. Please check the tutorial section for an example.
93+
* ACME Clients on reverse proxied upstream destinations will not be able to issue certificates. Caddy intercepts ``/.well-known/acme-challenge``. This can be solved by using the `HTTP-01 Challenge Redirection` option in the advanced mode of domains. Please check the tutorial section for an example.
9294
.. spacer::
9395
* When using Caddy with IPv6, the best choice is to have a GUA (Global Unicast Address) on the WAN interface, since otherwise the TLS-ALPN-01 challenge might fail.
9496
.. spacer::
@@ -105,7 +107,7 @@ FAQ
105107
Caddy: Tutorials
106108
================
107109

108-
.. Attention:: The tutorial section implies that `Prepare OPNsense for Caddy after installation` has been followed.
110+
.. Attention:: The tutorial section implies that :ref:`Prepare OPNsense for Caddy after installation <prepare-opnsense-caddy>` has been followed.
109111
.. Note:: Filling out `Description` fields is mandatory because they are used to display and reference items in forms and error messages.
110112

111113

@@ -148,6 +150,8 @@ Options Values
148150

149151
.. Note:: After just a few seconds the automatic certificate will be installed, check the Logfile.
150152

153+
.. _accesslist-opnsense-caddy:
154+
151155

152156
-------------------------------
153157
Restrict Access to Internal IPs
@@ -181,7 +185,7 @@ Options Values
181185

182186
* Press **Save** and **Apply**
183187

184-
Now, all connections not having a private IPv4 address will be served an empty page for the chosen domain. To outright refuse the connection, the option ``Abort Connections`` in `Services: Caddy Web Server: General Settings` should be additionally enabled.
188+
Now, all connections not having a private IPv4 address will be served an empty page for the chosen domain. To outright refuse the connection, the option ``Abort Connections`` in :menuselection:`Services --> Caddy Web Server --> General Settings` should be additionally enabled.
185189

186190
.. Note:: Some applications might demand a HTTP Error code instead of having their connection aborted, an example could be monitoring systems. For these a custom ``HTTP Response Code`` can be enabled.
187191

@@ -202,7 +206,7 @@ Go to :menuselection:`Services --> Caddy Web Server --> General Settings --> Dyn
202206
* Choose if `DynDns IP Version` should include IPv4 and/or IPv6.
203207
* Press **Save**
204208

205-
Go to :menuselection:`Services --> Caddy Web Server --> Reverse Proxy -> Domains`
209+
Go to :menuselection:`Services --> Caddy Web Server --> Reverse Proxy --> Domains`
206210

207211
* Press **+** to create a new `Domain`. ``mydomain.duckdns.org`` is an example if `duckdns` is used as DNS Provider.
208212

@@ -226,7 +230,8 @@ Options Values
226230

227231
* Press **Save** and **Apply**
228232

229-
.. Tip:: Check the Logfile for the dynamic dns updates.
233+
.. Tip:: Check the Logfile for the dynamic dns updates. Filter for the chosen domain.
234+
.. Tip:: In addition to `Dynamic DNS`, the `DNS-01 Challenge` can also be selected.
230235

231236

232237
---------------------------------
@@ -280,7 +285,7 @@ Go to :menuselection:`System --> Settings --> Administration`
280285
* Press **Save**
281286

282287
.. Note:: Open ``https://opn.example.com`` and it should serve the reverse proxied OPNsense WebUI. Check the log file for errors if it does not work, most of the time the `TLS Server Name` doesn't match the SAN of the `TLS Trusted CA Certificate`. Caddy does not support certificates with only a CN `Common Name`.
283-
.. Attention:: Create an `Access List` to restrict access to the WebUI.
288+
.. Attention:: Create an :ref:`Access List <accesslist-opnsense-caddy>` to restrict access to the WebUI.
284289
.. Tip:: The same approach can be used for any upstream destination using TLS and a self-signed certificate.
285290

286291

@@ -294,7 +299,7 @@ Sometimes an application behind Caddy uses its own ACME Client to get certificat
294299

295300
.. Attention:: It is mandatory that the domain in Caddy uses an ``empty port`` or ``443`` in the GUI, otherwise it can not use the TLS-ALPN-01 challenge for itself. The upstream destination has to listen on Port ``80`` and serve ``/.well-known/acme-challenge/``, for the same domain that is configured in Caddy.
296301

297-
Go to :menuselection:``Services - Caddy Web Server - Reverse Proxy - Domains``
302+
Go to :menuselection:`Services --> Caddy Web Server --> Reverse Proxy --> Domains`
298303

299304
* Press **+** to create a new `Domain`
300305

@@ -428,8 +433,8 @@ There are three methods that support XMLRPC sync:
428433
.. Note:: These methods can be mixed, just make sure to use a coherent configuration. It is best to decide for one method. Only `Domains` need configuration, `Subdomains` do not need any configuration for HA.
429434

430435
* Using custom certificates from the OPNsense Trust store for all `Domains`.
431-
* Using the `DNS-01 challenge` in the settings of `Domains`.
432-
* Using the `HTTP-01 challenge redirection` option in the advanced settings of `Domains`.
436+
* Using the `DNS-01 Challenge` in the settings of `Domains`.
437+
* Using the `HTTP-01 Challenge Redirection` option in the advanced settings of `Domains`.
433438

434439
Since the `HTTP-01 Challenge Redirection` needs some additional steps to work, it should be set up as followed:
435440

@@ -506,4 +511,4 @@ Using Custom Configuration Files
506511
* ``*.global`` files will be imported into the global block of the Caddyfile.
507512
* ``*.conf`` files will be imported at the end of the Caddyfile. Don't forget to test the custom configuration with ``caddy validate --config /usr/local/etc/caddy/Caddyfile``.
508513

509-
.. Note:: With these imports, the full potential of Caddy can be unlocked. The GUI options will remain focused on the reverse proxy. There is no community support for configurations that have not been created with the offered GUI.
514+
.. Note:: With these imports, the full potential of Caddy can be unlocked. The GUI options will remain focused on the reverse proxy. There is no OPNsense community support for configurations that have not been created with the offered GUI. For customized configurations, the Caddy community is the right place to ask.

source/manual/how-tos/nat_reflection.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Method 2 - Creating Automatic Port-Forward NAT (DNAT), Manual Outbound NAT (SNAT
162162
------------------------------------------------------------------------------------------------------------
163163

164164
Go to :menuselection:`Firewall --> Settings --> Advanced`
165-
Enable *Reflection for port forwards* to create automatic rules for all entries :menuselection: `Firewall --> NAT --> Port Forward` that have ``WAN`` as interface.
165+
Enable *Reflection for port forwards* to create automatic rules for all entries :menuselection:`Firewall --> NAT --> Port Forward` that have ``WAN`` as interface.
166166

167167
.. _nat-method2-portforward:
168168

0 commit comments

Comments
 (0)