updated docs

O-X-L · Sep 26, 2023 · 04a147b · 04a147b
1 parent 7bd09a2
commit 04a147b
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 7 deletions.
diff --git a/config_example.yml b/config_example.yml
@@ -23,6 +23,7 @@ service:
     interface: ''
     ip4: []
     ip6: []
+    multi_ip: 'roundrobin'  # or failover; not yet implemented
 
 vars:
   - name: 'net_private'

diff --git a/docs/source/_inc/head.rst b/docs/source/_inc/head.rst
@@ -1,2 +1,2 @@
 .. tip::
-    If you find some discrepancy or missing information - `open a GitHub issue <https://github.com/superstes/ShieldWall/issues/new>`_
+    Check out the `Repository on GitHub <https://github.com/superstes/calamary>`_
diff --git a/docs/source/info/getting_started.rst b/docs/source/info/getting_started.rst
@@ -36,7 +36,9 @@ TProxy
 
 To run Calamary as `TPROXY <https://docs.kernel.org/networking/tproxy.html>`_ target - you will have to set `CAP_NET_RAW <https://man7.org/linux/man-pages/man7/capabilities.7.html>`_:
 
-> bind to any address for transparent proxying
+::
+
+  bind to any address for transparent proxying
 
 You can add it like this:
 

diff --git a/docs/source/info/rules.rst b/docs/source/info/rules.rst
@@ -33,15 +33,15 @@ Multiple matches can be defined in a single rule.
         sport: 'NUMBER'  # source ports
         protoL3: 'ip4/ivp4/ip6/ip6'
         protoL4: 'tcp/udp'  # others might be supported later on
-        protoL5: 'tls/http/dns/ntp'  # other might be supported later on
+        protoL5: 'tls/http/dns/ntp'  # others might be supported later on
         dns: 'DOMAIN'  # domain/TLS-SNI to match
-        encrypted: 'true/false/yes/no'  # only match TLS traffic
+        encrypted: 'true/false/yes/no'  # match TLS traffic
 
 The value of matches is **case-insensitive** by default.
 
 You can define **multiple values** for each match.
 
-Matches can also be **negated**:
+Matches can also be **negated** by using the :code:`!` prefix:
 
 .. code-block:: yaml
 
@@ -77,9 +77,11 @@ Calamary enables you to define variables that can be used inside your ruleset.
 
     vars:
       - name: 'net_private'
-          value: ['192.168.0.0/16', '172.16.0.0/12', '10.0.0.0/8']
+        value: ['192.168.0.0/16', '172.16.0.0/12', '10.0.0.0/8']
       - name: 'svc_http'
-          value: [80, 443]
+        value: [80, 443]
+
+Variables are referenced using the :code:`$` prefix.
 
 Whenever you use a variable, you can also negate it like any other value: