Skip to content

Commit 72bd101

Browse files
clairewrtrclairewrtr
authored
Merge branch 'master' into DOCS-4214-SCALE-22.02-Update-System-Settings-General-Articles
2 parents a4d66e5 + ec1c600 commit 72bd101

File tree

162 files changed

+1464
-928
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+1464
-928
lines changed

‎content/CORE/API/_index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
22
title: "API Reference"
3+
description: "This article describes how to access the API documentation in TrueNAS CORE."
34
geekdocCollapseSection: true
45
weight: 160
6+
tags:
7+
- coreapi
58
---
69

710
TrueNAS CORE API documentation is available from the web interface by clicking **<i class="material-icons" aria-hidden="true" title="Settings">settings</i>&nbsp;> API Keys > DOCS**.
@@ -17,3 +20,5 @@ For convenience, static builds of the current 2.0 API documentation stored on th
1720
## CORE Documentation Sections
1821

1922
{{< include file="/_includes/COREDocsSections.md" type="page" >}}
23+
24+
{{< taglist tag="coretopmenu" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md‎

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: "Accessing Jails Using SSH"
3+
description: "This article describes how to access Jails using SSH in TrueNAS CORE."
34
weight: 20
5+
tags:
6+
- corejails
47
---
58

69
{{< toc >}}
@@ -119,16 +122,4 @@ Password:
119122
Every jail has its own user accounts and service configuration.
120123
These steps must be repeated for each jail that requires SSH access.
121124

122-
## Additional information
123-
124-
For information on Jails screens and how to add or manage jails see:
125-
126-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
127-
128-
[Creating Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md" >}})
129-
130-
[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
131-
132-
[Setting Up Jail Storage]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md" >}})
133-
134-
[Installing Jail Software]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md" >}})
125+
{{< taglist tag="corejails" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Creating Jails"
3+
description: "This article describes how to create Jails in TrueNAS CORE."
34
weight: 5
45
aliases: /core/appliations/jails/create/
6+
tags:
7+
- corejails
8+
- corejailspluginsvm
59
---
610

711
{{< toc >}}
@@ -130,7 +134,7 @@ If you are an experienced user you can access additional advanced configuration
130134

131135
For more information on the configuration screens see [Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
132136

133-
## Creating Template Jails
137+
### Creating Template Jails
134138

135139
Template jails are *basejails* that can efficiently create jails with the same configuration.
136140
These steps create a template jail:
@@ -152,14 +156,6 @@ These steps create a template jail:
152156
Set **Release** to ***basejailname*(template)**, where *basejailname* is the name of the base jail created earlier.
153157

154158
7. Complete the jail creation wizard.
159+
{{< /expand>}}
155160

156-
## Additional Information
157-
For information on Jails screens and how to add or manage jails see:
158-
159-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
160-
161-
[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
162-
163-
[Setting Up Jail Storage]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md" >}})
164-
165-
[Accessing Jails Using SSH]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md" >}})
161+
{{< taglist tag="corejails" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Installing Software"
3+
description: "This article describes how to install software using Jails in TrueNAS CORE."
34
weight: 20
45
Aliases: /core/applications/jails/software/
6+
tags:
7+
- corejails
8+
- corejailspluginsvm
59
---
610

711
{{< toc >}}
@@ -219,16 +223,4 @@ The startup script also indicates if any additional parameters are available:
219223
# NAME_dir="/usr/local/etc/openvpn"
220224
# --cd directory
221225
```
222-
## Additional Information
223-
224-
For information on Jails screens and how to add or manage jails see:
225-
226-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
227-
228-
[Creating Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md" >}})
229-
230-
[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
231-
232-
[Setting Up Jail Storage]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md" >}})
233-
234-
[Accessing Jails Using SSH]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md" >}})
226+
{{< taglist tag="corejails" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Managing Jails"
3+
description: "This article describes how to manage Jails in TrueNAS CORE."
34
weight: 10
45
aliases: /core/applications/jails/manage/
6+
tags:
7+
- corejails
8+
- corejailspluginsvm
59
---
610

711
{{< toc >}}
@@ -53,15 +57,4 @@ It is possible to manually remove unused releases from the `/iocage/releases/` d
5357
The release must not be in use by any jail on the system!
5458
{{< /hint >}}
5559

56-
## Additional Information
57-
For information on Jails screens and how to add or manage jails see:
58-
59-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
60-
61-
[Creating Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md" >}})
62-
63-
[Setting Up Jail Storage]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md" >}})
64-
65-
[Accessing Jails Using SSH]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md" >}})
66-
67-
[Installing Jail Software]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md" >}})
60+
{{< taglist tag="corejails" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Setting Up Jail Storage"
3+
description: "This article describes how to set up Jail Storage in TrueNAS CORE."
34
weight: 30
45
aliases: /core/applications/jails/storage/
6+
tags:
7+
- corejails
8+
- corejailspluginsvm
59
---
610

711

@@ -80,15 +84,4 @@ However, removing the jail storage entry only removes the pointer.
8084
This leaves the data intact but no longer accessible to the jail.
8185
{{< /hint >}}
8286

83-
## Additional Information
84-
For information on Jails screens and how to add or manage jails see:
85-
86-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
87-
88-
[Creating Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md" >}})
89-
90-
[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
91-
92-
[Accessing Jails Using SSH]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md" >}})
93-
94-
[Installing Jail Software]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md" >}})
87+
{{< taglist tag="corejails" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Jails/_index.md‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,8 @@
11
---
22
title: "Jails"
3+
description: "This article lists articles related to Jails, Plugins and Virtual Machines in TrueNAS CORE."
34
geekdocCollapseSection: true
45
weight: 10
56
---
67

7-
For information on Jails screens and how to add or manage jails see:
8-
9-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
10-
11-
[Creating Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md" >}})
12-
13-
[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
14-
15-
[Setting Up Jail Storage]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md" >}})
16-
17-
[Accessing Jails Using SSH]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md" >}})
18-
19-
[Installing Jail Software]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md" >}})
8+
{{< children depth="2" description="true" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Plugins/CreatingCustomPlugin.md‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Custom Plugins"
3+
description: "This article describes how to configure plugins on TrueNAS CORE."
34
weight: 20
45
Aliases: /core/applications/plugins/createplugin/
6+
tags:
7+
- coreplugins
8+
- corejailspluginsvm
59
---
610

711
{{< toc >}}
@@ -167,13 +171,4 @@ This way a moderator can fork your repository and can make available in the comm
167171

168172
For guides on how to use Github, see [Github Guides](https://guides.github.com/).
169173

170-
## Additional Information
171-
For information on Plugins and Jails screens and how to add or manage jails see:
172-
173-
[Plugins Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Plugins/PluginsScreens.md" >}})
174-
175-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
176-
177-
[Creating Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md" >}})
178-
179-
[Managing Plugins]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Plugins/ManagingPlugins.md" >}})
174+
{{< taglist tag="corejailspluginsvm" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Plugins/ManagingPlugins.md‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Plugin Management"
3+
description: "This article describes how to manage plugins in TrueNAS CORE."
34
weight: 10
45
aliases: /core/applications/plugins/manageplugins/
6+
tags:
7+
- coreplugins
8+
- corejailspluginsvm
59
---
610

711
{{< toc >}}
@@ -118,13 +122,4 @@ Confirm the plugin removal by typing in the name of the plugin jail and setting
118122
Uninstalling can take a few moments while the plugin deletes from both **Plugins** and **Jails**.
119123
The plugin dataset also deletes from <file>{POOL}/iocage/jails/</file> and any jail snapshots from **Storage > Snapshots**.
120124

121-
## Additional Information
122-
For information on Plugins and Jails screens and how to add or manage jails see:
123-
124-
[Plugins Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Plugins/PluginsScreens.md" >}})
125-
126-
[Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/Jails/JailsScreens.md" >}})
127-
128-
[Creating Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/CreatingJails.md" >}})
129-
130-
[Creating Custom Plugin]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Plugins/CreatingCustomPlugin.md" >}})
125+
{{< taglist tag="corejailspluginsvm" limit="10" >}}

‎content/CORE/CORETutorials/JailsPluginsVMs/Plugins/_index.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
title: "Plugins"
3+
description: "This article lists the associated plugins articles in TrueNAS CORE."
34
geekdocCollapseSection: true
45
weight: 20
56
---
67

78
For more information on Plugins see:
89

9-
[Creating Custom Plugins]({{< relref "CORE/CORETutorials/JailsPluginsVMs/Plugins/CreatingCustomPlugin.md" >}})
10-
11-
[Managing Plugins]({{< relref "CORE/CORETutorials/JailsPluginsVMs/Plugins/ManagingPlugins.md" >}})
10+
{{< children depth="2" description="true" >}}

0 commit comments

Comments
 (0)