Интеграция с бакетом через S3 в рамках SmartPlayer: различия между версиями
Нет описания правки |
Нет описания правки |
||
| (не показано 5 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
<languages/> | |||
<translate> | |||
<!--T:1--> | |||
== '''Описание ситуации''' == | == '''Описание ситуации''' == | ||
В платформе SmartPlayer появилась возможность настраивать синхронизацию папок с S3-бакетом с помощью правил smartFolder. После активации правила папка становится smart-папкой и система начинает считывать файлы из указанного бакета, копируя их на серверное приложение SmartPlayer. | В платформе SmartPlayer появилась возможность настраивать синхронизацию папок с S3-бакетом с помощью правил smartFolder. После активации правила папка становится smart-папкой, и система начинает считывать файлы из указанного бакета, копируя их на серверное приложение SmartPlayer. | ||
== '''Логика работы''' == | == '''Логика работы''' == | ||
После активации правила S3 выбранная папка становится smart-папкой. С этого момента серверное приложение SmartPlayer начинает обращаться к указанному S3-бакету, считывать хранящиеся в нём файлы и копировать их на сервер SmartPlayer.<br> | После активации правила S3 выбранная папка становится smart-папкой. С этого момента серверное приложение SmartPlayer начинает обращаться к указанному S3-бакету, считывать хранящиеся в нём файлы и копировать их на сервер SmartPlayer.<br> | ||
| Строка 6: | Строка 9: | ||
Настроенное правило S3 можно отредактировать или удалить. При удалении правила синхронизация smart-папки с S3-бакетом отключается. | Настроенное правило S3 можно отредактировать или удалить. При удалении правила синхронизация smart-папки с S3-бакетом отключается. | ||
== '''Алгоритм действий''' == | == '''Алгоритм действий''' == | ||
Для того чтобы воспользоваться функционалом пользователю необходимо зарегистрироваться или авторизоваться в личном кабинете SmartPlayer.<br> | Для того чтобы воспользоваться функционалом, пользователю необходимо зарегистрироваться или авторизоваться в личном кабинете SmartPlayer.<br> | ||
Следующим шагом ему необходимо перейти в раздел «Контент» и выбрать строку «Создать папку». | Следующим шагом ему необходимо перейти в раздел «Контент» и выбрать строку «Создать папку». | ||
[[File:Создание_папки_в_лк.png|thumb|center| Пример отображения раздела «Контент» и строки «Создать папку»|800px]] | [[File:Создание_папки_в_лк.png|thumb|center| Пример отображения раздела «Контент» и строки «Создать папку»|800px]] | ||
В процессе | В процессе создания папки будет отображено модальное окно, в котором необходимо ввести название папки. Завершить создание папки можно по нажатию на кнопку «Создать». | ||
[[File:Создание_папки_.png|thumb|center| Пример отображения модального окна для создания папки|800px]] | [[File:Создание_папки_.png|thumb|center| Пример отображения модального окна для создания папки|800px]] | ||
Далее пользователю необходимо выделить папку нажатием. Это нужно чтобы открыть панель управления справа. | Далее пользователю необходимо выделить папку нажатием. Это нужно, чтобы открыть панель управления справа. | ||
[[File:Выделение_и_нажатие.png|thumb|center| Пример отображения выделения папки и панели управления |800px]] | [[File:Выделение_и_нажатие.png|thumb|center| Пример отображения выделения папки и панели управления |800px]] | ||
В панели управления пользователю необходимо нажать на строку «Правила» и открыть модальное окно для создания правил. | В панели управления пользователю необходимо нажать на строку «Правила» и открыть модальное окно для создания правил. | ||
[[File:Создание_правила.png|thumb|center| Пример отображения строки «Правила»|800px]] | [[File:Создание_правила.png|thumb|center| Пример отображения строки «Правила»|800px]] | ||
Чтобы создать новое правило пользователь должен нажать на иконку «+» в модальном окне. | Чтобы создать новое правило, пользователь должен нажать на иконку «+» в модальном окне. | ||
[[File:Иконка_создания_правила.png|thumb|center| Пример отображения выделения папки и панели управления |800px]] | [[File:Иконка_создания_правила.png|thumb|center| Пример отображения выделения папки и панели управления |800px]] | ||
После нажатия на иконку «+» пользователю откроется страница с правилами. Необходимо сразу заполнить параметр «Название правила», так как впоследствии пользователь будет находиться в нижней части страницы, а система не позволит создать правило без указанного названия. | |||
[[File:Название_правила.png|thumb|center| Пример отображения страницы создания правил и параметра «Название правила» |800px]] | [[File:Название_правила.png|thumb|center| Пример отображения страницы создания правил и параметра «Название правила» |800px]] | ||
Данную страницу необходимо прокрутить почти до конца | Данную страницу необходимо прокрутить почти до конца, найти раздел «Хранилище S3» и активировать его с помощью переключателя. | ||
[[File:Настройки_хранилища.png|thumb|center| Пример отображения выделения папки и панели управления |800px]] | [[File:Настройки_хранилища.png|thumb|center| Пример отображения выделения папки и панели управления |800px]] | ||
После активации переключателя станут доступны параметры для настройки хранилища. Для настройки параметров S3 необходимо заполнить следующие поля: | |||
* интервал обновления — указывается числовое значение | * интервал обновления — указывается числовое значение периода поиска файлов внутри хранилища. Измеряется в минутах; | ||
* путь в папке хранилища — путь в рамках хранилища. Можно использовать символ «/». В таком случае система будет искать файлы по всем папкам в хранилище; | * путь в папке хранилища — путь в рамках хранилища. Можно использовать символ «/». В таком случае система будет искать файлы по всем папкам в хранилище; | ||
* ключ доступа — прописать или вставить ключ доступа необходимый для работы системы, который пользователь получает после регистрации на платформе S3; | * ключ доступа — прописать или вставить ключ доступа, необходимый для работы системы, который пользователь получает после регистрации на платформе S3; | ||
* секретный ключ доступа — прописать или вставить ключ доступа для работы системы, который пользователь получает после регистрации на платформе S3 | * секретный ключ доступа — прописать или вставить секретный ключ доступа, необходимый для работы системы, который пользователь получает после регистрации на платформе S3; | ||
* регион — прописать название региона. Информация о регионе также доступна при регистрации на S3; | * регион — прописать название региона. Информация о регионе также доступна при регистрации на S3; | ||
* бакет — | * бакет — указать идентификатор бакета в виде уникальной ссылки с расположением бакета, которую можно получить при регистрации на S3; | ||
* адрес хоста — прописать или вставить URL-адрес хоста, где расположен бакет. | * адрес хоста — прописать или вставить URL-адрес хоста, где расположен бакет. | ||
[[File:Активированные_поля_и_переключатель.png|thumb|center| Пример отображения | [[File:Активированные_поля_и_переключатель.png|thumb|center| Пример отображения включённого переключателя для настроек S3 и активных полей для заполнения |800px]] | ||
После завершения настройки пользователю необходимо нажать на кнопку «Сохранить» внизу экрана. | После завершения настройки пользователю необходимо нажать на кнопку «Сохранить» внизу экрана. | ||
[[File:Кнопка_сохранить_правила.png|thumb|center| Пример отображения кнопки «Сохранить» |800px]] | [[File:Кнопка_сохранить_правила.png|thumb|center| Пример отображения кнопки «Сохранить» |800px]] | ||
После сохранения правила пользователя вернёт к модальному окну со списком правил. Созданное правило можно отредактировать или удалить по иконкам, которые отображаются при наведении на правило. | |||
[[File:Иконки_в_модальном_окне.png|thumb|center| Пример отображения иконок|800px]] | [[File:Иконки_в_модальном_окне.png|thumb|center| Пример отображения иконок|800px]] | ||
Чтобы выйти из модального окна и продолжить взаимодействие | Чтобы выйти из модального окна и продолжить взаимодействие, необходимо нажать на кнопку «Закрыть». | ||
=== '''Папка с правилами для загрузки файлов с S3''' === | === '''Папка с правилами для загрузки файлов с S3''' === | ||
После того | После того как пользователь выполнит все описанные выше действия, его вернёт на страницу со списком папок. Папка с правилом получит подпись «Smart» и станет «Smart-папкой». | ||
{{Note|Подробнее о «Smart-папке» в разделе «Полезная информация»|warn}} | {{Note|Подробнее о «Smart-папке» можно узнать в разделе «Полезная информация».|warn}} | ||
[[File:Создание_Смарт_папкки.png|thumb|center| Пример отображения «Smart-папки» в личном кабинете |800px]] | [[File:Создание_Смарт_папкки.png|thumb|center| Пример отображения «Smart-папки» в личном кабинете |800px]] | ||
По истечении времени, указанного в параметре «Интервал обновления», система начнёт загрузку данных из S3-бакета и отобразит их внутри загруженной папки. | |||
[[File:Загруженные_файлы.png|thumb|center| Пример отображения загруженных файлов в папке |800px]] | [[File:Загруженные_файлы.png|thumb|center| Пример отображения загруженных файлов в папке |800px]] | ||
=== '''Загрузка JSON в папку''' === | === '''Загрузка JSON в папку''' === | ||
Серверное приложение SmartPlayer не поддерживает прямую загрузку JSON, | Серверное приложение SmartPlayer не поддерживает прямую загрузку JSON-файлов, поэтому все скачанные из бакета JSON-файлы будут отображаться в описании папки. Его можно открыть, нажав на иконку «Редактировать». Таким образом откроются параметры папки. | ||
[[File:JSON_и_описание.png|thumb|center| Пример отображения JSON отображаемого в описании папки |800px]] | [[File:JSON_и_описание.png|thumb|center| Пример отображения JSON-файла, отображаемого в описании папки |800px]] | ||
== '''Полезная информация''' == | == '''Полезная информация''' == | ||
В этом разделе будут представлены статьи, с которыми рекомендуется ознакомиться чтобы лучше | В этом разделе будут представлены статьи, с которыми рекомендуется ознакомиться, чтобы лучше понимать возможности, предоставляемые платформой: | ||
* [[Смарт папка]] | * [[Смарт папка]] | ||
== '''Видеоинструкция''' == | == '''Видеоинструкция''' == | ||
[ Интеграция с бакетом и скачивание файлов] | [https://vkvideo.ru/video-227547238_456239149 Интеграция с бакетом и скачивание файлов] | ||
== '''Дополнительная информация''' == | == '''Дополнительная информация''' == | ||
Если данная статья не помогает использовать функционал по назначению или после | Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы. | ||
[[File:Обсуждение_работы_с_бакетом.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]] | [[File:Обсуждение_работы_с_бакетом.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]] | ||
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]] | Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]] | ||
</translate> | |||
Текущая версия от 15:47, 13 августа 2026
Описание ситуации
В платформе SmartPlayer появилась возможность настраивать синхронизацию папок с S3-бакетом с помощью правил smartFolder. После активации правила папка становится smart-папкой, и система начинает считывать файлы из указанного бакета, копируя их на серверное приложение SmartPlayer.
Логика работы
После активации правила S3 выбранная папка становится smart-папкой. С этого момента серверное приложение SmartPlayer начинает обращаться к указанному S3-бакету, считывать хранящиеся в нём файлы и копировать их на сервер SmartPlayer.
При синхронизации из каждой папки скачиваются все доступные файлы. При копировании сохраняется название папки, указанное со стороны клиента. Если в скачиваемой папке находится, например, файл `led_order_mate.json`, он не загружается как отдельный файл, а используется как описание к папке, так как серверное приложение SmartPlayer не выгружает JSON-файлы как самостоятельный контент.
Настроенное правило S3 можно отредактировать или удалить. При удалении правила синхронизация smart-папки с S3-бакетом отключается.
Алгоритм действий
Для того чтобы воспользоваться функционалом, пользователю необходимо зарегистрироваться или авторизоваться в личном кабинете SmartPlayer.
Следующим шагом ему необходимо перейти в раздел «Контент» и выбрать строку «Создать папку».

В процессе создания папки будет отображено модальное окно, в котором необходимо ввести название папки. Завершить создание папки можно по нажатию на кнопку «Создать».

Далее пользователю необходимо выделить папку нажатием. Это нужно, чтобы открыть панель управления справа.

В панели управления пользователю необходимо нажать на строку «Правила» и открыть модальное окно для создания правил.

Чтобы создать новое правило, пользователь должен нажать на иконку «+» в модальном окне.

После нажатия на иконку «+» пользователю откроется страница с правилами. Необходимо сразу заполнить параметр «Название правила», так как впоследствии пользователь будет находиться в нижней части страницы, а система не позволит создать правило без указанного названия.

Данную страницу необходимо прокрутить почти до конца, найти раздел «Хранилище S3» и активировать его с помощью переключателя.

После активации переключателя станут доступны параметры для настройки хранилища. Для настройки параметров S3 необходимо заполнить следующие поля:
- интервал обновления — указывается числовое значение периода поиска файлов внутри хранилища. Измеряется в минутах;
- путь в папке хранилища — путь в рамках хранилища. Можно использовать символ «/». В таком случае система будет искать файлы по всем папкам в хранилище;
- ключ доступа — прописать или вставить ключ доступа, необходимый для работы системы, который пользователь получает после регистрации на платформе S3;
- секретный ключ доступа — прописать или вставить секретный ключ доступа, необходимый для работы системы, который пользователь получает после регистрации на платформе S3;
- регион — прописать название региона. Информация о регионе также доступна при регистрации на S3;
- бакет — указать идентификатор бакета в виде уникальной ссылки с расположением бакета, которую можно получить при регистрации на S3;
- адрес хоста — прописать или вставить URL-адрес хоста, где расположен бакет.

После завершения настройки пользователю необходимо нажать на кнопку «Сохранить» внизу экрана.

После сохранения правила пользователя вернёт к модальному окну со списком правил. Созданное правило можно отредактировать или удалить по иконкам, которые отображаются при наведении на правило.

Чтобы выйти из модального окна и продолжить взаимодействие, необходимо нажать на кнопку «Закрыть».
Папка с правилами для загрузки файлов с S3
После того как пользователь выполнит все описанные выше действия, его вернёт на страницу со списком папок. Папка с правилом получит подпись «Smart» и станет «Smart-папкой».

По истечении времени, указанного в параметре «Интервал обновления», система начнёт загрузку данных из S3-бакета и отобразит их внутри загруженной папки.

Загрузка JSON в папку
Серверное приложение SmartPlayer не поддерживает прямую загрузку JSON-файлов, поэтому все скачанные из бакета JSON-файлы будут отображаться в описании папки. Его можно открыть, нажав на иконку «Редактировать». Таким образом откроются параметры папки.

Полезная информация
В этом разделе будут представлены статьи, с которыми рекомендуется ознакомиться, чтобы лучше понимать возможности, предоставляемые платформой:
Видеоинструкция
Интеграция с бакетом и скачивание файлов
Дополнительная информация
Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы.

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"