{"id":19121477,"url":"https://github.com/typo3-solr/solr-typo3-plugin","last_synced_at":"2025-05-05T16:26:28.370Z","repository":{"id":28650397,"uuid":"32169695","full_name":"TYPO3-Solr/solr-typo3-plugin","owner":"TYPO3-Solr","description":"An Apache Solr filter plugin to support TYPO3 access restrictions.","archived":false,"fork":false,"pushed_at":"2025-03-05T13:31:20.000Z","size":321,"stargazers_count":7,"open_issues_count":3,"forks_count":5,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-19T10:28:19.506Z","etag":null,"topics":["cms","filter","java","search","solr","typo3"],"latest_commit_sha":null,"homepage":"http://www.typo3-solr.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TYPO3-Solr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-03-13T17:14:40.000Z","updated_at":"2025-03-05T13:27:54.000Z","dependencies_parsed_at":"2024-01-22T16:45:52.797Z","dependency_job_id":"6a69c4e3-5778-4282-b02e-c9f829cd178e","html_url":"https://github.com/TYPO3-Solr/solr-typo3-plugin","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-Solr%2Fsolr-typo3-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-Solr%2Fsolr-typo3-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-Solr%2Fsolr-typo3-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-Solr%2Fsolr-typo3-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TYPO3-Solr","download_url":"https://codeload.github.com/TYPO3-Solr/solr-typo3-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252532933,"owners_count":21763496,"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":["cms","filter","java","search","solr","typo3"],"created_at":"2024-11-09T05:17:30.689Z","updated_at":"2025-05-05T16:26:28.346Z","avatar_url":"https://github.com/TYPO3-Solr.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n![GitHub Build Status](https://github.com/TYPO3-Solr/solr-typo3-plugin/actions/workflows/ci.yml/badge.svg)\n\n# Solr TYPO3 Plugin\n\nThe Solr TYPO3 plugin provides the AccessFilterQParserPlugin, which is a\norg.apache.solr.search.QParserPlugin that allows to restrict access to Solr\ndocuments indexed by TYPO3 on a document level.\n\nIt filters the documents returned from a query by performing set operations\nbetween a particular string field in the index and the specified value. These\nvalues are comma separated lists of user group IDs, the index field stores the\ngroups that are allowed to access a particular document while the groups the\nuser is a member of / has access to are specified through a filter parameter.\n\n\n## Example\n\n```\nhttp://localhost:8983/path/to/solr/select/?fq={!typo3access field=fieldname}permittedUserGroups\u0026q=...\nhttp://localhost:8983/solr/collection1/select/?q=title:Hello\u0026fq={!typo3access}0,1,4,10\n```\n\n* The **field** parameter is optional and defaults to \"access\", it is the name of the string field holding the access restrictions for a document\n* **permittedUserGroups** is a comma separated list of groups the user is granted access to\n\n\n## Adding the plugin to Solr\n\nTo use this plugin, simply copy the jar file containing the plugin classes into your\n$SOLR_HOME/lib directory and then add the following to your solrconfig.xml file:\n\n```xml\n\u003cqueryParser name=\"typo3access\" class=\"org.typo3.solr.search.AccessFilterQParserPlugin\" /\u003e\n```\n\nIn your schema.xml add a field like this:\n\n```xml\n\u003cfield name=\"access\" type=\"string\" indexed=\"false\" stored=\"true\" docValues=\"true\" default=\"c:0\" /\u003e\n```\n\nIt is important to turn on DocValues. The field does not need to be stored,\nbut it helps with debugging.\n\n\nFinally, restart your servlet container.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypo3-solr%2Fsolr-typo3-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypo3-solr%2Fsolr-typo3-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypo3-solr%2Fsolr-typo3-plugin/lists"}