mirror of
https://github.com/unshackle-dl/unshackle.git
synced 2026-11-22 00:45:10 +00:00
fix(services): route a service remote from services.<TAG>.dl.remote
Click picks the subcommand before the dl callback applies the service config, so Services.resolve_command now applies remote and server first. A REST API job routes from its request only.
This commit is contained in:
@@ -87,18 +87,37 @@ remote_services:
|
||||
If you configure exactly one server, unshackle uses it implicitly:
|
||||
|
||||
```bash
|
||||
unshackle dl EXAMPLE 0ABCDEF
|
||||
unshackle dl --remote EXAMPLE 0ABCDEF
|
||||
```
|
||||
|
||||
If you configure **more than one** server, you must pick one with `--server`:
|
||||
|
||||
```bash
|
||||
unshackle dl --server my_server EXAMPLE 0ABCDEF
|
||||
unshackle dl --remote --server my_server EXAMPLE 0ABCDEF
|
||||
```
|
||||
|
||||
With no `remote_services` configured at all, unshackle raises a clear error telling
|
||||
you to add the block shown above.
|
||||
|
||||
### Making a service remote by default
|
||||
|
||||
To run a service on the server without `--remote`, set `remote` in the
|
||||
[`services`](../../reference/configuration/services.md#services) block, not in the
|
||||
`services` sub-dict of `remote_services`. Add `server` to select one of several servers:
|
||||
|
||||
```yaml title="unshackle.yaml (client)"
|
||||
services:
|
||||
EXAMPLE:
|
||||
dl:
|
||||
remote: true
|
||||
server: my_server
|
||||
```
|
||||
|
||||
`unshackle dl EXAMPLE 0ABCDEF` and `unshackle search EXAMPLE "query"` then run on
|
||||
`my_server`. A `--server` on the command line overrides the configured server. The global
|
||||
`dl: remote: true` makes every `dl` run remote, but it has no effect on `search`.
|
||||
The REST API ignores both settings: a job runs remote only when its request asks for it.
|
||||
|
||||
---
|
||||
|
||||
## What happens during a download
|
||||
|
||||
@@ -13,7 +13,10 @@ Per-service configuration, keyed by the canonical service tag (for example `EXAM
|
||||
- **`title_map`**: an exact-match rename map applied to fetched titles (source name →
|
||||
desired name), so a service that names a title differently from your library still matches.
|
||||
- **`dl`**: per-service download defaults, using the same keys as the global
|
||||
[`dl`](download.md#dl) block.
|
||||
[`dl`](download.md#dl) block. Set `remote: true` to send the `dl` and `search` runs of that
|
||||
service to a [remote server](#remote_services) without `--remote`. Add `server` to select one of
|
||||
several servers. A `--server` on the command line overrides it. A REST API job ignores both keys.
|
||||
See [making a service remote by default](../../dev/rest-api/remote-sessions.md#making-a-service-remote-by-default).
|
||||
|
||||
Individual services may read any additional keys they define. unshackle hands the merged result
|
||||
(the service's own `config.yaml` with this block layered on top) to the service as `self.config`.
|
||||
|
||||
Reference in New Issue
Block a user