{"id":17328288,"url":"https://github.com/whtsky/fulltextrssplz","last_synced_at":"2025-08-02T13:41:42.195Z","repository":{"id":36978792,"uuid":"275187961","full_name":"whtsky/fulltextrssplz","owner":"whtsky","description":"Make rss full text.","archived":false,"fork":false,"pushed_at":"2024-04-11T20:26:34.000Z","size":3060,"stargazers_count":27,"open_issues_count":25,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-12T00:52:09.532Z","etag":null,"topics":["rss","rss-feed"],"latest_commit_sha":null,"homepage":"https://fulltextrssplz.whtsky.me/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whtsky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-06-26T15:26:57.000Z","updated_at":"2024-04-15T12:36:06.458Z","dependencies_parsed_at":"2023-09-25T19:23:59.528Z","dependency_job_id":"f768e3ff-41aa-45a7-abee-fa7e7b899f55","html_url":"https://github.com/whtsky/fulltextrssplz","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whtsky%2Ffulltextrssplz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whtsky%2Ffulltextrssplz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whtsky%2Ffulltextrssplz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whtsky%2Ffulltextrssplz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whtsky","download_url":"https://codeload.github.com/whtsky/fulltextrssplz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223639403,"owners_count":17177816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rss","rss-feed"],"created_at":"2024-10-15T14:23:20.667Z","updated_at":"2024-11-08T06:03:13.203Z","avatar_url":"https://github.com/whtsky.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fulltextrssplz\n\nMake RSS full text.\n\n## Example\n\nFull-text version of [UN News](https://news.un.org/feed/subscribe/en/news/all/rss.xml): https://fulltextrssplz.whtsky.me/feed?url=https://news.un.org/feed/subscribe/en/news/all/rss.xml\u0026format=RSS\n\n## Start Server\n\n### PaaS\n\n[![Deploy To Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/whtsky/fulltextrssplz)\n\n### with Docker\n\n```bash\ndocker run --restart=always -p 127.0.0.1:3000:80 -e MAX_ITEMS_PER_FEED=5 -d ghcr.io/whtsky/fulltextrssplz:master\n```\n\n### without Docker\n\n```bash\n# install dependencies\nyarn\n\n# build frontend codes\nyarn build\n\n# start in public mode -- everyone can use\nyarn start\n\n# start in protected mode -- only users with key can use\n## generate key for signing url\nyarn gen_key\nKEYS=\u003cyour_key\u003e[,\u003cyour_key_b\u003e] yarn start\n```\n\n## Usage\n\nAn example request looks like:\n\n```\nhttp://localhost:3000/feed?format=rss\u0026url=\u003cfeed_url\u003e[\u0026sign=\u003cyour_sign\u003e][\u0026max_items=1]\n```\n\nParams are:\n\n- `format`: Output in which format. Can be `rss` or `json`\n- `url`: URL to original feed\n- `sign`: required for protected mode. hexadecimal HMAC signature of the feed url\n- `max_items`: max items for this feed. Can't be greater than `MAX_ITEMS_PER_FEED` environment variable.\n\nYou can get sign using\n\n```bash\nyarn sign \u003cyour_key\u003e \u003cfeed_url\u003e\n```\n\n## Environment Variables\n\n|                 name |                                                      description | default value |\n| -------------------: | ---------------------------------------------------------------: | ------------: |\n|             HOSTNAME |                                  hostname HTTP server listens to |     `0.0.0.0` |\n|                 PORT |                                      port HTTP server listens to |        `3000` |\n|                 KEYS |  comma-seperated signing keys. Leave empty to run in public mode |     `\u003cemtpy\u003e` |\n|   MAX_ITEMS_PER_FEED |                                               max items per feed |           `3` |\n| CACHE_CONTROL_MAXAGE | Set max age in `Cache-Control` header. Use `0` to disable cache. |        `1800` |\n|           CACHE_MODE |   `redis` for cache with redis, other values means disable cache |     `\u003cempty\u003e` |\n|            REDIS_URL |                                                    URL for redis |     `\u003cempty\u003e` |\n|            CACHE_TTL |                                                        Cache TTL |     `\u003cempty\u003e` |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhtsky%2Ffulltextrssplz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhtsky%2Ffulltextrssplz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhtsky%2Ffulltextrssplz/lists"}