Dataset and Share Setup Guide
This guide provides the recommended setup for dataset permissions, shares and application data storage.
Dataset Permissions
TrueCharts applications are designed to use the apps
(568) user for data permissions. Configure your dataset permissions as shown below to allows applications access.
If your existing dataset shows Edit ACL
then you need to Strip ACL
before continuing.
SMB Access
For SMB access you will need to create a user(s) that are members of the apps
group and modify the default SMB settings.
SMB User
Create a user and assign it to the apps
group under Auxiliary Groups
as shown below.
SMB Share
- Bluefin
- Cobia
- Cobia (Script Method)
Create an SMB Share as shown below. All settings should remain default except for Auxiliary Parameters
.
After saving SMB settings TrueNAS Scale will launch an Edit ACL
screen. Do NOT Save Access Control List
as this will overwrite the previously configured permissions. You can make any selection from the TrueNAS GUI to exit this screen, SMB Share will still be configured.
force user=apps
force group=apps
Create an SMB Share as shown below. All settings should remain default.
After saving SMB settings TrueNAS Scale will ask if you want to Configure ACL
. Do NOT as this will overwrite the previously configured permissions. You can select Cancel
, SMB Share will still be configured.
Setup SMB Share Auxiliary Parameters
With the release of Cobia the Auxiliary Parameters
has been removed from the WebUI. The below will guide you through the use of API calls and the system shell to add the correct parameters.
Access the API Documentation using Scale http://IP:PORT/api/docs/ (ie. http://192.168.1.4:81/api/docs/)
Select RESTful 2.0
Select Authorize
and enter login as root
click close when complete.
Scroll down to sharing.smb
Select the down arrow on GET /sharing/smb
Select Try it out
Select Execute
Take note of the response. You are looking for the id
of the SMB Share you previously created.
Now select the down arrow on PUT /sharing/smb/id/{id}
Select Try it out
Enter the ID previously identified in the id
block and select Execute
.
Copy the output of the Curl
block.
Access the system shell as root
.
Paste the output from the Curl
block.
Change the last line with the following input:
-d '{"auxsmbconf": "force user=apps\nforce group=apps"}'
Hit enter and you should see the following output.
Create an SMB Share as shown below. All settings should remain default.
After saving SMB settings TrueNAS Scale will ask if you want to Configure ACL
. Do NOT as this will overwrite the previously configured permissions. You can select Cancel
, SMB Share will still be configured.
Setup SMB Share Auxiliary Parameters
With the release of Cobia the Auxiliary Parameters
has been removed from the WebUI. The below will guide you through the use of script to add the correct parameters.
Generate an API key, access http://IP:PORT/ui/apikeys/ (ie. http://192.168.1.4:81/ui/apikeys/)
Select Add
Enter a name and click Save
Save a copy of the API key for use later
Download the script file to your TrueNAS server using the system shell.
wget https://raw.githubusercontent.com/xstar97/scale-scripts/main/scripts/smbAuxUpdater.sh
Edit the script using a text editor like nano.
nano smbAuxUpdater.sh
Modify the following variables:
BASE_URL
make sure the port is set to whatever your TrueNAS usesAUTH_VALUE
set this to the API key you previously createdSMB_USERS
set this to the user(s) you want to have SMB access
Make the script executable
chmod +x smbAuxUpdater.sh
Run the script
./smbAuxUpdater.sh
The script will ask if you want to update the SMB auxiliary parameters for each share. Answer yes or no as needed.
NFS Share
- Bluefin
- Cobia
Create an NFS Share which will be used for applications to access the dataset. Configure an NFS Share as shown below. All settings should remain default.
Create an NFS Share which will be used for applications to access the dataset. Configure an NFS Share as shown below. You will need to click Advanced Options
to set Maproot User
to root
.
App Storage
For most applications data access will be configured under Additional App Storage
.
NFS should NOT be used for App Config Storage
. This should be left on the default of PVC.
Configure Additional App Storage
as shown below. In some applications data storage is part of the application configuration, in those cases you would still configure NFS but not need to setup a Mount Path
.