Обновить README.md
This commit is contained in:
86
README.md
86
README.md
@@ -6,14 +6,14 @@
|
|||||||
|
|
||||||
## Содержание
|
## Содержание
|
||||||
|
|
||||||
|
- [Токен](#токен)
|
||||||
|
- [Как получить токен](#как-получить-токен)
|
||||||
- [Что умеет плагин](#что-умеет-плагин)
|
- [Что умеет плагин](#что-умеет-плагин)
|
||||||
- [Что не умеет и слабые места](#что-не-умеет-и-слабые-места)
|
- [Что не умеет и слабые места](#что-не-умеет-и-слабые-места)
|
||||||
- [Структура проекта](#структура-проекта)
|
- [Структура проекта](#структура-проекта)
|
||||||
- [Куда устанавливать](#куда-устанавливать)
|
- [Куда устанавливать](#куда-устанавливать)
|
||||||
- [Быстрый старт](#быстрый-старт)
|
- [Быстрый старт](#быстрый-старт)
|
||||||
- [Полная установка](#полная-установка)
|
- [Полная установка](#полная-установка)
|
||||||
- [Токен](#токен)
|
|
||||||
- [Как получить токен](#как-получить-токен)
|
|
||||||
- [CLI](#cli)
|
- [CLI](#cli)
|
||||||
- [Примеры wb-rules](#примеры-wb-rules)
|
- [Примеры wb-rules](#примеры-wb-rules)
|
||||||
- [Прямые Python-команды](#прямые-python-команды)
|
- [Прямые Python-команды](#прямые-python-команды)
|
||||||
@@ -24,6 +24,47 @@
|
|||||||
- [Частые ошибки](#частые-ошибки)
|
- [Частые ошибки](#частые-ошибки)
|
||||||
- [Удаление](#удаление)
|
- [Удаление](#удаление)
|
||||||
|
|
||||||
|
## Токен
|
||||||
|
|
||||||
|
Проект ищет токен в таком порядке:
|
||||||
|
|
||||||
|
1. аргумент `--token`;
|
||||||
|
2. переменная окружения `YANDEX_TOKEN`;
|
||||||
|
3. файл `token.txt`;
|
||||||
|
4. `data/config.json`.
|
||||||
|
|
||||||
|
Надёжнее всего использовать `token.txt`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/opt/shd/plugins/alice/token.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Рекомендация по безопасности:
|
||||||
|
|
||||||
|
- для постоянной работы храни токен только в `token.txt` с правами `600`;
|
||||||
|
- `YANDEX_TOKEN` используй только временно для разовых команд, затем делай `unset YANDEX_TOKEN`.
|
||||||
|
|
||||||
|
Если токен неверный, при обновлении списка станций будет ошибка:
|
||||||
|
|
||||||
|
```text
|
||||||
|
YANDEX_OAUTH_TOKEN invalid: update token and retry
|
||||||
|
```
|
||||||
|
|
||||||
|
## Как получить токен
|
||||||
|
|
||||||
|
Создать собственное OAuth-приложение для этого сценария нельзя. Обычно используют токен,
|
||||||
|
полученный через официальные клиенты Яндекс.Музыки.
|
||||||
|
|
||||||
|
Рабочие варианты:
|
||||||
|
|
||||||
|
- Веб-сервис (может работать не для всех аккаунтов): [music-yandex-bot.ru](https://music-yandex-bot.ru/)
|
||||||
|
- Android-приложение (APK): [MarshalX/yandex-music-token releases](https://github.com/MarshalX/yandex-music-token/releases)
|
||||||
|
- Расширение для Google Chrome: [Yandex Music Token (Chrome Web Store)](https://chrome.google.com/webstore/detail/yandex-music-token/lcbjeookjibfhjjopieifgjnhlegmkib)
|
||||||
|
- Расширение для Mozilla Firefox: [Yandex Music Token (Firefox Add-ons)](https://addons.mozilla.org/en-US/firefox/addon/yandex-music-token/)
|
||||||
|
|
||||||
|
Во всех вариантах выше итог один: получить и скопировать OAuth-токен.
|
||||||
|
Исходный код инструментов открыт: [github.com/MarshalX/yandex-music-token](https://github.com/MarshalX/yandex-music-token).
|
||||||
|
|
||||||
## Что умеет плагин
|
## Что умеет плагин
|
||||||
|
|
||||||
- сохранить OAuth-токен Яндекса;
|
- сохранить OAuth-токен Яндекса;
|
||||||
@@ -189,47 +230,6 @@ cd /opt/shd/plugins/alice
|
|||||||
sudo systemctl enable --now shd-alice.service shd-alice-plugin.service
|
sudo systemctl enable --now shd-alice.service shd-alice-plugin.service
|
||||||
```
|
```
|
||||||
|
|
||||||
## Токен
|
|
||||||
|
|
||||||
Проект ищет токен в таком порядке:
|
|
||||||
|
|
||||||
1. аргумент `--token`;
|
|
||||||
2. переменная окружения `YANDEX_TOKEN`;
|
|
||||||
3. файл `token.txt`;
|
|
||||||
4. `data/config.json`.
|
|
||||||
|
|
||||||
Надёжнее всего использовать `token.txt`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
/opt/shd/plugins/alice/token.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
Рекомендация по безопасности:
|
|
||||||
|
|
||||||
- для постоянной работы храни токен только в `token.txt` с правами `600`;
|
|
||||||
- `YANDEX_TOKEN` используй только временно для разовых команд, затем делай `unset YANDEX_TOKEN`.
|
|
||||||
|
|
||||||
Если токен неверный, при обновлении списка станций будет ошибка:
|
|
||||||
|
|
||||||
```text
|
|
||||||
YANDEX_OAUTH_TOKEN invalid: update token and retry
|
|
||||||
```
|
|
||||||
|
|
||||||
## Как получить токен
|
|
||||||
|
|
||||||
Создать собственное OAuth-приложение для этого сценария нельзя. Обычно используют токен,
|
|
||||||
полученный через официальные клиенты Яндекс.Музыки.
|
|
||||||
|
|
||||||
Рабочие варианты:
|
|
||||||
|
|
||||||
- Веб-сервис (может работать не для всех аккаунтов): [music-yandex-bot.ru](https://music-yandex-bot.ru/)
|
|
||||||
- Android-приложение (APK): [MarshalX/yandex-music-token releases](https://github.com/MarshalX/yandex-music-token/releases)
|
|
||||||
- Расширение для Google Chrome: [Yandex Music Token (Chrome Web Store)](https://chrome.google.com/webstore/detail/yandex-music-token/lcbjeookjibfhjjopieifgjnhlegmkib)
|
|
||||||
- Расширение для Mozilla Firefox: [Yandex Music Token (Firefox Add-ons)](https://addons.mozilla.org/en-US/firefox/addon/yandex-music-token/)
|
|
||||||
|
|
||||||
Во всех вариантах выше итог один: получить и скопировать OAuth-токен.
|
|
||||||
Исходный код инструментов открыт: [github.com/MarshalX/yandex-music-token](https://github.com/MarshalX/yandex-music-token).
|
|
||||||
|
|
||||||
## CLI
|
## CLI
|
||||||
|
|
||||||
Основной интерфейс из терминала — `cli.sh`.
|
Основной интерфейс из терминала — `cli.sh`.
|
||||||
|
|||||||
Reference in New Issue
Block a user