121 lines
4.9 KiB
YAML
121 lines
4.9 KiB
YAML
name: metafeederscihub
|
|
|
|
# =============================================================================
|
|
# MetaFeeder · Sci-Hub — papers resolved through a Sci-Hub mirror.
|
|
#
|
|
# Opt-in: soft-skips (healthy, answers nothing) until SCIHUB_MIRRORS names at
|
|
# least one mirror. Split out of the former MetaFeeder · Papers app.
|
|
#
|
|
# It needs, over the shared `pcs` network:
|
|
# - the **MetaGateway** app — which must list this feeder's URL
|
|
# (`http://metafeederscihub-feeder:8080`) in its feeders config so it gets discovered.
|
|
# Discovery is startup-only, so restart the gateway afterwards.
|
|
#
|
|
# Everything is scoped under the `metafeederscihub-*` prefix + the per-stack `metafeederscihub` network +
|
|
# /DATA/AppData/metafeederscihub/ data root, so it installs beside the other Meta* apps with
|
|
# zero collisions.
|
|
# =============================================================================
|
|
|
|
services:
|
|
# ---------------------------------------------------------------------------
|
|
# metafeederscihub-feeder — the scihub feeder. Needs SCIHUB_MIRRORS to do anything.
|
|
# ---------------------------------------------------------------------------
|
|
metafeederscihub-feeder:
|
|
image: ghcr.io/worph/meta-feeder-scihub:1.0.2
|
|
cpu_shares: 30
|
|
container_name: metafeederscihub-feeder
|
|
hostname: metafeederscihub-feeder
|
|
restart: unless-stopped
|
|
user: "0:0"
|
|
expose:
|
|
- 8080
|
|
environment:
|
|
RUST_LOG: "info,meta_feeder=info"
|
|
META_FEEDER_STATE_DIR: "/data/meta-feeder"
|
|
# Opt-in. Uncomment + set mirrors to enable; blank → the feeder soft-skips.
|
|
# SCIHUB_MIRRORS: "https://sci-hub.se,https://sci-hub.st"
|
|
TZ: "$TZ"
|
|
volumes:
|
|
# Persist feeder config.json + redb cache so it survives recreate.
|
|
- ${DATA_ROOT:-/DATA}/AppData/metafeederscihub/state:/data/meta-feeder:rw
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-sf", "http://localhost:8080/health"]
|
|
interval: 5s
|
|
timeout: 3s
|
|
retries: 10
|
|
start_period: 5s
|
|
networks:
|
|
- pcs
|
|
networks:
|
|
pcs:
|
|
name: ${APP_NET:-pcs}
|
|
external: true
|
|
|
|
x-casaos:
|
|
architectures:
|
|
- amd64
|
|
- arm64
|
|
author: Worph Team
|
|
category: Media
|
|
developer: Aptero Team
|
|
|
|
description:
|
|
en_us: |
|
|
**Sci-Hub for the MetaMesh network.**
|
|
|
|
MetaFeeder · Sci-Hub resolves papers through one or more **Sci-Hub** mirrors you
|
|
configure. Without a mirror it stays healthy and simply finds nothing.
|
|
|
|
Sci-Hub distributes papers without publisher permission; whether using it is
|
|
lawful where you run this app is your responsibility.
|
|
**Requires:** **MetaGateway** — its meta-core stores the resolved records and
|
|
announces them to the swarm. The gateway must list this feeder in its config.
|
|
fr_fr: |
|
|
**Sci-Hub pour le réseau MetaMesh.**
|
|
|
|
MetaFeeder · Sci-Hub résout des articles via un ou plusieurs miroirs **Sci-Hub**
|
|
que vous configurez. Sans miroir, il reste sain et ne trouve rien.
|
|
|
|
Sci-Hub diffuse des articles sans l'autorisation des éditeurs ; la légalité de
|
|
son usage là où vous hébergez cette app relève de votre responsabilité.
|
|
**Nécessite** l'app **MetaGateway**.
|
|
tagline:
|
|
en_us: Papers via Sci-Hub mirrors you configure, for MetaMesh
|
|
fr_fr: Articles via les miroirs Sci-Hub que vous configurez, pour MetaMesh
|
|
|
|
title:
|
|
en_us: MetaFeeder · Sci-Hub
|
|
|
|
icon: https://cdn.jsdelivr.net/gh/Worph/MetaAppStore@main/Apps/MetaFeederSciHub/icon.png
|
|
thumbnail: https://cdn.jsdelivr.net/gh/Worph/MetaAppStore@main/Apps/MetaFeederSciHub/thumbnail.png
|
|
|
|
store_app_id: metafeederscihub
|
|
is_uncontrolled: false
|
|
|
|
tips:
|
|
before_install:
|
|
en_us: |
|
|
**Install order:** install **MetaGateway** first (its meta-core stores and
|
|
announces what this feeder finds).
|
|
|
|
**After installing this app:** in **MetaGateway**, add this feeder from the
|
|
dashboard's *Add a feeder* box — name `scihub-feeder`, URL `http://metafeederscihub-feeder:8080`.
|
|
The gateway restarts itself: feeder discovery is startup-only.
|
|
|
|
**Mirrors:** set `SCIHUB_MIRRORS` (comma-separated URLs) in this app's
|
|
environment, then restart the app. Without it the feeder soft-skips.
|
|
**No web UI of its own:** configure it from the **MetaGateway** dashboard → this feeder → *configure* (the gateway proxies this feeder's config page, behind the gateway's login).
|
|
|
|
# Maison (Yundera dashboard) configuration. Read in preference to x-casaos.
|
|
# schema_version 2 is required for `folders`: an older Maison refuses the app
|
|
# outright rather than starting it without its directories.
|
|
x-compose-app:
|
|
schema_version: 2
|
|
# Created and chowned by Maison before any image is pulled, before any hook
|
|
# runs and before the containers start — on the first boot and every one after.
|
|
# Compose would otherwise create a missing bind source as a root-owned dir.
|
|
folders:
|
|
- path: /DATA/AppData/metafeederscihub/state
|
|
user: $PUID
|
|
group: $PGID
|