Skip to content

Commit 03c1caa

Browse files
authored
Merge pull request #306 from linuxserver/docs-ro-caps-nonroot
2 parents 537607f + fff210a commit 03c1caa

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

roles/generate-jenkins/templates/DOCUMENTATION.j2

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ Containers are configured using parameters passed at runtime (such as those abov
7878
| :----: | --- |
7979
{% if param_usage_include_ports %}
8080
{% for item in param_ports %}
81-
| `{{ item.internal_port }}` | {{ item.port_desc }} |
81+
| `{{ item.external_port }}:{{ item.internal_port }}` | {{ item.port_desc }} |
8282
{% endfor %}
8383
{% endif %}
8484
{% if opt_param_usage_include_ports %}
8585
{% for item in opt_param_ports %}
86-
| `{{ item.internal_port }}` | {{ item.port_desc }} |
86+
| `{{ item.external_port }}:{{ item.internal_port }}` | {{ item.port_desc }} |
8787
{% endfor %}
8888
{% endif %}
8989
{% if param_usage_include_net %}
@@ -146,7 +146,7 @@ Containers are configured using parameters passed at runtime (such as those abov
146146
{% endfor %}
147147
{% endif %}
148148
{% endif %}
149-
{% if custom_params is defined or opt_custom_params is defined or param_usage_include_hostname or param_usage_include_mac_address or security_opt_param is defined or opt_security_opt_param is defined %}
149+
{% if custom_params is defined or opt_custom_params is defined or param_usage_include_hostname or param_usage_include_mac_address or security_opt_param is defined or opt_security_opt_param is defined or (readonly_supported is defined and readonly_supported) or cap_add_param is defined or opt_cap_add_param is defined or (nonroot_supported is defined and nonroot_supported) %}
150150

151151
#### Miscellaneous Options
152152

@@ -178,6 +178,21 @@ Containers are configured using parameters passed at runtime (such as those abov
178178
| `--security-opt {{ item.run_var }}` | {{ item.desc }} |
179179
{% endfor %}
180180
{% endif %}
181+
{% if readonly_supported is defined and readonly_supported %}
182+
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
183+
{% endif %}
184+
{% if cap_add_param %}
185+
{% for item in cap_add_param_vars %}
186+
| `--cap-add={{ item.cap_add_var }}` | {{ item.desc }} |
187+
{% endfor %}
188+
{% endif %}
189+
{% if opt_cap_add_param %}
190+
{% for item in opt_cap_add_param_vars %}
191+
| `--cap-add={{ item.cap_add_var }}` | {{ item.desc }} |
192+
{% endfor %}
193+
{% if nonroot_supported is defined and nonroot_supported %}
194+
| `--user=1000:1000` | Run container with a non-root user. Please [read the docs](https://docs.linuxserver.io/misc/non-root/). |
195+
{% endif %}
181196
{% endif %}
182197
{% if cap_add_param or opt_cap_add_param or (custom_params is defined and 'sysctl' in (custom_params | map(attribute="name")) ) %}
183198

0 commit comments

Comments
 (0)