{"id":14155331,"url":"https://github.com/berrysauce/ingredients","last_synced_at":"2025-10-25T21:09:33.893Z","repository":{"id":190197223,"uuid":"682142366","full_name":"berrysauce/ingredients","owner":"berrysauce","description":"🥗  Determine the \"ingredients\" (or technologies) behind a website","archived":false,"fork":false,"pushed_at":"2024-10-28T16:38:00.000Z","size":3770,"stargazers_count":116,"open_issues_count":8,"forks_count":18,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-30T04:30:00.901Z","etag":null,"topics":["bs4","fastapi","httpx","ingredients","python","sveltekit","tool","vercel","web","website-scanner"],"latest_commit_sha":null,"homepage":"https://ingredients.work","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/berrysauce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"berrysauce","buy_me_a_coffee":"berrysauce"}},"created_at":"2023-08-23T14:29:18.000Z","updated_at":"2024-10-29T14:49:07.000Z","dependencies_parsed_at":"2024-04-23T08:49:21.828Z","dependency_job_id":"ba0a0f2e-c761-4a9b-8bfd-d58f0a29738d","html_url":"https://github.com/berrysauce/ingredients","commit_stats":{"total_commits":225,"total_committers":12,"mean_commits":18.75,"dds":0.528888888888889,"last_synced_commit":"7cb18c19b742f8a631074e4845cccac2c55aae9b"},"previous_names":["berrysauce/ingredients"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/berrysauce%2Fingredients","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/berrysauce%2Fingredients/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/berrysauce%2Fingredients/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/berrysauce%2Fingredients/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/berrysauce","download_url":"https://codeload.github.com/berrysauce/ingredients/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299831,"owners_count":20916190,"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":["bs4","fastapi","httpx","ingredients","python","sveltekit","tool","vercel","web","website-scanner"],"created_at":"2024-08-17T08:02:51.667Z","updated_at":"2025-10-25T21:09:33.800Z","avatar_url":"https://github.com/berrysauce.png","language":"Svelte","funding_links":["https://github.com/sponsors/berrysauce","https://buymeacoffee.com/berrysauce"],"categories":["web"],"sub_categories":[],"readme":"# 🥗 Ingredients\n\n![GitHub repo size](https://img.shields.io/github/repo-size/berrysauce/ingredients)\n[![CodeQL](https://github.com/berrysauce/ingredients/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/berrysauce/ingredients/actions/workflows/github-code-scanning/codeql)\n\n\n\u003e [!IMPORTANT]\n\u003e The domain for Ingredients was switched from \"ingredients.tech\" to \"ingredients.work\". I no longer own the old domain. \n\nIngredients is a website scanner that is able to determine the \"ingredients\" (or technologies) behind a website.\n\nIt helps users discover the various software, frameworks, content management systems, analytics tools, and other technologies that are used to build and maintain a particular website.\n\n\n\u003cimg alt=\"Ingredients Screenshot\" src=\"https://bcdn.berrysauce.me/shared/ingredients-screenshot-new.png\"\u003e\n\n\n\u003cbr\u003e\n\n\n## 📚 How it works\n\nIngredients consists of a frontend application (made with SvelteKit) and an API (made with FastAPI) with a simple script, that requests websites and checks their HTML tags and HTTP headers based on filters. The filters or \"ingredients\" are stored in their respective category-folders in the [ingredients/](https://github.com/berrysauce/ingredients/tree/main/ingredients) folder.\n\nEach \"ingredient\" consists of a JSON file like the following:\n\n```json\n{\n    \"name\": \"Ingredient Name\",\n    \"description\": \"Short description of the ingredient\",\n    \"icon\": \"/icon/ingredient-name.png\",\n    \"checks\": {\n        \"tags\": [\n            {\n                \"tag\": \"script\",\n                \"attribute\": \"src\",\n                \"value\": \"cdn.example.com\"\n            },\n            {\n                \"tag\": \"script\",\n                \"attribute\": null,\n                \"value\": \"cdn.example.com\"\n            }\n        ],\n        \"headers\": [\n            {\n                \"header\": \"Server\",\n                \"value\": \"example\"\n            },\n            {\n                \"header\": \"Request-Id\",\n                \"value\": null\n            }\n        ]\n    }\n}\n```\n\nIn the JSON file, you can define the HTML tags and HTTP headers the script should look for, to identify, if a website is using the ingredient.\n\nAs you can also see, this JSON file mentions a path to an icon, which is used to visualize the ingredient. Each favicon has a resolution of 32x32 pixels and is located inside the [icons/](https://github.com/berrysauce/ingredients/tree/main/icons) folder.\n\n\u003cbr\u003e\n\n\n## 🤖 Using the API\n\nIngredients has an API you can use. This API can be used to scan sites.\n\n\u003e [!NOTE]  \n\u003e The API has a set of CORS origins in place as of now, so might only work locally! This might change later.\n\nYou can start a scan with one `GET` call. Just provide the URL you want to scan as a query parameter.\n\n```http\nGET  https://api.ingredients.work/ingredients?url=https://example.com\n```\n\n\u003cbr\u003e\n\n\n## ⚙️ How to add Ingredients\n\n\u003e [!NOTE]  \n\u003e Before you contribute, please take a look at the [CONTRIBUTING.md](https://github.com/berrysauce/ingredients/blob/main/CONTRIBUTING.md) file\n\nTo add an ingredient, create a JSON file in [ingredients/](https://github.com/berrysauce/ingredients/tree/main/ingredients) folder inside a fitting category-folder and add its icon (size 32x32 pixels, `.png` format) in the [icons/](https://github.com/berrysauce/ingredients/tree/main/icons) folder.\n\nWhen defining an ingredient, follow this template:\n\n```json\n{\n    \"name\": \"Ingredient Name\",\n    \"description\": \"Short description of the ingredient\",\n    \"icon\": \"/icon/ingredient-name.png\",\n    \"checks\": {\n        \"tags\": [\n            (TAG CHECKS GO HERE)\n        ],\n        \"headers\": [\n            (HEADER CHECKS GO HERE)\n        ]\n    }\n}\n```\n\n\u003cbr\u003e\n\n### Tag checks\n\nTag checks are filters, which search for specific HTML tags on a website, to identify if it's using the ingredient. Here's an example:\n\n```json\n{\n    \"tag\": \"script\",\n    \"attribute\": \"src\",\n    \"value\": \"cdn.example.com\"\n}\n```\n\nHere, we're checking if the website has any `\u003cscript\u003e` tags, which have `cdn.example.com` inside their `src` attribute.\n\nAnd here, we're not defining an attribute (using `null`). This means, we're checking if the inside of the `\u003cscript\u003e` tag has `cdn.example.com` inside:\n\n```json\n{\n    \"tag\": \"script\",\n    \"attribute\": null,\n    \"value\": \"cdn.example.com\"\n}\n```\n\nLike the following:\n\n```html\n\u003cscript\u003e\n    const url = \"cdn.example.com\"\n\u003c/script\u003e\n```\n\nTag checks can also use wildcard values. For instance, if you need to check if a `\u003cscript\u003e` tag's `src` attribute contains a domain and a file extension, you can do so with an asterisk (`*`). This will split your check into multiple segments. All segments must be inside the checked tag attribute somewhere. For example:\n\n```json\n{\n    \"tag\": \"script\",\n    \"attribute\": \"src\",\n    \"value\": \"example.com/library/*.js\"\n}\n```\n\nThis will check if the `src` attribute of a `\u003cscript\u003e` tag includes `example.com/library/` and `.js`.\n\n\u003cbr\u003e\n\n### Header checks\n\nHeader checks are filters, which search for specific HTTP response headers when requesting the website, to identify if it's using the ingredient. Here's an example:\n\n```json\n{\n    \"header\": \"Server\",\n    \"value\": \"example\"\n}\n```\n\nHere, we're checking if the HTTP response headers include a header called `Server` which has the value `example` inside.\n\nAnd here, we're not defining a header value (using `null`). This means, we're checking if the `Request-Id` header exists at all, without explicitly checking for its value:\n\n```json\n{\n    \"header\": \"Request-Id\",\n    \"value\": null\n}\n```\n\n\n\u003cbr\u003e\n\n\n## 📄 License\n\nIngredients — Website Technology Scanner\n\nCopyright (C) 2023 Paul Haedrich (berrysauce)\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published\nby the Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fberrysauce%2Fingredients","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fberrysauce%2Fingredients","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fberrysauce%2Fingredients/lists"}