Configuration Reference - MiCat-S/Mi302 GitHub Wiki

繁體中文 | 简体中文 | English

This page lists every key in the config file config.yaml: what it does, its default, the allowed range, whether you can change it in the web admin page, and whether it needs a restart. Normally you set everything in the web admin page and never edit the file. The web admin page is only in Traditional Chinese; labels below are translated, with the original in parentheses.

Use -c <path> at startup to choose a file. Without it, Mi302 uses the environment variable EMBYSERVER_CONFIG, and otherwise config.yaml in the current folder. The top of the Settings tab (設定) shows which file is in use.

• Created automatically: if there is no config file at the first start, Mi302 starts with defaults and writes a commented config file.
• Written back from the web page: saving settings in the web admin page regenerates the whole file from a template. The previous file is kept as config.yaml.bak. Your own comments and unknown keys are not kept.
• Editing the file by hand: after editing, open or refresh the web admin page. Mi302 notices that the file changed, reads it again and applies it.
• Mistakes: if the file is broken at startup (invalid YAML, a required key missing), Mi302 does not start. The reason is printed to the startup output, not to the log file: journalctl -u mi302 for the Linux service, data/logs/console.log on macOS and on systems without systemd, or the terminal for a manual start. If you break it while Mi302 is running, the web page shows an error at the top and Mi302 keeps using the last good settings.
• Checks at startup: edits made directly in the file skip the web page's checks, so Mi302 runs the same checks at startup (see "Checks and ranges" below). A sync task whose local folder is not a full path, or whose local folder overlaps another task's, is not used; an update proxy or GitHub accelerator that does not start with a valid scheme (such as http://) is also ignored (direct connection) until you fix it; other failed checks are only reported. Mi302 still starts, logs the problem and shows it at the top of the web page. Fix the file and reload the web page to apply it. Whenever the web page writes the file (for example when you save settings), the unused sync tasks and proxies are removed from it.
• Unknown keys: typos and keys left over from old versions are ignored with a warning (設定檔 … 底下不認得 …，已略過, "unknown key … under …, ignored"). Startup continues.

These are only read at startup. Restart Mi302 after changing them (mi302 restart with the one-line installer):

• server.host, server.port, server.data_dir
• users
• p115.cookies

Every other key takes effect as soon as you save it in the web page, or when you refresh the web page after editing the file.

When you save in the web page, or when Mi302 reads an edited file, it checks the settings. Invalid settings are not applied and the reason is shown. Numbers outside their range are changed to the nearest allowed value:

Other checks:

• Libraries: the name must not be empty or repeated, and each library needs at least one folder. Any type other than tvshows becomes movies.
• Sync tasks: both the 115 folder and the local folder are required; the local folder must be an absolute path; two tasks cannot use the same local folder or folders inside each other.
• moviepilot.url must start with http:// or https://; a trailing / is removed. The same goes for qbittorrent.url.
• Path mappings and path rules with an empty from or to are dropped.
• An empty mediainfo.ffprobe becomes ffprobe.
• aliyun.online_api must start with https:// or be empty (the refresh token travels in its URL, so not over plain HTTP); aliyun.client_id and aliyun.client_secret must be filled in together or both left empty.

These live in the database <data_dir>/library.db, not in the config file, and are included in the daily backup (see Backup and Restore):

• Accounts and passwords (stored as hashes only). Once an account exists, adding users, changing passwords or deleting users on the Users tab (使用者) never writes back to the config file.
• The 115 login: the QR or pasted cookie, and the 115 open-platform token.
• The Aliyun Drive refresh token (logged in under 115 Cloud → Aliyun rapid upload (阿里雲盤秒傳)).
• API keys created in the web admin page.
• 115 sync progress and index, and the automatically detected server address for strm files.
• Watch history, media info, learned intros and credits, and so on.

Related pages: Logs and FAQ, Library and Scanning, Intro and Credits, Playback, Backup and Restore.

Accounts created at startup. The default is users: [], and it is best left empty: the first time you open the web admin page, it asks you to create an administrator.

users:
  - name: admin
    password: your-password
    admin: true

• File only; restart.
• At every start, accounts in this list that do not exist yet are created (names are compared case-insensitively). Existing accounts are not changed, so changing a password here has no effect.
• Deleting an account in the web page also removes it from this list, so it is not created again at the next start. If the config file is broken and cannot be written, the web page says so; remove the account from the list yourself.
• Passwords are in plaintext, also in config.yaml.bak and in the .yaml backups. Once the accounts exist you can delete this block; the accounts stay in the database.

Libraries. The default is libraries: []. Create them on the Libraries tab with Add library (新增媒體庫) or Bulk add from a folder (從資料夾批量新增).

libraries:
  - name: Movies
    type: movies
    paths:
      - /media/movies
  - name: TV
    type: tvshows
    paths:
      - /media/tv

When libraries change, only the changed libraries are rescanned; a removed library's items are removed with it. See Library and Scanning.

The 115 login. Log in with the QR code in the web page; see 115 Cloud Sync.

Options for syncing into strm files. On the Sync options card (同步選項) of the 115 Cloud tab, click Save sync options (儲存同步選項).

interval and full_interval have no upper limit; 0 or a negative number turns them off.

Format of tasks:

p115:
  strm:
    tasks:
      - remote: /影視/電影
        local: /media/movies/115

• remote: the folder on 115. A missing leading / is added.
• local: the local folder for the strm files. It must be an absolute path inside a library.
• Two tasks cannot use the same local folder, or folders inside each other.

Scraping is delegated to MoviePilot. See MoviePilot.

moviepilot:
  path_mappings:
    - from: /media/psf/Vo
      to: /Volumes/Vo

Connects to qBittorrent: torrents that have been downloading with no speed for too long are deleted and the ones queued behind them start. See qBittorrent stalled torrents.

Probing the videos behind strm files with ffprobe and writing X-mediainfo.json. In the collapsed Settings section (設定) of the Media info card (媒體資訊) on the Tools tab (整理), the switches are saved as soon as they are switched; for the number fields, click Save settings (儲存設定). See Media Info.

A read-only WebDAV share: players browse 115 directly at http://<host>:<port>/dav/, and playback is a 302 to the 115 direct link. Change it under WebDAV on the Settings tab (設定) and click Save settings (儲存設定); it takes effect immediately. See Playback.

The Aliyun Drive (阿里雲盤) open platform, used by Rapid upload from Aliyun Drive. The refresh token is entered in the web page and stored in the database, not in this file. Change these on the 115 Cloud tab, Aliyun rapid upload (阿里雲盤秒傳), Aliyun Drive account (阿里雲盤帳號) card, under Advanced (進階), then click Save (儲存); they take effect immediately.

How strm contents are handled at playback, mainly for strm files made by other tools (for example alist URLs or local paths). For fields on the Settings tab, click Save settings at the bottom of the page. See Playback.

redirect:
  path_rules:
    - from: /mnt/115
      to: http://alist:5244/d/115

Fixed API keys that let other programs call the Emby API as an administrator, sent in the X-Emby-Token header or the api_key query parameter.

api_keys:
  - a-long-random-string

• File only. Takes effect when you refresh the web admin page; no restart needed.
• API keys cannot be used for the web admin page's own functions (settings, backups, the 115 login, accounts).
• Keys created with Create API key (建立 API 金鑰) on the MoviePilot tab are stored in the database and do not appear here. Those are usually the better choice; see MoviePilot.