TrueNAS CORETrueNAS CORE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

Configuring S3

Due to security vulnerabilities and maintainability issues, the S3 service is deprecated in TrueNAS CORE 13.0 and removed in CORE 13.3. Beginning in CORE 13.0-U6, the CORE web interface generates an alert when the deprecated service is either actively running or is enabled to start on boot.

TrueNAS Enterprise
Beginning in CORE 13.0-U6, Enterprise customers with the S3 service running or enabled are prevented from upgrading to the next major version.

Users should plan to migrate to a separately maintained MinIO plugin or otherwise move any production data away from the S3 service storage location. Migrating from the built-in S3 service to the plugin could result in an extended data migration window and potential disruption to S3 data access.

See the CORE 13.0 MinIO Plugin tutorial for detailed migration instructions.

This tutorial describes how to start a local S3 service on TrueNAS and connect to it from a networked client system with the MinIO Browser, s3cmd, and S3 Browser.

Background S3 is an object storage protocol used by many major cloud providers, including Amazon Web Services™. On TrueNAS, the service is another way to store files. You can view these files with a web browser. S3 is the de facto standard for cloud-based storage. Organizations or online application developers can use TrueNAS with an S3 service. This can replace or archive expensive cloud storage.
Having large numbers of files (>100K for instance) in a single bucket with no sub-directories is not recommended. It can harm performance and cause stability issues.

Setting up the S3 service

Go to the Services page and find S3 on the list.


Click the toggle to stop the service if it is running. Select Start Automatically to start the service when TrueNAS boots.

Click the to configure the service.


See S3 screen for information on settings.

The IP address allows the service to listen on any IPv4 address. :: allows the same for any IPv6 address. Select the TrueNAS IP address to constrain it to a specific network.

Select a clean dataset. If there is no dataset, click CANCEL and then go to Storage > Pools and click > Add Dataset. MinIO manages files as objects. These objects cannot mix with other dataset files.

Configure the rest of the options as needed in your environment. Make sure to start the service after saving any changes.