{"id":15726706,"url":"https://github.com/grasmash/drupal-usasearch","last_synced_at":"2025-03-13T02:31:12.256Z","repository":{"id":13302756,"uuid":"15988989","full_name":"grasmash/drupal-usasearch","owner":"grasmash","description":"The USASearch module for Drupal.","archived":false,"fork":false,"pushed_at":"2016-10-13T15:35:39.000Z","size":186,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"7.x-5.x","last_synced_at":"2024-10-03T22:41:00.827Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"sahat/newedenfaces-react","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grasmash.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}},"created_at":"2014-01-17T03:24:33.000Z","updated_at":"2017-04-15T14:20:53.000Z","dependencies_parsed_at":"2022-08-29T00:52:05.718Z","dependency_job_id":null,"html_url":"https://github.com/grasmash/drupal-usasearch","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/grasmash%2Fdrupal-usasearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grasmash%2Fdrupal-usasearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grasmash%2Fdrupal-usasearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grasmash%2Fdrupal-usasearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grasmash","download_url":"https://codeload.github.com/grasmash/drupal-usasearch/tar.gz/refs/heads/7.x-5.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221332805,"owners_count":16799522,"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":[],"created_at":"2024-10-03T22:40:24.095Z","updated_at":"2024-10-24T17:03:16.392Z","avatar_url":"https://github.com/grasmash.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Contents of this file\n---------------------\n\n * Overview\n * Installation\n * Requirements\n * Setup Tips\n * Features\n\nOverview\n--------\n\nDigitalGov Search (machine name: usasearch) is a search engine that can be used to power \nthe search box on any U.S. government site. Read more and sign up for an account at \nhttp://search.digitalgov.gov.\n\nRequirements\n------------\n\n * A valid search Site in the DigitalGov search Admin Center.\n * Core Search module must be enabled.\n * USASearch submodule USASearch_API requires Composer_Manager and GuzzleHTTP \n library. Composer_Manager libraries require PHP 5.4.5 or higher.\n\nPre-Install: the DigitalGov Search Admin Center\n-----------------------------------------------\n\nBefore configuring this module, set up your search Site in DigitalGov Search’s \nAdmin Center (https://search.usa.gov/sites/). \n1. Note the `Site Handle` on the Dashboard \u003e Settings page.\n2. Email search@support.digitalgov.gov and ask us to turn on i14y for your site. After \nwe've turned it on, go to Content \u003e i14y Drawers. Add an i14y Drawer, giving it a Drawer \nHandle. It will be assigned a Secret Token. Note the Handle and Secret Token by clicking \nShow.\n3. Configure your domains, social media, and other content that you want searched, and \ncustomize the Display settings to brand your results page. \n\nLearn more at http://search.digitalgov.gov/manual/index.html and \nhttp://search.digitalgov.gov/manual/training.html\n\nPre-Install: the Command Line\n-----------------------------\n\nPing our server from the command line to confirm your API requests can reach us. \n\nSee a sample curl request and more information at http://gsa.github.io/slate/#create-a-document. \nIf you don't receive a 200 OK response, contact search@support.digitalgov.gov for assistance.\n\nInstallation and Setup: Drupal\n------------------------------\n\n1. Place the usasearch directory in your sites/all/modules directory.\n2. Enable the module and the following submodules:\n  * USASearch_Hosted (required to return results): replaces Drupal Core search \n  with USASearch hosted search.\n  * USASearch_API (required to update the index): Provides real time updates to \n  USASearch's index when Drupal nodes are created, modified, or deleted.\n  * USASearch_field (optional): Makes available a \"USASearch\" field type, which \n  can be added to Drupal entities to render a USASearch box that will search a \n  specific affiliate ID. This is useful when used in a Fieldable Panel Pane in a \n  microsite.\n  * USASearch Index (optional): Generates a machine-readable index of all nodes \n  that can be used to passively populate USASearch's index.\n3. Configure it at admin/config/search/usasearch with the following information \nfrom the DigitalGov Search Admin Center:\n  * Site Handle (required)\n  * Enable autocomplete to provide type-ahead search suggestions in your site’s \n  search box\n  * Search Domain (modify only if using a CNAME for your results page)\n  * i14y Drawer Handle (optional but highly recommended - see pre-install info above)\n  * i14y Drawer Secret Key (required if a Drawer Handle is entered)\n4. Grant permission for one or more roles to search using the built-in search \nmodule.\n5. Configure each content type's snippet on admin/structure/types/manage/CONTENTTYPE/display/search_index\n6. After a configuration change, run Re-Index Site on admin/config/search/settings, and then run cron.\n\n\nSetup Tips\n------------\n\n#### API Search - usasearch_api\nThis submodule handles the API calls that send your content to our index. It depends on \ncomposer_manager, which will manage PHP library dependencies. Namely, GuzzleHTTP (see \nsites/all/vendor). The composer libraries require PHP version 5.4.5 or higher.\n\n#### Updating the index\nThe i14y index is updated by Drupal when content is created, modified, or \ndeleted. A bulk update can be initialized through the Re-index Site button on \nDrupal search settings admin/config/search/settings.\n\n#### Note re: Content type search settings \nThis module contains a legacy checkbox at the content type configuration level that \nsuggests you can suppress that content type from being sent for indexing. This checkbox \ndoesn't do anything currently, and all content will be indexed. Exclusions by content \ntype, or other taxonomy terms, can be done in the DigitalGov Search Admin Center.\n\nFeatures\n--------\n\nThe module was designed to allow exporting of all the admin configuration options via the \nStrongarm and Features modules.\n\nAll site content is indexed, including title, body, URL, date, tags and taxonomy terms, \nlanguage, and (optionally) description/summary. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrasmash%2Fdrupal-usasearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrasmash%2Fdrupal-usasearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrasmash%2Fdrupal-usasearch/lists"}