Integration with a Bucket via S3 in SmartPlayer
Description of the Situation
The SmartPlayer platform now allows users to configure folder synchronization with an S3 bucket using smartFolder rules. After the rule is activated, the folder becomes a smart folder, and the system starts reading files from the specified bucket and copying them to the SmartPlayer server application.
How It Works
After the S3 rule is activated, the selected folder becomes a smart folder. From this point on, the SmartPlayer server application starts accessing the specified S3 bucket, reading the files stored in it, and copying them to the SmartPlayer server.
During synchronization, all available files are downloaded from each folder. When copying, the folder name specified on the client side is preserved. If, for example, the downloaded folder contains a `led_order_mate.json` file, it is not uploaded as a separate file but is used as the folder description, since the SmartPlayer server application does not upload JSON files as standalone content.
The configured S3 rule can be edited or deleted. When the rule is deleted, synchronization between the smart folder and the S3 bucket is disabled.
Procedure
To use this functionality, the user must register or log in to the SmartPlayer personal account.
Next, the user must go to the «Content» section and select the «Create Folder» line.
During the folder creation process, a modal window will be displayed where the user must enter the folder name. To complete the folder creation process, click the «Create» button.
Next, the user must select the folder by clicking it. This is required to open the control panel on the right.
In the control panel, the user must click the «Rules» line to open the modal window for creating rules.
To create a new rule, the user must click the «+» icon in the modal window.
After clicking the «+» icon, the rules page will open. The «Rule Name» parameter must be filled in immediately, since the user will subsequently be working at the bottom of the page, and the system will not allow the rule to be created without a specified name.
Scroll almost to the bottom of this page, find the «S3 Storage» section, and activate it using the switch.
After the switch is activated, the storage configuration parameters will become available. To configure the S3 parameters, fill in the following fields:
- update interval — specify a numeric value for the interval at which files are searched for within the storage. Measured in minutes;
- storage folder path — the path within the storage. The «/» character can be used. In this case, the system will search for files in all folders within the storage;
- access key — enter or paste the access key required for the system to operate, which the user receives after registering on the S3 platform;
- secret access key — enter or paste the secret access key required for the system to operate, which the user receives after registering on the S3 platform;
- region — enter the region name. Region information is also available when registering on S3;
- bucket — specify the bucket identifier as a unique link containing the bucket location, which can be obtained when registering on S3;
- host address — enter or paste the URL of the host where the bucket is located.
After completing the configuration, the user must click the «Save» button at the bottom of the screen.
After saving the rule, the user will be returned to the modal window containing the list of rules. The created rule can be edited or deleted using the icons displayed when hovering over the rule.
To exit the modal window and continue working, click the «Close» button.
Folder with Rules for Downloading Files from S3
After the user completes all the steps described above, they will be returned to the page containing the list of folders. The folder with the rule will receive the «Smart» label and become a «Smart Folder».
After the time specified in the «Update Interval» parameter has elapsed, the system will start downloading data from the S3 bucket and display it inside the downloaded folder.
Uploading JSON to a Folder
The SmartPlayer server application does not support direct uploading of JSON files, so all JSON files downloaded from the bucket will be displayed in the folder description. The description can be opened by clicking the «Edit» icon. This will open the folder parameters.
Useful Information
This section contains articles that are recommended for a better understanding of the features provided by the platform:
Video Tutorial
Bucket Integration and File Downloading
Additional Information
If this article does not help you use the functionality as intended or if you still have questions after reading it, you can ask them in the "Discussions" section at the top of the page.
Additional information can also be found on the page Как взаимодействовать пользователю с разделом "Обсуждения"
