[{"_1":2,"_176":-5,"_177":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_155":156},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":85,"_108":109,"_146":-5,"_147":11,"_148":17,"_149":11,"_150":-5,"_151":11,"_152":-5,"_153":154},"canonicalUrl","https://hub.docker.com/r/dsys/match/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","dsys","reponame","match","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2018-06-20T21:05:28.291711Z","description","Scalable reverse image search built on Kubernetes and Elasticsearch","is_private","last_updated","2020-07-25T18:12:51.106866Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",70032,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

$\"logo\"$

\n\n

Scalable reverse image search
built on Kubernetes and Elasticsearch

\n\n

$\"GitHub$ $\"Docker$ $\"Kubernetes$

\n\n**Match** makes it easy to search for images that look similar to each other. Using a state-of-the-art perceptual hash, it is invariant to scaling and 90 degree rotations. Its HTTP API is quick to integrate and flexible for a number of reverse image search applications. Kubernetes and Elasticsearch allow Match to scale to billions of images with ease while giving you full control over where your data is stored. Match uses the awesome [ascribe/image-match](https://github.com/ascribe/image-match) under the hood for most of the image search legwork.\n\n1. [Getting Started](#getting-started)\n2. [API](#api)\n3. [Development](#development)\n4. [License and Acknowledgements](#license-and-acknowledgements)\n\n## Getting Started\n\nIf you already have ElasticSearch running:\n```\n$ docker run -e ELASTICSEARCH_URL=https://daisy.us-west-1.es.amazonaws.com -it dsys/match\n```\n\nIf you want to run ElasticSearch locally as well, have [`docker-compose`](https://docs.docker.com/compose/) installed on your system, clone this repository and type:\n```\n$ make dev\n```\n\nMatch is packaged as a Docker container ([dsys/match](https://hub.docker.com/r/dsys/match/) on Docker Hub), making it highly portable and scalable to billions of images. You can configure a few options using environment variables:\n\n* **WORKER_COUNT** *(default: `4`)*\n\n The number of gunicorn workers to spin up.\n\n* **ELASTICSEARCH_URL** *(default: `elasticsearch:9200`)*\n\n A URL pointing to the Elasticsearch database where image signatures are to be stored. If you don't want to host your own Elasticsearch cluster, consider using [AWS Elasticsearch Service](https://aws.amazon.com/elasticsearch-service/). That's what we use.\n\n* **ELASTICSEARCH_INDEX** *(default: images)*\n\n The index in the Elasticsearch database where image signatures are to be stored.\n\n* **ELASTICSEARCH_DOC_TYPE** *(default: images)*\n\n The doc type used for storing image signatures.\n\n\n### Using in your own Kubernetes cluster\n\nYou can configure the service, replication controller, and secret like so:\n\n```yaml\n# match-service.yml\napiVersion: v1\nkind: Service\nmetadata:\n name: match\nspec:\n ports:\n - name: http\n port: 80\n protocol: TCP\n selector:\n app: match\n```\n\n```yaml\n# match-rc.yml\napiVersion: v1\nkind: ReplicationController\nmetadata:\n name: match\nspec:\n replicas: 1\n selector:\n app: match\n template:\n metadata:\n labels:\n app: match\n spec:\n containers:\n - name: match\n image: dsys/match:latest\n ports:\n - containerPort: 80\n env:\n - name: WORKER_COUNT\n value: \"4\"\n - name: ELASTICSEARCH_URL\n valueFrom:\n secretKeyRef:\n name: match\n key: elasticsearch.url\n - name: ELASTICSEARCH_INDEX\n valueFrom:\n secretKeyRef:\n name: match\n key: elasticsearch.index\n - name: ELASTICSEARCH_DOC_TYPE\n valueFrom:\n secretKeyRef:\n name: match\n key: elasticsearch.doc-type\n```\n\n```yaml\n# match-secret.yml\napiVersion: v1\nkind: Secret\nmetadata:\n name: match\ndata:\n # https://daisy.us-west-1.es.amazonaws.com (change me)\n elasticsearch.url: aHR0cHM6Ly9kYWlzeS51cy13ZXN0LTEuZXMuYW1hem9uYXdzLmNvbQ==\n\n # images\n elasticsearch.index: aW1hZ2Vz\n\n # images\n elasticsearch.doc-type: aW1hZ2Vz\n```\n\n## API\n\nMatch has a simple HTTP API. All request parameters are specified via `application/x-www-form-urlencoded` or `multipart/form-data`.\n\n* [POST `/add`](#post-add)\n* [DELETE `/delete`](#delete-delete)\n* [POST `/search`](#post-search)\n* [POST `/compare`](#post-compare)\n* [GET `/count`](#get-count)\n* [GET `/list`](#get-list)\n* [GET `/ping`](#get-ping)\n\n---\n\n### POST `/add`\n\nAdds an image signature to the database.\n\n#### Parameters\n\n* **url** or **image** *(required)*\n\n The image to add to the database. It may be provided as a URL via `url` or as a `multipart/form-data` file upload via `image`.\n\n* **filepath** *(required)*\n\n The path to save the image to in the database. If another image already exists at the given path, it will be overwritten.\n\n* **metadata** *(default: None)*\n\n An arbitrary JSON object featuring meta data to attach to the image.\n\n#### Example Response\n\n```json\n{\n \"status\": \"ok\",\n \"error\": [],\n \"method\": \"add\",\n \"result\": []\n}\n```\n\n---\n\n### DELETE `/delete`\n\nDeletes an image signature from the database.\n\n#### Parameters\n\n* **filepath** *(required)*\n\n The path of the image signature in the database.\n\n#### Example Response\n\n```json\n{\n \"status\": \"ok\",\n \"error\": [],\n \"method\": \"delete\",\n \"result\": []\n}\n```\n\n---\n\n### POST `/search`\n\nSearches for a similar image in the database. Scores range from 0 to 100, with 100 being a perfect match.\n\n#### Parameters\n\n* **url** or **image** *(required)*\n\n The image to add to the database. It may be provided as a URL via `url` or as a `multipart/form-data` file upload via `image`.\n\n* **all_orientations** *(default: true)*\n\n Whether or not to search for similar 90 degree rotations of the image.\n\n#### Example Response\n\n```json\n{\n \"status\": \"ok\",\n \"error\": [],\n \"method\": \"search\",\n \"result\": [\n {\n \"score\": 99.0,\n \"filepath\": \"http://static.wixstatic.com/media/0149b5_345c8f862e914a80bcfcc98fcd432e97.jpg_srz_614_709_85_22_0.50_1.20_0.00_jpg_srz\"\n }\n ]\n}\n```\n\n---\n\n### POST `/compare`\n\nCompares two images, returning a score for their similarity. Scores range from 0 to 100, with 100 being a perfect match.\n\n#### Parameters\n\n* **url1** or **image1**, **url2** or **image2** *(required)*\n\n The images to compare. They may be provided as a URL via `url1`/`url2` or as a `multipart/form-data` file upload via `image1`/`image2`.\n\n#### Example Response\n\n```json\n{\n \"status\": \"ok\",\n \"error\": [],\n \"method\": \"compare\",\n \"result\": [\n {\n \"score\": 99.0\n }\n ]\n}\n```\n\n---\n\n### GET `/count`\n\nCount the number of image signatures in the database.\n\n#### Example Response\n\n```json\n{\n \"status\": \"ok\",\n \"error\": [],\n \"method\": \"list\",\n \"result\": [420]\n}\n```\n\n---\n\n### GET `/list`\n\nLists the file paths for the image signatures in the database.\n\n#### Parameters\n\n* **offset** *(default: 0)*\n\n The location in the database to begin listing image paths.\n\n* **limit** *(default: 20)*\n\n The number of image paths to retrieve.\n\n#### Example Response\n\n```json\n{\n \"status\": \"ok\",\n \"error\": [],\n \"method\": \"list\",\n \"result\": [\n \"http://img.youtube.com/vi/iqPqylKy-bY/0.jpg\",\n \"https://i.ytimg.com/vi/zbjIwBggt2k/hqdefault.jpg\",\n \"https://s-media-cache-ak0.pinimg.com/736x/3d/67/6d/3d676d3f7f3031c9fd91c10b17d56afe.jpg\"\n ]\n}\n```\n\n---\n\n### GET `/ping`\n\nCheck for the health of the server.\n\n#### Example Response\n\n```json\n{\n \"status\": \"ok\",\n \"error\": [],\n \"method\": \"ping\",\n \"result\": []\n}\n```\n\n## Development\n\n $ export ELASTICSEARCH_URL=https://daisy.us-west-1.es.amazonaws.com\n $ make build\n $ make run\n $ make push\n\n## License and Acknowledgements\n\nMatch is based on [ascribe/image-match](https://github.com/ascribe/image-match), which is in turn based on the paper [_An image signature for any kind of image_, Goldberg et al](http://www.cs.cmu.edu/~hcwong/Pdfs/icip02.ps). There is an existing [reference implementation](https://www.pureftpd.org/project/libpuzzle) which may be more suited to your needs.\n\nMatch itself is released under the [BSD 3-Clause license](https://github.com/dsys/match/blob/master/LICENSE). `ascribe/image-match` is released under the Apache 2.0 license.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",2530955902,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_103":104,"_105":94,"_106":94,"_107":17},"id","53682ec0b1be4c70bfb630a7ab538177","uuid","53682ec0-b1be-4c70-bfb6-30a7ab538177","type","organization","orgname","full_name","","location","San Francisco, CA","company","Distributed Systems, Inc.","profile_url","https://distributedsystems.com","date_joined","2018-06-08T00:24:30.647601Z","gravatar_url","https://www.gravatar.com/avatar/b7f06e420e3504c115fb1b36a53eadb5?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[110],{"_111":40,"_112":113,"_114":115,"_86":116,"_117":118,"_46":135,"_136":113,"_137":29,"_138":52,"_53":139,"_140":141,"_142":126,"_143":135,"_144":62,"_145":17},"content_type","creator",3232747,"full_size",659450820,29568683,"images",[119],{"_120":121,"_122":123,"_124":94,"_125":126,"_127":128,"_129":130,"_131":94,"_132":-5,"_133":115,"_59":62,"_134":-5},"architecture","amd64","digest","sha256:6c1747d856d5d1f6d4fd12b034fb5e8c919118166cfa0c385b739eb6ee7a1927","features","last_pulled","2026-09-22T04:23:39.450604208Z","last_pushed","2020-07-25T18:12:51Z","os","linux","os_features","os_version","size","variant","2020-07-25T18:12:50.76397Z","last_updater","last_updater_username","media_type","latest","repository",5644014,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":157,"_164":165,"_153":174,"_175":11},{"_36":158,"_38":159,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":160,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":161,"_75":17,"_76":163,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":162},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_166":60,"_167":-5,"_168":-5,"_169":170},"count","next","previous","results",[171],{"_111":40,"_112":113,"_114":115,"_86":116,"_117":172,"_46":135,"_136":113,"_137":29,"_138":52,"_53":139,"_140":141,"_142":126,"_143":135,"_144":62,"_145":17},[173],{"_120":121,"_122":123,"_124":94,"_125":126,"_127":128,"_129":130,"_131":94,"_132":-5,"_133":115,"_59":62,"_134":-5},[],"canDeleteTags","actionData","errors"]

dsys/match

Tags for dsys/match