How to Install and Configure Syncthing on TrueNAS Scale

Summary

This video tutorial guides viewers through setting up Syncthing on Shuras Scale 24.4, covering data set creation, permissions configuration, and sharing. It also demonstrates how to connect devices, manage shares, and ensure data synchronization across systems.

Takeaways

• 😀 The video provides a tutorial on setting up Syncthing on TrueNAS SCALE 24.4.
• 🔧 It mentions that there may be application changes in version 24.10, which might require an updated tutorial.
• 📂 The process starts by creating a data set for storing Syncthing data, choosing the 'apps' preset for correct permissions.
• 💾 The tutorial suggests using a nested data set for more granular control and snapshot capabilities.
• 🔍 It guides viewers to discover and install Syncthing from the application menu, customizing the web and TCP/UDP ports as needed.
• 🛠️ The video covers configuring the storage type to 'host path' and mounting the 'syncthing demo' data set.
• 🔒 After installation, it emphasizes the importance of setting a password for the web interface for security.
• 🔄 The tutorial explains how to connect devices and share folders between them within Syncthing.
• 📁 It demonstrates adding and syncing files between a local system and the TrueNAS SCALE system.
• 🗃️ The script touches on the benefits of using host paths for data sets, especially for backup and restoration purposes.
• 🔄 The video concludes by highlighting the ease of backup and restoration due to the inclusion of configuration settings in the data set.

Q & A

What is the purpose of the video?

The purpose of the video is to demonstrate how to set up Syncthing on TrueNAS SCALE 24.4, including configuring permissions and adding shares.

What is TrueNAS SCALE and what version is being discussed in the video?

TrueNAS SCALE is a network-attached storage operating system. The video discusses version 24.4.2, which was the most current version at the time of the video's release.

Why should the data set type be set to 'apps' even if a share is not being added?

Setting the data set type to 'apps' ensures that all necessary permissions are correctly configured, which is important whether or not a share is added.

What is the significance of choosing the same port numbers for TCP and UDP in Syncthing?

Choosing the same port numbers simplifies configuration, especially when Syncthing instances are running on the same network without any port conflicts.

How does the video guide the user to create a storage location for Syncthing data?

The video instructs the user to create a data set called 'syncthing demo' in the 'data sets' section of TrueNAS SCALE, choosing the 'apps' preset for proper permissions.

What is the role of the 'Install' button in the context of the video?

The 'Install' button is used to install the Syncthing application on TrueNAS SCALE after configuring the necessary settings such as storage type and mount point.

Why is it recommended to participate in Anonymous usage reporting in the video?

Participating in Anonymous usage reporting helps the developers gather data to improve the system, although it is optional and up to the user's personal choice.

What is the importance of setting a password for the Syncthing web interface?

Setting a password for the web interface secures access to the Syncthing administration controls, preventing unauthorized access.

How does the video explain adding a device to Syncthing?

The video demonstrates adding a device by showing the ID of one system and then adding it to another system as a new device, specifying the IP address and port number.

What does the video suggest regarding sharing folders in Syncthing?

The video suggests sharing specific folders rather than the entire 'syncthing demo' directory to control the visibility of shares and maintain organization.

How can changes made to the shared folder on one system be reflected on another system?

The video shows that changes, such as adding or deleting files, are synchronized across systems using Syncthing, ensuring that both systems have the same files.

What is the benefit of using a host path that points to a data set for Syncthing configuration?

Using a host path that points to a data set allows for easy backup and restoration of Syncthing settings and data, including configuration files, through mechanisms like snapshots and ZFS replication.

Outlines

00:00

🔧 Setting Up Syncthing on TrueNAS SCALE 24.4

This paragraph introduces the video's purpose, which is to demonstrate the setup of Syncthing on TrueNAS SCALE version 24.4. It acknowledges potential application changes in version 24.10 but assures that the instructions provided should still be applicable. The video will cover the basic setup, permissions configuration, and how to add shares to Syncthing. The speaker also mentions a previous in-depth video about Syncthing for those who need more information. The process begins with creating a data set for storing Syncthing data and choosing the 'apps' preset for proper permissions. The video then proceeds to the installation of Syncthing from the 'Discover Apps' section, with customization options for web and TCP/UDP ports. The importance of setting the correct storage type and host path is highlighted, and the installation is completed with a brief mention of the web portal and anonymous usage data participation.

05:01

📂 Configuring Shares and Syncthing Permissions

The second paragraph delves into the configuration of shares within Syncthing after the initial setup. It explains how to navigate the Syncthing interface to add and manage devices, and how to share folders between them. The process includes copying the device ID, specifying IP addresses and port numbers, and saving the device configuration. The speaker demonstrates how to accept shares and adjust folder base paths according to the settings. The paragraph also covers how to add a Windows share, the importance of choosing the correct folder to share for visibility, and the steps to restart the service and verify the successful sharing of files. The video concludes with a discussion on the benefits of using a host path for data storage, which includes ease of backup and restoration, and the preservation of configuration settings in case of system failure. The speaker encourages viewers to watch additional videos for more information on TrueNAS replication and to engage with the community for further discussion.

Keywords

💡Syncthing

Syncthing is an open-source file synchronization application that allows users to synchronize files across multiple devices. In the video, it is the main software being set up on a system called 'Shasta Scale'. The script discusses how to install and configure Syncthing, making it central to the video's theme of system setup and file management.

💡Shasta Scale

Shasta Scale is a reference to a specific version or system environment where the video's tutorial is being conducted. The script mentions 'Shasta Scale 24.4', indicating the version number, and it is the platform on which Syncthing is being installed and configured.

💡Permissions

Permissions in the context of the video refer to the access rights and privileges assigned to users or applications to perform certain actions on a system. The script explains how to properly configure permissions for Syncthing, which is crucial for ensuring that the application functions correctly and securely.

💡Data set

A data set in the script refers to a specific storage location or container for data on the Shasta Scale system. The video describes creating a data set for Syncthing to ensure that the application has a designated place to store its data, which is essential for organizing and managing file synchronization.

💡Applications

In the video, 'applications' refers to software programs that can be installed and run on the Shasta Scale system. Syncthing is one such application that the video focuses on installing and configuring. The term is used to discuss the broader context of software management on the system.

💡Host path

The host path is a configuration setting in the video that specifies the location on the host system where the application's data will be stored. The script mentions choosing 'host path' during the Syncthing installation process, which is important for mapping the application's data storage to a specific directory on the Shasta Scale system.

💡TCP and UDP ports

TCP (Transmission Control Protocol) and UDP (User Datagram Protocol) ports are networking concepts used for communication between applications. The video script discusses changing the default ports for Syncthing to avoid conflicts with other services, which is an important step in configuring network settings for proper application operation.

💡Shares

In the context of the video, shares refer to the directories or folders that are made available for synchronization through Syncthing. The script explains how to add and manage shares, which is a key feature of Syncthing for synchronizing files between devices.

💡Device ID

The Device ID in the video is a unique identifier for a device configured to use Syncthing. The script describes how to copy and paste the Device ID to connect different instances of Syncthing, which is necessary for establishing synchronization between devices.

💡Configuration settings

Configuration settings in the video refer to the various options and preferences that can be adjusted for Syncthing, such as folder paths, device connections, and synchronization rules. The script mentions that these settings are stored in a 'config.xml' file, which is important for maintaining the application's setup even after a system failure or restoration.

💡Snapshots and ZFS replication

Snapshots and ZFS replication are advanced storage features mentioned in the video that allow for data backup and recovery. The script notes that using these features ensures that not only the data but also the Syncthing configuration settings are preserved, which is crucial for system recovery and data integrity.

Highlights

Introduction to setting up Syncthing on TrueNAS SCALE 24.4, the current version at the time of release.

Explanation of potential application changes in version 24.10 and the possibility of creating a new tutorial if necessary.

Mention of an in-depth video on Syncthing for those unfamiliar with the software.

Demonstration of creating a data set for Syncthing in the root directory with the name 'syncthing demo'.

Choosing the 'apps' data set preset for correct permission settings, regardless of whether a share is added.

Option to add nested data sets for more granular control and snapshot capabilities.

Navigating to the 'Discover Apps' section to find and install Syncthing.

Customization options for the web and TCP/UDP ports to match existing Syncthing instances.

Selection of 'host path' as the storage type and mounting the 'syncthing demo' data set.

Completion of the Syncthing installation and accessing the web portal.

Enabling anonymous usage statistics and setting up device name and password for security.

Instructions on configuring Global Discovery, NAT traversal, and local relaying settings.

Demonstration of removing the default folder and adding a new share from a local system.

Process of adding a device by copying its ID and specifying IP address and port number.

Connecting two devices and sharing files between them using Syncthing.

Explanation of sharing a folder and the importance of selecting the correct base path.

Adding a Windows share and the steps to restart the service and access shared files.

Discussion on the synchronization process and how changes in one system reflect in another.

Importance of the host path being a data set for backup and restoration purposes.

Advantages of using snapshots and ZFS replication for backup, including configuration settings.

Conclusion with an invitation to watch related videos, participate in forums, and subscribe for updates.

Transcripts

in this video we're going to show you

how to get sync things set up on shuras

scale

24.4 which is the most current version

as of this release I know there's some

application changes coming in 2410 this

should still work but if it doesn't well

I'll just have to make a new video If

you're not familiar with syncthing I

already made a more in-depth video

covering all the details about syncthing

this video is just going to cover how to

set up syncthing on shest how to get the

permissions properly configured and if

you want to add a share to it how that

would work as well so let's get started

[Music]

this is tress scale Dragonfish

24.4.2 and the first thing we want to do

is make sure we have a spot to store our

syncthing data so we're going to here to

data sets we're going to click on the

pool that I'm going to put it in you can

put it in a nested data set if you want

we're just going to create it right in

the root here we want to add the data

set and we want to say sync thing demo

and the type of data set preset we want

to choose is apps even if you're going

to add a share or not add a share still

choose apps because this will set all

the permissions exactly as they need to

be we're going to hit

save and now we have our sync thing demo

folder if you wanted to have more

granular control you can add data sets

and Nest them underneath and give the

folders the same name that is perfectly

fine because this will give you the

advantage of having extra snapshots you

could apply on a per data set basis goes

beyond the scope of this but yes that

will work that is something you can do

and yes you would set the permissions

for each Nesta data set to be exactly

the same for Simplicity we're just going

to call this one syncing demo and that's

where we're going to store everything

now the next step we want to go through

here is going to the applications

they're already set up they've already

been chosen to a pool they're already

set up on the demo pool but I have no

applications loaded so we're going to go

to discover apps and we're going to find

sync thing which happens to be right

here go ahead and click the

install change your name if you want I'm

just going to leave it at sync things

that same as fine one thing I like to

change though is not the web Port where

you have the admin controls but the TCP

port and I'll change the UDP port to be

the same the reason I Chang these to the

default setting is just because all the

other syn thing instances I have are at

the same port number and there's not

anything else loaded right now that's

conflicting with it if there was a

conflict with another app or service you

have then you would have to choose a

different port then we're going to go on

here choose our storage type and we're

going to choose host path we're going to

go down here to Mount demo pool sync

thing demo we don't really need to do

anything else all the other

configuration can say exactly as it is

and we'll just go ahead and hit

install all right now the system's up

and running we can go to the web portal

and of course this can ask if you want

to participate in Anonymous usage I'm

going to say yes but that is a personal

choice you can make it does give you the

warning here that the interface does not

have a password on it we're going to go

ahead and fix those things so we're

going to in settings I'll give this

device name sync thing tras demo

we'll go over here to the gooey we'll go

ahead and put a password on there so it

doesn't

complain now do not change this and it

does warn you that this was overridden

anyways so if you change it it's going

to ignore it but don't mess with that

there's not a need to and as I noted my

other syncthing video is up to you if

you want to leave these on or off the

Global Discovery natur rval and local

relaying and Discovery these are options

that I cover in my other video It's A

beaconing system that allows it ease of

use of finding other syn thing servers

not going to use that so we're going to

go ahead and hit save it allows me to

log back in I'm going to delete the

default folder cuz I don't have a use

for it so we're going to ahead and hit

remove say yes and since I don't have

any data on this we're going to switch

over to a system that I do have data on

and share it back with this system here

so this is running locally on my system

and at the top here you can see it says

pop OS and this one says syncthing demo

first step is go to show ID we're going

to copy the

ID and we want to add a device here

paste in the ID go to advance and

specify the IP address and port number

this is the IP address of my chass

system and Port 22,000 was the

overridden Port from the default that I

put in there which is actually the

default port for sync thing so go ahead

and save

this then we're going to get

confirmation to add the device here

we'll go ahead and hit save so now the

two devices are connected now we're back

over on my popos system and we're going

to go and share it with that trass demo

so go here here is sharing there's our

trass demo hit

save there's a couple files in

here this is receiving the share so

we're going to go ahead and add it now

when you accept the share you can leave

the folder base path the same that's

because the folder base path is the path

that we specified inside of the settings

when we set the app up so we're going to

go ahead and hit save

here and we see that it's up to date now

let's talk about the sharing and for

that we want to go to shares and we want

to add a Windows share if we look here

we see Mount demo pool syncing demo and

there's that demo folder you can share

out the folder or you can share out the

sync thing demo but if you share out

sync thing demo all shares will be

visible maybe you only want this share

visible so we're going to keep it simple

and just do this share right here and

we're going to go ahead and hit

save go ahead and restart the

service and right here we can see that

share per demo so we'll go ahead and

double click on it

and I've already logged in and here's

the files that are in there if we wanted

to add another file that's not a problem

they pull up something out of another

directory we'll grab a bunch of these

screenshots that I have right here we'll

paste them into

here and then we can look in the sync

thing and now you see it found 93 more

files it's up to

date and the demo folder here now also

has those 93 files in it so it's syncing

ing properly on the system matter of

fact demo syncs locally here if we go to

my home we look at demo and if we change

things on here like I don't really need

that in there so we'll go ahead and hit

delete it's now deleted out of there and

it will resynchronize and you'll see the

file count change here we can force it

do a rescan and there we go it's now

back down to only three files in

here this is on the popos system and we

can look on this system and we can see

it also only has three files so you can

see the s ionization is working both in

syncthing and in the different share

that I have on there now the host path

we specified was a data set we created

called sync thing demo as noted you

could create several more underneath of

it but that does require they exist

prior to you doing the share for example

the folder we created called demo

created that folder called demo

underneath there but if you want to

create a data set called demo you have

to do it prior to having shared and

accepted and pointed at that particular

directory so nesting them under there is

no problem but just note it takes a

little bit of planning if you plan to

have a whole series of shares and you

want each share in its own data set or

you can do as I did in this video for

Simplicity just have them all under the

one data set when you back up that data

set if you use something like snapshots

plus ZFS replication all of the

configuration settings are in there as

well so you have your data which is in

those folders but there's also a config

directory that has a config.xml file for

all the settings and all the different

systems that that that sync thing is

attached to so all of that is in there

that way if you ever had the tra system

completely fail on you suffer

catastrophic failure where the

application has to be reloaded you

simply point it back at the host path

and syn thing will go hey there's a

config.xml file I will use that one

instead of creating a new one because it

does check if one exists when you set it

up if it finds an existing one all the

settings come back and anything you'd

customized and all your different

settings such as versioning will all be

set up just the same so it's pretty easy

to back up and restore do watch my video

If you're not familiar with how trass

replication works you'll find that link

down in the trass playlist down below

leave your thoughts and comments love

hearing back from all of you also head

over to my forums for a more in-depth

discussion on this other topics like And

subscribe to see more content from this

Channel and head over to lawen

systems.com sign up for the newsletter

if you want to keep up with the monthly

goings on at Lawrence systems and the

videos and different news articles that

I put in there all right and thanks

[Music]