fofanov.dmitry/DFWebOS-Apps
1
0
Fork 0
Code Actions Activity

Дополнение: Добавлена ​​документация и примеры использования фреймворка приложений DFWebOS

Browse Source 
- Переведен файл README.md на русский язык и дополнен подробными инструкциями по упаковке и тестированию приложений для DFWebOS.

- Создан файл lint-apps.yml для GitHub Actions для проверки приложений в запросах на слияние.

- Обновлен файл .gitignore для добавления дополнительных временных и сборочных файлов.

- Добавлены файлы .gitkeep для поддержания структуры каталогов конфигурационных данных в Emby и Jellyfin.

- Создан файл dfwebos-app.yml для Emby с подробными метаданными и описанием.

- Добавлен файл docker-compose.yml для конфигурации сервиса Emby.

- Создан файл dfwebos-app.yml для Jellyfin с исчерпывающими сведениями о приложении.

- Добавлен файл docker-compose.yml для конфигурации сервиса Jellyfin.

- Реализован хук pre-start для Jellyfin для безопасной обработки миграций версий.

Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
Dmitry Fofanov
2026-04-28 20:24:41 +03:00
parent 8ea3946edf
commit a0c8997000
10 changed files with 829 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/lint-apps.yml
+13
View File
@@ -0,0 +1,13 @@
name: Lint apps
on:
pull_request_target:
branches:
- master
jobs:
lint-apps:
name: Lint apps
runs-on: ubuntu-latest
steps:
- uses: sharknoon/dfwebos-app-linter-action@d0b39f9ec5867fd001b05d5ddd6037dcc35f41bd
.gitignore
+29
View File
@@ -0,0 +1,29 @@
# Специально для Mac OS
.DS_Store
.AppleDouble
.LSOverride
._*
.Spotlight-V100
.Trashes
# Специальные файлы редактора
.idea/
.vscode/
*.swp
*.swo
*~
.cursorrules
# Создание артефактов
dist/
build/
out/
# Каталоги зависимостей
node_modules/
vendor/
# Временные файлы
tmp/
temp/
*.tmp
README.md
+486 -1
View File
@@ -1,2 +1,487 @@
# DFWebOS-Apps
# Фреймворк приложений DFWebOS
Если вы умеете писать код на любом языке, значит, вы уже знаете, как разрабатывать приложение для DFWebOS. Ограничений по языкам программирования, фреймворкам или базам данных нет. Приложения работают внутри изолированных контейнеров [Docker](https://docs.docker.com/), и единственное требование заключается в том, что они должны предоставлять веб-интерфейс.
> Некоторые серверные приложения могут вообще не иметь UI. В таком случае приложение должно отдавать простую веб-страницу со сведениями для подключения, QR-кодами, инструкциями по настройке и всем остальным, что нужно пользователю для подключения. Предполагается, что у пользователя никогда не будет доступа к CLI в DFWebOS.
Чтобы документ оставался коротким и понятным, мы не будем углубляться в сам процесс разработки приложения, а сосредоточимся на упаковке и тестировании уже существующего приложения.
Давайте сразу перейдем к делу и упакуем [BTC RPC Explorer](https://github.com/janoside/btc-rpc-explorer) - приложение на Node.js - для DFWebOS.
Это делается в 4 шага:
1. [🛳 Контейнеризация приложения с помощью Docker](#1-контейнеризация-приложения-с-помощью-docker)
1. [☂️ Упаковка приложения для DFWebOS](#2-️упаковка-приложения-для-dfwebos)
1. [🛠 Тестирование приложения в DFWebOS](#3-тестирование-приложения-в-dfwebos)
1. [Тестирование в среде разработки DFWebOS на локальной машине](#31-тестирование-в-среде-разработки-dfwebos-на-локальной-машине)
1. [Тестирование в DFWebOS, запущенной на физическом устройстве](#32-тестирование-в-dfwebos-запущенной-на-физическом-устройстве)
1. [🚀 Отправка приложения](#4-отправка-приложения)
___
## 1. 🛳&nbsp;&nbsp;Контейнеризация приложения с помощью Docker
1\. Начнем с клонирования BTC RPC Explorer на нашу систему:
```sh
git clone --branch v2.0.2 https://github.com/janoside/btc-rpc-explorer.git
cd btc-rpc-explorer
```
2\. Далее создадим `Dockerfile` в каталоге приложения:
```Dockerfile
FROM node:12-buster-slim AS builder
WORKDIR /build
COPY . .
RUN apt-get update
RUN apt-get install -y git python3 build-essential
RUN npm ci --production
FROM node:12-buster-slim
USER 1000
WORKDIR /build
COPY --from=builder /build .
EXPOSE 3002
CMD ["npm", "start"]
```
### Хороший Dockerfile:
- [x] Использует легковесный базовый образ, что уменьшает потребление места и ускоряет установку приложения.
- [x] Использует [многоэтапные сборки](https://docs.docker.com/develop/develop-images/multistage-build/) для уменьшения размера образа.
- [x] Исключает файлы разработки из итогового образа.
- [x] Содержит только один сервис на контейнер.
- [x] Не запускает сервис от имени root.
- [x] Использует удаленные ресурсы, проверяемые по контрольной сумме.
- [x] Обеспечивает детерминированные сборки образов.
3\. Теперь мы готовы собрать Docker-образ BTC RPC Explorer. DFWebOS поддерживает как 64-битные ARM-, так и x86-архитектуры, поэтому мы будем использовать `docker buildx`, чтобы собрать, промаркировать и отправить мультиархитектурные Docker-образы нашего приложения в Docker Hub. Так одно и то же приложение можно устанавливать как на ARM-, так и на x86-устройства.
```sh
docker buildx build --platform linux/arm64,linux/amd64 --tag getwebos/btc-rpc-explorer:v2.0.2 --output "type=registry" .
```
> Чтобы использовать `docker buildx`, необходимо включить ["experimental features"](https://docs.docker.com/engine/reference/commandline/cli/#experimental-features) в Docker.
___
## 2. ☂️&nbsp;&nbsp;Упаковка приложения для DFWebOS
1\. Сначала сделаем fork репозитория [getwebos/dfwebos-apps](https://github.com/getwebos/dfwebos-apps) на GitHub, клонируем наш fork локально, создадим новую ветку для приложения и переключимся на нее:
```sh
git clone https://github.com/<YOUR-GITHUB-USERNAME>/dfwebos-apps.git
cd dfwebos-apps
```
2\. Теперь нужно выбрать ID для приложения. ID приложения должен содержать только строчные латинские буквы и дефисы, а также быть читаемым и узнаваемым. Для этого приложения мы используем `btc-rpc-explorer`.
Нужно создать новый подкаталог в директории `apps` с тем же именем, что и ID нашего приложения, и перейти в него:
```sh
mkdir btc-rpc-explorer
cd btc-rpc-explorer
```
3\. Внутри директории приложения создадим каркас со следующими файлами:
- `docker-compose.yml` - используется для запуска и остановки Docker-контейнеров вашего приложения
- `dfwebos-app.yml` - файл манифеста приложения, чтобы DFWebOS знал имя и версию приложения
- `exports.sh` - shell-скрипт для экспорта переменных окружения, используемых в `docker-compose.yml`, и для передачи их другим установленным приложениям
Теперь создадим в этой директории файл `docker-compose.yml`, чтобы описать наше приложение.
> Не знакомы с Docker Compose? Это простой инструмент для описания и запуска Docker-приложений, которые могут состоять из нескольких контейнеров. Следуйте этому руководству: если вы уже понимаете основы Docker, все будет несложно.
Скопируйте следующий шаблон `docker-compose.yml` в текстовый редактор и измените его под ваше приложение.
```yml
version: "3.7"
services:
app_proxy:
environment:
# <app-id>_<web-container-name>_1
# например, 'btc-rpc-explorer_web_1'
# Обратите внимание, что суффикс '_1' в конце обязателен
APP_HOST: <web-container-dns-name>
APP_PORT: <web-container-port-number>
web:
image: <docker-image>:<tag>@sha256:<digest>
restart: on-failure
stop_grace_period: 1m
ports:
# Не нужно публиковать порт, который слушает веб-сервер вашего приложения,
# если вы используете сервис app_proxy.
# Это обрабатывается переменными окружения APP_HOST и APP_PORT в сервисе выше.
#
# Если нужно открыть дополнительные порты, можно сделать это так,
# заменив <port> на нужный номер порта:
- <port>:<port>
volumes:
# Раскомментируйте, чтобы смонтировать каталоги данных внутрь
# Docker-контейнера для хранения постоянных данных
# - ${APP_DATA_DIR}/foo:/foo
# - ${APP_DATA_DIR}/bar:/bar
#
# Раскомментируйте, чтобы смонтировать каталог данных LND только для чтения
# внутрь Docker-контейнера по пути /lnd
# - ${APP_LIGHTNING_NODE_DATA_DIR}:/lnd:ro
#
# Раскомментируйте, чтобы смонтировать каталог данных Bitcoin Core
# только для чтения внутрь Docker-контейнера по пути /bitcoin
# - ${APP_BITCOIN_DATA_DIR}:/bitcoin:ro
environment:
# Передавайте любые переменные окружения в приложение для конфигурации в виде:
# VARIABLE_NAME: value
#
# Ниже перечислены все переменные, которые DFWebOS предоставляет и которые можно
# передать в приложение
# Переменные окружения уровня системы
# $DEVICE_HOSTNAME - hostname устройства с сервером DFWebOS (например, "webos")
# $DEVICE_DOMAIN_NAME - доменное имя .local для сервера DFWebOS (например, "webos.local")
#
# Переменные окружения Tor-прокси
# $TOR_PROXY_IP - локальный IP Tor-прокси
# $TOR_PROXY_PORT - порт Tor-прокси
#
# Переменные окружения, относящиеся к приложению
# $APP_HIDDEN_SERVICE - адрес Tor hidden service, по которому будет доступно ваше приложение
# $APP_PASSWORD - уникальный пароль в открытом виде, который можно использовать для аутентификации в приложении; он показывается пользователю в UI DFWebOS
# $APP_SEED - уникальная 256-битная hex-строка (128 бит энтропии), детерминированно полученная из seed пользователя DFWebOS и ID вашего приложения
# Если у приложения есть дополнительные сервисы, например контейнер базы данных,
# их можно определить ниже:
# db:
# image: <docker-image>:<tag>@sha256:<digest>
# ...
```
YAML-файл манифеста приложения сообщает DFWebOS сведения о приложении, такие как имя, описание, зависимости, порт для доступа к приложению и т.д.
> Сейчас существуют две версии манифеста: `1` и `1.1`. Версия `1` является базовой и подходит для большинства приложений. Однако если приложению нужны hooks (скрипты, которые запускаются на разных этапах жизненного цикла приложения), необходимо использовать версию `1.1`. Hooks позволяют выполнять пользовательские действия на разных стадиях жизненного цикла приложения, например перед запуском (pre-start), после установки (post-install) и т.д. Если hooks не нужны, достаточно версии манифеста `1`.
```yml
manifestVersion: 1
id: btc-rpc-explorer
category: finance
name: BTC RPC Explorer
version: "3.3.0"
tagline: Simple, database-free blockchain explorer
description: >-
BTC RPC Explorer is a full-featured, self-hosted explorer for the
Bitcoin blockchain. With this explorer, you can explore not just the
blockchain database, but also explore the functional capabilities of your
DFWebOS.
It comes with a network summary dashboard, detailed view of blocks, transactions, addresses, along with analysis tools for viewing stats on miner activity, mempool summary, with fee, size, and age breakdowns. You can also search by transaction ID, block hash/height, and addresses.
It's time to appreciate the "fullness" of your node.
releaseNotes: >-
Dark mode is finally here! Easily switch between your preferred mode
in one click.
This version also includes lots of minor styling improvements, better
error handling, and several bugfixes.
developer: Dan Janosik
website: https://explorer.btc21.org
dependencies:
- bitcoin
- electrs
repo: https://github.com/janoside/btc-rpc-explorer
support: https://github.com/janoside/btc-rpc-explorer/discussions
port: 3002
gallery:
- 1.jpg
- 2.jpg
- 3.jpg
path: ""
defaultUsername: ""
defaultPassword: ""
submitter: DFWebOS
submission: https://github.com/getwebos/dfwebos/pull/334
```
При отправке нового приложения оставьте поля `gallery` и `releaseNotes` пустыми. Используйте следующие значения:
```yml
gallery: []
releaseNotes: ""
```
Раздел `dependencies` в манифесте приложения сообщает DFWebOS список ID приложений, которые должны быть уже установлены, чтобы пользователь мог установить BTC RPC Explorer и чтобы оно корректно работало.
Shell-скрипт `exports.sh` - это простой скрипт для экспорта переменных окружения, которые может читать ваш `docker-compose.yml`. Эти переменные окружения также становятся доступными другим приложениям при запуске через их файлы `docker-compose.yml`. Большинству приложений эта возможность не потребуется.
Если бы мы, например, хотели предоставить другим приложениям доступ к Address API BTC RPC Explorer, это выглядело бы так:
```sh
export APP_BTC_RPC_EXPLORER_ADDRESS_API="electrumx"
```
4\. Для нашего приложения мы заменим `<docker-image>` на `getwebos/btc-rpc-explorer`, `<tag>` на `v2.0.2`, `<digest>` на `f8ba8b97e550f65e5bc935d7516cce7172910e9009f3154a434c7baf55e82a2b`, а `<port>` на `3002`. Поскольку BTC RPC Explorer не нужно хранить постоянные данные и ему не требуется доступ к каталогам данных Bitcoin Core или LND, мы можем удалить весь блок `volumes`.
> Digest - это уникальный неизменяемый идентификатор Docker-образа. В файле `docker-compose.yml` он имеет приоритет над tag. Мы хотим подтягивать образ по digest, потому что так гарантированно получаем в точности один и тот же образ при каждом запуске, и именно этот образ был протестирован и подтвержден как рабочий в DFWebOS. Важно убедиться, что это мультиархитектурный digest, а не digest для конкретной архитектуры.
BTC RPC Explorer - это приложение с одним Docker-контейнером, поэтому нам не нужно определять дополнительные сервисы (например, сервис базы данных) в compose-файле.
> Если бы BTC RPC Explorer нужно было сохранять какие-то данные, мы бы создали новый каталог `data` рядом с `docker-compose.yml`. Затем мы бы смонтировали том `- ${APP_DATA_DIR}/data:/data` в `docker-compose.yml`, чтобы этот каталог был доступен в контейнере по пути `/data`.
Обновленный файл `docker-compose.yml`:
```yml
version: "3.7"
services:
app_proxy:
environment:
APP_HOST: btc-rpc-explorer_web_1
APP_PORT: 8080
web:
image: getwebos/btc-rpc-explorer:v2.0.2@sha256:f8ba8b97e550f65e5bc935d7516cce7172910e9009f3154a434c7baf55e82a2b
restart: on-failure
stop_grace_period: 1m
environment:
BTCEXP_PORT: 8080
```
5\. Далее зададим переменные окружения, необходимые приложению для подключения к Bitcoin Core, Electrum server и для конфигурации самого приложения ([как того требует приложение](https://github.com/janoside/btc-rpc-explorer/blob/master/.env-sample)).
Итоговая версия `docker-compose.yml` будет такой:
```yml
version: "3.7"
services:
app_proxy:
environment:
APP_HOST: btc-rpc-explorer_web_1
APP_PORT: 8080
web:
image: getwebos/btc-rpc-explorer:v2.0.2
restart: on-failure
stop_grace_period: 1m
environment:
PORT: 8080
# Данные для подключения к Bitcoin Core
BTCEXP_BITCOIND_HOST: $APP_BITCOIN_NODE_IP
BTCEXP_BITCOIND_PORT: $APP_BITCOIN_RPC_PORT
BTCEXP_BITCOIND_USER: $APP_BITCOIN_RPC_USER
BTCEXP_BITCOIND_PASS: $APP_BITCOIN_RPC_PASS
# Данные для подключения к Electrum
BTCEXP_ELECTRUMX_SERVERS: "tcp://$APP_ELECTRS_NODE_IP:$APP_ELECTRS_NODE_PORT"
# Конфигурация приложения
BTCEXP_HOST: 0.0.0.0
DEBUG: "btcexp:*,electrumClient"
BTCEXP_ADDRESS_API: electrumx
BTCEXP_SLOW_DEVICE_MODE: "true"
BTCEXP_NO_INMEMORY_RPC_CACHE: "true"
BTCEXP_PRIVACY_MODE: "true"
BTCEXP_NO_RATES: "true"
BTCEXP_RPC_ALLOWALL: "false"
BTCEXP_BASIC_AUTH_PASSWORD: ""
```
6\. Здесь мы почти закончили. Следующий шаг - закоммитить изменения, отправить их в ветку нашего fork и протестировать приложение в DFWebOS.
```sh
git add .
git commit -m "Add BTC RPC Explorer"
git push
```
___
## 3. 🛠&nbsp;&nbsp;Тестирование приложения в DFWebOS
🚨 Это текущий процесс тестирования приложения в DFWebOS 1.x. Фреймворк приложений находится в активной разработке, и этот процесс в будущем изменится. Для тестирования в DFWebOS 0.5.4 обратитесь к [предыдущей версии этого документа](https://github.com/getwebos/dfwebos-apps/blob/9eae789b8512ef2a213805524e17f33d2128e33e/README.md).
### 3.1 Тестирование в среде разработки DFWebOS на локальной машине
Среда разработки DFWebOS (dfwebos-dev) требует Docker-окружение, которое предоставляет IP-адреса контейнеров хосту. Именно так Docker работает нативно в Linux, а в macOS этого можно добиться с помощью OrbStack, а в Windows - с помощью WSL 2.
1\. Установите [OrbStack](https://orbstack.dev/) на macOS или [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install) вместе с Docker Desktop на Windows.
2\. Клонируйте репозиторий [getwebos/dfwebos](https://github.com/getwebos/dfwebos).
Из корня клонированного репозитория выполните следующую команду, чтобы посмотреть доступные команды dfwebos-dev:
```sh
npm run dev help
```
Чтобы запустить среду разработки, выполните команду:
```sh
npm run dev
```
> [!NOTE]
> Если вы запускаете среду разработки впервые, локальная сборка образа ОС может занять некоторое время.
После инициализации DFWebOS будет доступна по адресу http://dfwebos-dev.local.
3\. Скопируйте каталог приложения (исключая файлы `.gitkeep`) в каталог app-store в dfwebos-dev.
Для этого на локальной машине выполните:
```sh
rsync -av --exclude=".gitkeep" <path-to-your-forked-repo-on-local-machine>/btc-rpc-explorer dfwebos@dfv24-dev.local:/home/webos/dfwebos/app-stores/getwebos-dfwebos-apps-github-53f74447/
```
Если во время передачи будет запрошен пароль, используйте пароль, который вы задали при создании учетной записи DFWebOS.
4\. Установите приложение.
На домашнем экране DFWebOS откройте App Store, найдите BTC RPC Explorer, нажмите кнопку "Install" и дождитесь завершения установки.
Приложение также можно установить из командной строки. DFWebOS предоставляет веб-терминал, доступный через Settings > Advanced Settings > Terminal > DFWebOS, либо можно использовать скрипты dfwebos-dev для установки приложения через сервер RPC dfwebosd:
```sh
npm run dev client -- apps.install.mutate -- --appId btc-rpc-explorer
```
Вот и все. Теперь наше приложение BTC RPC Explorer должно быть доступно по адресу http://dfwebos-dev.local:3002
Чтобы удалить приложение, можно щелкнуть правой кнопкой мыши по его значку на домашнем экране и выбрать "Uninstall". Также удалить приложение можно с помощью скриптов dfwebos-dev:
```sh
npm run dev client -- apps.uninstall.mutate -- --appId btc-rpc-explorer
```
> [!WARNING]
> При тестировании приложения обязательно проверьте, что все состояние приложения, которое должно сохраняться, действительно сохраняется в томах.
>
> Хороший способ это проверить - перезапустить приложение (щелкните правой кнопкой мыши по значку приложения на домашнем экране и выберите "Restart"). Если какие-то данные теряются, значит их нужно привязать к постоянному тому.
>
> При остановке и последующем запуске приложения все данные в томах сохраняются, а все остальное отбрасывается. При удалении и повторной установке приложения удаляются даже постоянные данные.
### 3.2 Тестирование в DFWebOS, запущенной на физическом устройстве
Запустить DFWebOS можно несколькими способами:
1. [Установить DFWebOS на Raspberry Pi 5](https://github.com/getwebos/dfwebos/wiki/Install-DFWebOS-on-a-Raspberry-Pi-5)
2. [Установить DFWebOS на любую x86-систему](https://github.com/getwebos/dfwebos/wiki/Install-DFWebOS-on-x86-Systems)
3. [Установить DFWebOS в виртуальную машину](https://github.com/getwebos/dfwebos/wiki/Install-DFWebOS-on-a-Linux-VM)
4. [Приобрести DFWebOS Home](https://dfwebos.com/dfwebos-home)
Независимо от выбранного способа, после того как DFWebOS будет запущена и вы откроете http://dfwebos.local и создадите учетную запись, можно выполнить следующие шаги для тестирования приложения.
1\. Скопируйте каталог приложения (исключая файлы `.gitkeep`) в каталог app-store на вашем устройстве с DFWebOS.
Для этого на локальной машине выполните:
```sh
rsync -av --exclude=".gitkeep" <path-to-your-forked-repo-on-local-machine>/btc-rpc-explorer dfwebos@dfwebos.local:/home/dfwebos/dfwebos/app-stores/getwebos-dfwebos-apps-github-53f74447/
```
Если во время передачи будет запрошен пароль, используйте пароль, который вы задали для устройства с DFWebOS при создании учетной записи.
2\. Установите приложение на устройство с DFWebOS:
На домашнем экране DFWebOS откройте App Store, найдите BTC RPC Explorer, нажмите кнопку "Install" и дождитесь завершения установки.
Приложение также можно установить из командной строки. DFWebOS предоставляет веб-терминал, доступный через Settings > Advanced Settings > Terminal > DFWebOS, либо можно подключиться к устройству по SSH с локальной машины через `ssh dfwebos@dfwebos.local`, используя тот же пароль, который вы задали для устройства с DFWebOS при создании учетной записи.
```sh
dfwebosd client apps.install.mutate --appId btc-rpc-explorer
```
Вот и все. Теперь приложение должно быть доступно по адресу http://dfwebos.local:3002
Чтобы удалить приложение, можно щелкнуть правой кнопкой мыши по его значку на домашнем экране и выбрать "Uninstall". Также удалить приложение из командной строки можно так:
```sh
dfwebosd client apps.uninstall.mutate --appId btc-rpc-explorer
```
> [!WARNING]
> При тестировании приложения обязательно проверьте, что все состояние приложения, которое должно сохраняться, действительно сохраняется в томах.
>
> Хороший способ это проверить - перезапустить приложение (щелкните правой кнопкой мыши по значку приложения на домашнем экране и выберите "Restart"). Если какие-то данные теряются, значит их нужно привязать к постоянному тому.
>
> При остановке и последующем запуске приложения все данные в томах сохраняются, а все остальное отбрасывается. При удалении и повторной установке приложения удаляются даже постоянные данные.
___
## 4. 🚀&nbsp;&nbsp;Отправка приложения
Теперь мы готовы открыть pull request в основном репозитории приложений [getwebos/dfwebos-apps](https://github.com/getwebos/dfwebos-apps), чтобы отправить наше приложение. Скопируйте следующий Markdown для описания pull request, заполните его нужными деталями и откройте pull request.
```
# App Submission
### App name
...
### 256x256 SVG icon
_(Upload an icon with no rounded corners as it will be dynamically rounded with CSS.)_
_We will help finalize this icon before the app goes live in the DFWebOS App Store._
...
### Gallery images
_(Upload 3 to 5 high-quality gallery images (1440x900px) of your app in PNG format, or just upload 3 to 5 screenshots of your app and we'll help you design the gallery images.)_
_We will help finalize these images before the app goes live in the DFWebOS App Store._
...
### I have tested my app on:
- [ ] DFWebOS on a Raspberry Pi
- [ ] DFWebOS on a DFWebOS Home
- [ ] DFWebOS on Linux VM
```
Вот где указанная выше информация используется, когда приложение становится доступно в DFWebOS App Store:
<img width="877" alt="image" src="https://github.com/getwebos/dfwebos-apps/assets/85373263/2297030f-909a-4e33-afac-398e30fc79c4">
> После отправки приложения мы проверим ваш pull request, внесем некоторые корректировки в `docker-compose.yml`, например уберем конфликты портов с другими приложениями, закрепим Docker-образы по их sha256 digest, назначим контейнерам уникальные IP-адреса и т.д., а затем выполним merge.
🎉 Поздравляем! Это все, что нужно сделать, чтобы упаковать, протестировать и отправить приложение в DFWebOS. Будем рады видеть вас среди авторов.
---
## Расширенная конфигурация
### App Proxy
DFWebOS App Proxy автоматически защищает приложение, требуя от пользователя ввести пароль DFWebOS либо при входе в основной Web UI, либо при прямом переходе в приложение, например по адресу `http://dfwebos.local:3002`
##### Отключение
В некоторых случаях может понадобиться отключить эту аутентификацию. Это можно сделать, добавив следующую переменную окружения в сервис `app_proxy` Docker Compose:
```
PROXY_AUTH_ADD: "false"
```
##### Белый список / черный список
Некоторые приложения размещают пользовательский UI в корне веб-приложения, а API, например, по пути `/api`. В таком случае желательно, чтобы `/` был защищен DFWebOS, а `/api` - встроенной системой токенов самого приложения. Этого можно добиться, добавив следующую переменную окружения в сервис `app_proxy` Docker Compose:
```
PROXY_AUTH_WHITELIST: "/api/*"
```
Другой пример: корень веб-приложения (`/`) должен быть общедоступным, а административный раздел - защищен DFWebOS. Это можно сделать, добавив следующие переменные окружения в сервис `app_proxy` Docker Compose:
```
PROXY_AUTH_WHITELIST: "*"
PROXY_AUTH_BLACKLIST: "/admin/*"
```
---
## FAQ
1. **Как отправлять обновления приложения?**
Каждый раз, когда вы выпускаете новую версию приложения, нужно собрать, промаркировать и отправить новые Docker-образы в Docker Hub. Затем откройте новый PR в наш основной репозиторий приложений (getwebos/dfwebos-apps), указав актуальный Docker-образ, а также обновленные поля `version` и `releaseNotes` в файле `dfwebos-app.yml` вашего приложения.
1. **Мне нужна помощь с чем-то еще**
Можете создать [issue](https://github.com/getwebos/dfwebos-apps/issues) в этом GitHub-репозитории.
emby/data/config/.gitkeep
+1
View File
@@ -0,0 +1 @@
emby/dfwebos-app.yml
+56
View File
@@ -0,0 +1,56 @@
manifestVersion: 1
id: emby
name: Emby
tagline: Персональный медиа-сервер
category: media
version: "4.9.3.0"
port: 8097
description: >-
▶️ Emby — это мощное программное обеспечение медиасервера, разработанное, чтобы помочь пользователям управлять, транслировать и наслаждаться своей личной коллекцией фильмов, телешоу, музыки, фотографий и домашнего видео на широком спектре устройств. Он действует как центральный узел для всех ваших цифровых медиа, автоматически организуя контент и обогащая его метаданными, такими как обложки, описания и рейтинги. Emby предоставляет понятный и интуитивно понятный интерфейс, который позволяет пользователям легко просматривать и воспроизводить медиафайлы, независимо от того, находятся ли они дома или в пути.
Система поддерживает широкий спектр устройств, включая смарт-телевизоры, смартфоны, планшеты, компьютеры, потоковые приставки и игровые консоли. Он предлагает функции прямого ТВ и поддержку DVR, если подключено совместимое оборудование тюнера. Одной из выдающихся особенностей Emby является его способность перекодировать мультимедиа в реальном времени, настраивая качество и формат видео в соответствии с возможностями используемого устройства и скоростью подключения к Интернету.
Emby включает инструменты управления пользователями, которые позволяют семьям создавать отдельные учетные записи с настраиваемыми ограничениями доступа и родительским контролем. Это особенно полезно для семей с детьми, поскольку помогает адаптировать медиа-опыт с учетом возраста и предпочтений в отношении контента.
Emby часто сравнивают с другими медиасерверами, такими как Plex и Jellyfin. В отличие от Jellyfin, исходный код которого полностью открыт, Emby перешла на проприетарную лицензию, что привело к созданию Jellyfin как форка, управляемого сообществом. Несмотря на это, Emby продолжает быстро развиваться и имеет обширную базу пользователей благодаря сочетанию простоты использования, богатого набора функций и профессионального уровня.
Подводя итог, можно сказать, что Emby — идеальное решение для тех, кто хочет получить полный контроль над своей медиатекой и беспрепятственно транслировать ее на различные устройства, сохраняя при этом персонализированную и конфиденциальную среду.
developer: Emby LLC
website: https://emby.media/
submitter: dennysubke
submission: https://github.dfv24.com/fofanov.dmitry/DFWebOS-Apps/pulls
repo: https://github.com/MediaBrowser/Emby
support: https://github.com/MediaBrowser/Emby/issues
gallery:
- 1.jpg
- 2.jpg
- 3.jpg
- 4.jpg
- 5.jpg
- 6.jpg
- 7.jpg
releaseNotes: >-
Этот выпуск включает в себя различные улучшения и исправления:
- Добавить пользовательскую опцию для установки автоматического удаленного качества пользователя.
- Добавлена опция библиотеки для использования устаревшего метода сканирования папок.
- Исправления перекодирования музыки.
- Добавлена опция целевой вкладки для книжных библиотек.
- Поддержка регулировки громкости с помощью проигрывателя трейлеров YouTube
- Обновите вкладки со смешанным контентом, чтобы объединить фильмы и шоу.
- Исправлен режим обслуживания, блокирующий некоторые экраны настроек.
- Исправлена ошибка, из-за которой встроенные аудиополя не сканировались повторно при изменении файла.
- Исправлена потеря изображений жанра и коллекции после удаления фильма.
Полный список изменений можно найти на странице https://github.com/MediaBrowser/Emby.Releases/releases.
dependencies: []
path: ""
defaultUsername: ""
defaultPassword: ""
permissions:
- STORAGE_DOWNLOADS
- GPU
emby/docker-compose.yml
+19
View File
@@ -0,0 +1,19 @@
version: '3.7'
services:
app_proxy:
environment:
APP_HOST: emby_server_1
APP_PORT: 8096
PROXY_AUTH_ADD: "false"
server:
image: linuxserver/emby:version-4.9.3.0@sha256:dbd1a3c83205445d13aad13362bdfa8478a6912541a1e32d654c550baf494e5a
environment:
TZ: Europe/Berlin
UID: 1000
GID: 1000
restart: on-failure
volumes:
- ${APP_DATA_DIR}/data/config:/config:rw
- ${DFWEBOS_ROOT}/data/storage/downloads:/downloads
jellyfin/data/config/.gitkeep
View File
jellyfin/dfwebos-app.yml
+51
View File
@@ -0,0 +1,51 @@
manifestVersion: 1.1
id: jellyfin
category: media
name: Jellyfin
version: "10.11.8"
tagline: Медиасистема свободного программного обеспечения
description: >-
Jellyfin — это медиа-решение, созданное добровольцами, которое позволяет вам контролировать свои медиа-ресурсы. Потоковая передача на любое устройство с вашего собственного сервера без каких-либо условий. Ваши медиа, ваш сервер, ваш путь.
Запустите сервер Jellyfin в своей системе и получите доступ к ведущей бесплатной развлекательной системе, включая все навороты.
Просматривайте свои мультимедиа через веб-браузер на вашем компьютере, из приложений на вашем Roku, Android, iOS (включая AirPlay), Android TV или устройстве Fire TV, а также через Chromecast или существующую установку Kodi.
У Jellyfin нет отслеживания, домашнего телефона или центральных серверов, собирающих ваши данные. Мы верим в необходимость сохранения открытости и прозрачности нашего программного обеспечения, и все, что мы можем собирать (журналы сбоев и т. д.), осуществляется только по согласию. Мы также не занимаемся медиа-бизнесом, поэтому единственные средства массовой информации, которые вы видите, — это ваши собственные.
Сервер и клиенты Jellyfin можно загрузить бесплатно сейчас и всегда. Использование Jellyfin ни для себя, ни для ваших друзей, ни для вашей компании не требует никаких затрат, скрытых или иных. Все наши непредвиденные расходы оплачиваются за счет пожертвований таких пользователей, как вы.
developer: Jellyfin
website: https://jellyfin.org/
dependencies: []
repo: https://github.com/jellyfin/jellyfin
support: https://github.com/jellyfin/jellyfin/issues
port: 8096
gallery:
- 1.jpg
- 2.jpg
- 3.jpg
path: ""
defaultUsername: ""
defaultPassword: ""
releaseNotes: >-
⚠️ Это обновление включает важные исправления безопасности. Всем пользователям настоятельно рекомендуется немедленно выполнить обновление.
Ключевые улучшения в этом выпуске:
- Исправлены регрессии, появившиеся в 10.11.7.
- Исправлено сохранение субтитров и обработка языка загрузки субтитров из библиотеки.
- Исправлен запрос мультимедиа с языковыми фильтрами.
- Улучшена стабильность и производительность системы.
Полные примечания к выпуску можно найти по адресу https://github.com/jellyfin/jellyfin/releases.
torOnly: false
permissions:
- STORAGE_DOWNLOADS
- GPU
submitter: DFWebOS
submission: https://github.dfv24.com/fofanov.dmitry/DFWebOS-Apps/pulls
jellyfin/docker-compose.yml
+22
View File
@@ -0,0 +1,22 @@
version: "3.7"
services:
app_proxy:
environment:
APP_HOST: jellyfin_server_1
APP_PORT: 8096
PROXY_AUTH_ADD: "false"
server:
image: linuxserver/jellyfin:10.11.8@sha256:e93bc100c6da07bd058678e4b634e4e71031fe840227e2ed03a1104f032bebe8
restart: on-failure
hostname: "${DEVICE_HOSTNAME}"
environment:
- PUID=1000
- PGID=1000
volumes:
- ${APP_DATA_DIR}/data/config:/config
- ${DFWEBOS_ROOT}/data/storage/downloads:/downloads
ports:
# Автообнаружение службы
- 7359:7359/udp
jellyfin/hooks/pre-start
Executable
+152
View File
@@ -0,0 +1,152 @@
#!/usr/bin/env bash
# Этот сценарий обрабатывает миграцию версий Jellyfin, чтобы обеспечить безопасное обновление через необходимые промежуточные версии.
set -euo pipefail
APP_DIR="$(readlink -f $(dirname "${BASH_SOURCE[0]}")/..)"
APP_DATA_DIR="${APP_DIR}/data"
APP_COMPOSE_FILE="${APP_DIR}/docker-compose.yml"
JELLYFIN_SYSTEM_FILE="${APP_DATA_DIR}/config/system.xml"
JELLYFIN_UPDATE_FLAG_FILE="${APP_DATA_DIR}/POST_1_10_VERSION"
MIGRATION_IN_PROGRESS_FILE="${APP_DATA_DIR}/MIGRATION_IN_PROGRESS"
MIGRATION_FIX_FLAG="${APP_DATA_DIR}/MIGRATION_20250618_FIXED"
# Если файлы базы данных еще не существуют
# Тогда скорее всего это новая установка
# Создайте файл флага, чтобы указать, что это версия 1.10+.
if [[ ! -f "${JELLYFIN_SYSTEM_FILE}" ]]; then
touch "${JELLYFIN_UPDATE_FLAG_FILE}"
touch "${MIGRATION_FIX_FLAG}"
fi
# Выйти, если файл флага существует
if [[ -f "${JELLYFIN_UPDATE_FLAG_FILE}" ]]; then
echo "Jellyfin update flag file already exists at ${JELLYFIN_UPDATE_FLAG_FILE}. Skipping migration steps."
exit 0
fi
# Проверьте, выполняется ли уже миграция, чтобы предотвратить бесконечные циклы.
if [[ -f "${MIGRATION_IN_PROGRESS_FILE}" ]]; then
echo "Migration already in progress, exiting to prevent loops"
exit 0
fi
# Отметить миграцию как выполняемую
touch "${MIGRATION_IN_PROGRESS_FILE}"
# Функция очистки ловушки
cleanup() {
local exit_code=$?
if [[ $exit_code -ne 0 ]]; then
echo "Migration failed, cleaning up..."
# Восстановить исходный файл компоновки, если у нас есть исходное изображение.
if [[ -n "${original_server_image:-}" ]]; then
yq -i ".services.server.image = \"${original_server_image}\"" "${APP_COMPOSE_FILE}" 2>/dev/null || true
fi
fi
rm -f "${MIGRATION_IN_PROGRESS_FILE}"
}
trap cleanup EXIT
# Если файл флага не существует, сначала обновите его до версии 1.10.7, а затем перейдите к последней версии.
echo "No POST_1_10_VERSION flag found - performing update to v1.10.7 and then to latest version"
# Образы Docker для промежуточного шага v1.10.7
INTERMEDIATE_SERVER_IMAGE="linuxserver/jellyfin:10.10.7@sha256:01c9d2311eb7710867fb3a8c2718068a276cff468a71d2a2dc58a0f5165ad0d2"
# Получить текущие изображения с docker-compose.yml
get_current_images_from_compose() {
local server_image=$(yq '.services.server.image' "${APP_COMPOSE_FILE}" 2>/dev/null || echo "")
echo "${server_image}"
}
# Обновить файл компоновки новыми изображениями.
update_compose_images() {
local server_image="${1}"
yq -i ".services.server.image = \"${server_image}\"" "${APP_COMPOSE_FILE}"
}
# Сохраните исходное изображение для последнего шага.
original_server_image=$(get_current_images_from_compose)
echo "Step 1: Updating to v1.10.7 for safe migration"
update_compose_images "${INTERMEDIATE_SERVER_IMAGE}"
# Начните с версии 1.10.7
echo "Starting Jellyfin v1.10.7..."
"${DFWEBOS_ROOT}/scripts/app" start jellyfin
# Дождитесь завершения запуска и миграции.
echo "Waiting for v1.10.7 to complete startup and migrations..."
# Конечная точка опроса работоспособности с тайм-аутом
MAX_WAIT=300
POLL_INTERVAL=5
elapsed=0
while [[ $elapsed -lt $MAX_WAIT ]]; do
if curl -sf "http://localhost:8096/health" > /dev/null 2>&1; then
echo "Jellyfin v1.10.7 is healthy after ${elapsed}s"
# Дайте дополнительное время для завершения оставшихся миграций.
sleep 10
break
fi
sleep $POLL_INTERVAL
elapsed=$((elapsed + POLL_INTERVAL))
done
if [[ $elapsed -ge $MAX_WAIT ]]; then
echo "Warning: Jellyfin health check timed out after ${MAX_WAIT}s, proceeding anyway"
fi
# Остановить приложение
echo "Stopping Jellyfin v1.10.7..."
"${DFWEBOS_ROOT}/scripts/app" stop jellyfin
# Примените исправление таблицы UserDatas к library.db BEFORE. Запускается версия 10.11.5.
# При миграции MigrateLibraryDb в версии 10.11.5 library.db будет переименован в library.db.old.
# Тогда MigrateLibraryUserData попытается прочитать UserDatas из library.db.old.
# Поэтому мы добавляем таблицу в library.db сейчас, прежде чем она будет переименована.
LIBRARY_DB="${APP_DATA_DIR}/config/data/data/library.db"
if [[ -f "${LIBRARY_DB}" && ! -f "${MIGRATION_FIX_FLAG}" ]]; then
echo "Applying UserDatas table fix to library.db (before 10.11.5 renames it)..."
if python3 -c "
import sqlite3
conn = sqlite3.connect('${LIBRARY_DB}')
cursor = conn.cursor()
cursor.execute('''
CREATE TABLE IF NOT EXISTS UserDatas (
key TEXT NOT NULL,
userId TEXT NOT NULL,
rating REAL,
played INTEGER NOT NULL,
playCount INTEGER NOT NULL,
isFavorite INTEGER NOT NULL,
playbackPositionTicks INTEGER NOT NULL,
lastPlayedDate TEXT,
AudioStreamIndex INTEGER,
SubtitleStreamIndex INTEGER,
PRIMARY KEY (key, userId)
)
''')
conn.commit()
conn.close()
"; then
echo "UserDatas table fix applied successfully"
touch "${MIGRATION_FIX_FLAG}"
else
echo "Failed to apply UserDatas table fix"
exit 1
fi
fi
echo "Step 2: Updating to latest version"
update_compose_images "${original_server_image}"
# Создайте файл флага, чтобы предотвратить повторный запуск этой миграции.
touch "${JELLYFIN_UPDATE_FLAG_FILE}"
echo "Migration completed: v1.10.7 -> latest version"
echo "Created ${JELLYFIN_UPDATE_FLAG_FILE} flag file"