Merge branch 'litneet64-app/rsshub'

2024-05-07 20:38:54 +02:00 · 2024-05-07 20:38:54 +02:00 · fbb803a5a5
commit fbb803a5a5
parent 2aa920c9fe 4b1224ac1a
9 changed files with 474 additions and 6 deletions
--- a/apps/photoprism/config.json
+++ b/apps/photoprism/config.json
@ -5,8 +5,8 @@
  "available": true,
  "exposable": true,
  "id": "photoprism",
-  "tipi_version": 4,
-  "version": "231021",
+  "tipi_version": 5,
+  "version": "240420",
  "categories": [
    "photography"
  ],
--- a/apps/photoprism/docker-compose.yml
+++ b/apps/photoprism/docker-compose.yml
@ -2,7 +2,7 @@ version: "3.7"
 services:
  photoprism:
    # TODO: Special image for arm/v7 is available
-    image: photoprism/photoprism:231021
+    image: photoprism/photoprism:240420
    container_name: photoprism
    depends_on:
      - photoprism-db
--- a/apps/rsshub/config.json
+++ b/apps/rsshub/config.json
@ -0,0 +1,27 @@
+{
+  "name": "RSSHub",
+  "available": true,
+  "port": 8223,
+  "exposable": true,
+  "id": "rsshub",
+  "description": "RSSHub is an open source, easy to use, and extensible RSS feed generator. It's capable of generating RSS feeds from pretty much everything.",
+  "tipi_version": 1,
+  "version": "2024-04-17",
+  "categories": ["utilities", "media"],
+  "short_desc": "Everything is RSSible with RSSHub",
+  "author": "https://github.com/DIYgod",
+  "source": "https://github.com/DIYgod/RSSHub",
+  "website": "https://docs.rsshub.app/",
+  "url_suffix": "",
+  "form_fields": [
+    {
+      "type": "password",
+      "label": "Access Key",
+      "max": 256,
+      "min": 4,
+      "required": false,
+      "env_variable": "ACCESS_KEY"
+    }
+  ],
+  "supported_architectures": ["amd64", "arm64"]
+}
--- a/apps/rsshub/data/app.env
+++ b/apps/rsshub/data/app.env
@ -0,0 +1,331 @@
+# Based on...:
+# https://docs.rsshub.app/deploy/config
+# 
+# and source-code values, as official docs are incomplete:
+# https://github.com/DIYgod/RSSHub/blob/master/lib/config.ts
+#
+
+#################################
+# Network Configuration
+#################################
+#
+#PORT=1200
+#LISTEN_INADDR_ANY=true
+#REQUEST_RETRY=2
+#REQUEST_TIMEOUT=30000
+UA="Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36"
+#NO_RANDOM_UA=null
+
+#################################
+# CORS Requests
+#################################
+#
+#ALLOW_ORIGIN="*"
+
+#################################
+# Cache Configurations 
+#################################
+#
+CACHE_TYPE="redis"
+#CACHE_REQUEST_TIMEOUT=60
+#CACHE_EXPIRE=300
+#CACHE_CONTENT_EXPIRE=3600
+REDIS_URL="redis://rsshub_redis:6379/"
+#MEMORY_MAX=256
+
+#################################
+# Proxy Configurations
+#################################
+# 
+#PROXY_PROTOCOL=""
+#PROXY_HOST=""
+#PROXY_PORT=""
+#PROXY_URI="{protocol}://{host}:{port}"
+#PROXY_AUTH="BASE64_BASIC_AUTH_STRING" (Proxy-Authorization: Basic ${PROXY_AUTH})
+#PROXY_URL_REGEX=".*"
+#PROXY_STRATEGY=all/on_retry
+#PAC_URI=""
+#PAC_SCRIPT=""
+
+#################################
+# Access Control Configurations
+#################################
+# 
+#ACCESS_KEY="yourpassword"
+
+#################################
+# Logging Configurations
+#################################
+#
+#DEBUG_INFO=true
+#LOGGER_LEVEL="info"
+#NO_LOGFILES=false
+#SHOW_LOGGER_TIMESTAMP=false
+#SENTRY=""
+#SENTRY_ROUTE_TIMEOUT=30000
+
+#################################
+# Image Processing
+#################################
+# 
+#HOTLINK_TEMPLATE="${protocol}//${host}${pathname}"
+#HOTLINK_INCLUDE_PATHS=""
+#HOTLINK_EXCLUDE_PATHS=""
+
+#################################
+# Experimental Features
+#################################
+#
+#ALLOW_USER_HOTLINK_TEMPLATE=false
+#FILTER_REGEX_ENGINE="re2"
+#ALLOW_USER_SUPPLY_UNSAFE_DOMAIN=false
+
+#################################
+# Other Application Configurations
+#################################
+# 
+#DISALLOW_ROBOT=true
+#ENABLE_CLUSTER=false
+NODE_ENV="production"
+#NODE_NAME=""
+PUPPETEER_WS_ENDPOINT="ws://rsshub_browserless:3000"
+#CHROMIUM_EXECUTABLE_PATH=""
+#TITLE_LENGTH_LIMIT=150
+#OPENAI_API_KEY=""
+#OPENAI_MODEL="gpt-3.5-turbo-16k"
+#OPENAI_TEMPERATURE=0.2
+#OPENAI_MAX_TOKENS=0
+#OPENAI_API_ENDPOINT="https://api.openai.com/v1"
+#OPENAI_PROMPT="Please summarize the following article and reply with markdown format."
+#REMOTE_CONFIG=""
+#REMOTE_CONFIG_AUTH="" (Authorization: Basic ${REMOTE_CONFIG_AUTH})
+
+#################################
+# Route-specific Configurations
+#################################
+#
+##  BiliBili  ##
+#BILIBILI_COOKIE_{uid}=""
+#BILIBILI_DM_IMG_LIST="[{"x":2721,"y":615,"z":0,"timestamp":29,"type":0}]"
+# 
+##  BitBucket  ##
+#BITBUCKET_USERNAME=""
+#BITBUCKET_PASSWORD=""
+#
+##  BTBYR  ##
+#BTBYR_HOST=""
+#BTBYR_COOKIE=""
+#
+##  BUPT  ##
+#BUPT_PORTAL_COOKIE=""
+#
+##  Civitai  ##
+#CIVITAI_COOKIE=""
+#
+##  Dida365  ##
+#DIDA365_USERNAME=""
+#DIDA365_PASSWORD=""
+#
+##  Discord  ##
+#DISCORD_AUTHORIZATION=""
+#
+##  Discourse  ##
+#DISCOURSE_CONFIG_{id}="{"link":link,"key":key}"
+#
+##  Discuz  ##
+#DISCUZ_COOKIE_{cid}=0
+#
+##  Disqus  ##
+#DISQUS_API_KEY=""
+#
+##  Douban
+#DOUBAN_COOKIE=""
+#
+##  E-Hentai  ##
+#EH_IPB_MEMBER_ID=""
+#EH_IPB_PASS_HASH=""
+#EH_SK=""
+#EH_IGNEOUS=""
+#EH_STAR=""
+#EH_IMG_PROXY=""
+#
+##  Email  ##
+#EMAIL_CONFIG_{email}="password=password&host=server&port=port"
+#
+##  Fanfou  ##
+#FANFOU_CONSUMER_KEY=""
+#FANFOU_CONSUMER_SECRET=""
+#FANFOU_USERNAME=""
+#FANFOU_PASSWORD=""
+#
+##  Fantia  ##
+#FANTIA_COOKIE
+#
+##  Game4399  ##
+#GAME_4399=""
+#
+##  GitHub  ##
+#GITHUB_ACCESS_TOKEN=""
+#
+##  Gitee  ##
+#GITEE_ACCESS_TOKEN=""
+#
+##  Google  ##
+#GOOGLE_FONTS_API_KEY=""
+#
+##  Hefeng  ##
+#HFENG_KEY=""
+#
+##  Infzm  ##
+#INFZM_COOKIE=""
+#
+##  Initium  ##
+#INITIUM_USERNAME=""
+#INITIUM_PASSWORD=""
+#INITIUM_BEARER_TOKEN=""
+#INITIUM_IAP_RECEIPT=""
+#
+##  Instagram  ##
+#IG_USERNAME=""
+#IG_PASSWORD=""
+#IG_PROXY=""
+#IG_COOKIE=""
+#
+##  Iwara  ##
+#IWARA_USERNAME=""
+#IWARA_PASSWORD=""
+#
+##  JavDB  ##
+#JAVDB_SESSION=""
+#
+## Last.FM  ##
+#LASTFM_API_KEY=""
+#
+## LightNovel.us  ##
+#SECURITY_KEY="{security_key: 3cXXXX}"
+#
+##  Manhuagui  ##
+#MHGUI_COOKIE=""
+#
+##  Mastodon  ##
+#MASTODON_API_HOST=""
+#MASTODON_API_ACCESS_TOKEN=""
+#MASTODON_API_ACCT_DOMAIN=""
+#
+##  Medium  ##
+#MEDIUM_COOKIE_{username}=""
+#MEDIUM_ARTICLE_COOKIE=""
+#
+##  MiHoyo  ##
+#MIHOYO_COOKIE=""
+#
+##  MiniFlux  ##
+#MINIFLUX_INSTANCE=""
+#MINIFLUX_TOKEN=""
+#
+##  Mox  ##
+#MOX_COOKIE=""
+#
+##  Netease Cloud Music  ##
+#NCM_COOKIES=""
+#
+##  NewRank  ##
+#NEWRANK_COOKIE=""
+#
+##  NGA  ##
+#NGA_PASSPORT_UID=""
+#NGA_PASSPORT_CID=""
+#
+##  NHentai  ##
+#NHENTAI_USERNAME=""
+#NHENTAI_PASSWORD=""
+#
+##  Notion  ##
+#NOTION_TOKEN=""
+#
+##  Pianyuan  ##
+#PIANYUAN_COOKIE=""
+#
+##  Pixabay  ##
+#PIXABAY_KEY=""
+#
+##  Pixiv  ##
+#PIXIV_REFRESHTOKEN=""
+#PIXIV_BYPASS_CDN=false
+#PIXIV_BYPASS_HOSTNAME="public-api.secure.pixiv.net"
+#PIXIV_BYPASS_DOH="https://1.1.1.1/dns-query"
+#PIXIV_IMG_PROXY="https://i.pixiv.re"
+#
+##  Pixiv Fanbox  ##
+#FANBOX_SESSION_ID=""
+#
+##  PKubbs  ##
+#PKUBBS_COOKIE=""
+#
+##  Qingting  ##
+#QINGTING_ID=""
+#
+##  Saraba1st  ##
+#SARABA1ST_COOKIE=""
+#
+##  Sehuatang  ##
+#SEHUATANG_COOKIE=""
+#
+##  SCBoy  ##
+#SCBOY_BBS_TOKEN=""
+#
+##  Sci-Hub  ##
+#SCIHUB_HOST="https://sci-hub.se/"
+#
+##  Spotify  ##
+#SPOTIFY_CLIENT_ID=""
+#SPOTIFY_CLIENT_SECRET=""
+#SPOTIFY_REFRESHTOKEN=""
+#
+##  Telegram  ##
+#TELEGRAM_TOKEN=""
+#TELEGRAM_SESSION=""
+#TELEGRAM_API_ID=""
+#TELEGRAM_API_HASH=""
+#TELEGRAM_MAX_CONCURRENT_DOWNLOADS=""
+#
+##  TopHub  ##
+#TOPHUB_COOKIE=""
+#
+##  Twitter / X ##
+#TWITTER_OAUTH_TOKEN=""
+#TWITTER_OAUTH_TOKEN_SECRET=""
+#TWITTER_USERNAME=""
+#TWITTER_PASSWORD=""
+#TWITTER_COOKIE=""
+#
+##  Weibo  ##
+#WEIBO_APP_KEY=""
+#WEIBO_APP_SECRET=""
+#WEIBO_COOKIES=""
+#WEIBO_REDIRECT_URL=""
+#
+##  Wenku8  ##
+#WENKU8_COOKIE=""
+#
+##  xiaoyuzhou  ##
+#XIAOYUZHOU_ID=""
+#XIAOYUZHOU_TOKEN=""
+#
+##  Ximalaya  ##
+#XIMALAYA_TOKEN=""
+#
+##  Xueqiu  ##
+#XUEQIU_COOKIES=""
+#
+##  YouTube  ##
+#YOUTUBE_KEY=""
+#YOUTUBE_CLIENT_ID=""
+#YOUTUBE_CLIENT_SECRET=""
+#YOUTUBE_REFRESH_TOKEN=""
+#
+##  Zhihu  ##
+#ZHIHU_COOKIES=""
+#
+## Zodgame  ##
+#ZODGAME_COOKIE=""
--- a/apps/rsshub/docker-compose.yml
+++ b/apps/rsshub/docker-compose.yml
@ -0,0 +1,61 @@
+services:
+  rsshub:
+    image: diygod/rsshub:2024-04-17
+    container_name: rsshub
+    restart: unless-stopped
+    ports:
+      - ${APP_PORT}:1200
+    environment:
+      TZ: ${TZ}
+    env_file:
+      - ${APP_DATA_DIR}/data/app.env
+    networks:
+      - tipi_main_network
+    depends_on:
+      - redis
+      - browserless
+    labels:
+      # Main
+      traefik.enable: true
+      traefik.http.middlewares.rsshub-web-redirect.redirectscheme.scheme: https
+      traefik.http.services.rsshub.loadbalancer.server.port: 1200
+      # Web
+      traefik.http.routers.rsshub-insecure.rule: Host(`${APP_DOMAIN}`)
+      traefik.http.routers.rsshub-insecure.entrypoints: web
+      traefik.http.routers.rsshub-insecure.service: rsshub
+      traefik.http.routers.rsshub-insecure.middlewares: rsshub-web-redirect
+      # Websecure
+      traefik.http.routers.rsshub.rule: Host(`${APP_DOMAIN}`)
+      traefik.http.routers.rsshub.entrypoints: websecure
+      traefik.http.routers.rsshub.service: rsshub
+      traefik.http.routers.rsshub.tls.certresolver: myresolver
+      # Local domain
+      traefik.http.routers.rsshub-local-insecure.rule: Host(`rsshub.${LOCAL_DOMAIN}`)
+      traefik.http.routers.rsshub-local-insecure.entrypoints: web
+      traefik.http.routers.rsshub-local-insecure.service: rsshub
+      traefik.http.routers.rsshub-local-insecure.middlewares: rsshub-web-redirect
+      # Local domain secure
+      traefik.http.routers.rsshub-local.rule: Host(`rsshub.${LOCAL_DOMAIN}`)
+      traefik.http.routers.rsshub-local.entrypoints: websecure
+      traefik.http.routers.rsshub-local.service: rsshub
+      traefik.http.routers.rsshub-local.tls: true
+
+  browserless:
+    image: browserless/chrome
+    container_name: rsshub_browserless
+    restart: unless-stopped
+    ulimits:
+      core:
+        hard: 0
+        soft: 0
+    networks:
+      - tipi_main_network
+
+  redis:
+    image: redis:alpine
+    container_name: rsshub_redis
+    restart: unless-stopped
+    volumes:
+      - ${APP_DATA_DIR}/data/redis:/data
+    networks:
+      - tipi_main_network
--- a/apps/rsshub/metadata/description.md
+++ b/apps/rsshub/metadata/description.md
@ -0,0 +1,49 @@
+## Introduction
+
+Introduction
+
+RSSHub is an open source, easy to use, and extensible RSS feed generator. It's capable of generating RSS feeds from pretty much everything.
+
+RSSHub delivers millions of contents aggregated from all kinds of sources, our vibrant open source community is ensuring the deliver of RSSHub's new routes, new features and bug fixes.
+
+RSSHub can be used with browser extension [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar) and mobile auxiliary app [RSSBud (iOS)](https://github.com/Cay-Zhang/RSSBud) and [RSSAid (Android)](https://github.com/LeetaoGoooo/RSSAid)
+
+[English docs](https://docs.rsshub.app/) | [Telegram Group](https://t.me/rsshub) | [Telegram Channel](https://t.me/awesomeRSSHub) | [Twitter](https://twitter.com/intent/follow?screen_name=_RSSHub) | [中文文档](https://docs.rsshub.app/zh/)
+
+## Usage
+
+In order to generate a feed, a valid URL with parameters has to be appended to the main domain for your RSSHub instance, varying with each different app. More on the how-to's for each supported service or app can be found on [https://docs.rsshub.app/guide/](https://docs.rsshub.app/guide/), and on [https://docs.rsshub.app/guide/parameters](https://docs.rsshub.app/guide/parameters) for filtering/sorting/limiting your feed in a given URL.
+
+## RSSHub Configuration / Adding Accounts
+
+Configuration for your own instance must be done via environment variables, either through uncommenting an envvar in the already made .env file at `{$APP_DATA_DIR}/app-data/data/app.env` or directly modifying the docker-compose.yml file, as detailed in https://runtipi.io/docs/guides/customize-app-config.
+
+More info related to available configuration envvars for RSSHub can be found on [https://docs.rsshub.app/deploy/config](https://docs.rsshub.app/deploy/config), however please note that the documentation only contains **some** envvars for configuring a specific app or feature, while a minority of them are poorly-documented or not behaving as according to the official documentation (such as `UA`). In order to get the complete gist of everything, browsing the code at [https://github.com/DIYgod/RSSHub/blob/master/lib/config.ts](https://github.com/DIYgod/RSSHub/blob/master/lib/config.ts) is necessary besides reading the official docs. The given `app.env` file for this app already lists all available variables considering both sources of information and contains the default values specified there, but the **exact** working of any envvar can only be understood by reading the source-code directly after going through the basics at the docs.
+
+## Access Control
+
+RSSHub provides an access control feature for restricting which user generates a feed within your instance. This can be enabled with the envvar `ACCESS_KEY`, which can be configured either at the installation step through Runtipi's App Store or via the envvars at `docker-compose.yml` or `app.env` for the RSSHub app. Default value is empty (`""`), which means no extra key is required in order to access a feed through the URLs.
+
+Note that `ACCESS_KEY` is enabled **globally**, but access can be controlled granularly on an app-by-app basis by only giving the specific app _access code_ to a user, as explained through the diagram found on [https://docs.rsshub.app/deploy/config#access-control-configurations](https://docs.rsshub.app/deploy/config#access-control-configurations).
+
+```
+ -----------------------------------------------------------------------------------------------------------------+
+| Access key     | Route             | Generating access code                   | Access code                      |
+|------------------------------------------------------------------------------------------------------------------|
+| ILoveRSSHub	 | /qdaily/column/59 | md5('/qdaily/column/59' + 'ILoveRSSHub')	| 0f820530128805ffc10351f22b5fd121 |
+ -----------------------------------------------------------------------------------------------------------------+
+
+* Routes are accessible via code, eg: https://rsshub.app/qdaily/column/59?code=0f820530128805ffc10351f22b5fd121
+* Or using key directly, eg: https://rsshub.app/qdaily/column/59?key=ILoveRSSHub
+```
+
+## Why self-hosting instead of using a public instance?
+
+As mentioned before, this app generates a feed for a specific site either using a headless browser or sometimes directly accessing through an API. Some social networks or features, like OpenAI's GPT access requires a valid subscription access token for summarizing posts or other AI-enabled tasks. For social media / content apps that enable some sort of paywall, like X (Twitter), Instagram or Medium, a valid account is necessary in order to generate a feed from "things" happening there.
+
+## Related Projects
+
+- [RSSHub Radar](https://github.com/DIYgod/RSSHub-Radar): A browser extension that can help you quickly discover and subscribe to the RSS and RSSHub of current websites.
+- [RSSBud](https://github.com/Cay-Zhang/RSSBud): RSSHub Radar for iOS platform, designed specifically for mobile ecosystem optimization.
+- [RSSAid](https://github.com/LeetaoGoooo/RSSAid): RSSHub Radar for Android platform built with Flutter.
+- [DocSearch](https://github.com/Fatpandac/DocSearch): Link RSSHub DocSearch into Raycast
--- a/apps/rsshub/metadata/logo.jpg
+++ b/apps/rsshub/metadata/logo.jpg
--- a/apps/wallos/config.json
+++ b/apps/wallos/config.json
@ -5,8 +5,8 @@
  "available": true,
  "exposable": true,
  "id": "wallos",
-  "tipi_version": 31,
-  "version": "1.25.0",
+  "tipi_version": 32,
+  "version": "1.25.1",
  "categories": [
    "finance"
  ],
--- a/apps/wallos/docker-compose.yml
+++ b/apps/wallos/docker-compose.yml
@ -2,7 +2,7 @@ version: '3'

 services:
  wallos:
-    image: bellamy/wallos:1.25.0
+    image: bellamy/wallos:1.25.1
    container_name: wallos
    environment:
      - TZ=${TZ}