Categorygithub.com/rcrowley/sitesearch
modulepackage
0.0.0-20250106055518-e16dec0da18b
Repository: https://github.com/rcrowley/sitesearch.git
Documentation: pkg.go.dev

# README

Sitesearch

Index all the HTML files in a document root directory and serve queries to it, including an HTML form and SERP, via AWS Lambda.

Installation

git clone https://github.com/rcrowley/sitesearch.git
cd sitesearch
go generate
go install

Usage

sitesearch -l <layout> [-n <name>] [-r <region>] [-x <exclude>[...]] [<docroot>[...]]
  • -l <layout>: site layout HTML document for search result pages
  • -n <name>: name of the the Lambda function (defaults to "sitesearch")
  • -r <region>: AWS region to host the Lambda function (defaults to AWS_REGION or AWS_DEFAULT_REGION in the environment)
  • -x <exclude>: subdirectory of <docroot> to exclude (may be repeated)
  • <docroot>: document root directory to scan (defaults to the current working directory; may be repeated)

AWS credentials are sourced from the environment or AWS SDK configuration files. There are no command-line options for passing access key IDs, secrets, or session tokens.

See also

Sitesearch is part of the Mergician suite of tools that manipulate HTML documents:

  • Deadlinks: Scan a document root directory for dead links
  • Electrostatic: Mergician-powered, pure-HTML CMS
  • Feed: Scan a document root directory to construct an Atom feed
  • Frag: Extract fragments of HTML documents

# Packages

No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Zip writes the starting-point zip file that contains the compiled Lambda function, named bootstrap per the Lambda provided.al* runtime requirement, to disk, and adds the file with the given relative pathname to it.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author