search

README

caddy search

search engine

local https://github.com/blevesearch/bleve

remote https://github.com/meilisearch/MeiliSearch

browser https://github.com/oramasearch/orama https://github.com/nextapps-de/flexsearch

Documentation

Index

• Constants
• func CreateIndex() (bleve.Index, error)
• type NotifyFile
  • func NewNotifyFile(logger *zap.Logger, indexFunc func(path string, remove bool)) *NotifyFile
  • func (nf *NotifyFile) WatchDir(dir string) error
  • func (nf *NotifyFile) WatchEvent()
• type Result
• type Search
  • func (Search) CaddyModule() caddy.ModuleInfo
  • func (sch *Search) IndexDoc(path string, remove bool)
  • func (sch *Search) Provision(ctx caddy.Context) error
  • func (sch *Search) Search(queryStr string) map[string][]string
  • func (sch *Search) SearchHTML(w http.ResponseWriter, r *http.Request) error
  • func (sch *Search) SearchJSON(w http.ResponseWriter, r *http.Request) error
  • func (sch *Search) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) (err error)
  • func (sch *Search) Validate() error

Constants

const DirectiveName = "search"

Functions

func CreateIndex

func CreateIndex() (bleve.Index, error)

Types

type NotifyFile

type NotifyFile struct {
	// contains filtered or unexported fields
}

func NewNotifyFile

func NewNotifyFile(logger *zap.Logger, indexFunc func(path string, remove bool)) *NotifyFile

func (*NotifyFile) WatchDir

func (nf *NotifyFile) WatchDir(dir string) error

WatchDir 监控目录

func (*NotifyFile) WatchEvent

func (nf *NotifyFile) WatchEvent()

type Result

type Result struct {
	Path string
	Body []string
}

type Search

type Search struct {
	Root     string `json:"root,omitempty"`
	Endpoint string `json:"endpoint,omitempty"` // default: /search
	Regexp   string `json:"regexp,omitempty"`
	// contains filtered or unexported fields
}

func (Search) CaddyModule

func (Search) CaddyModule() caddy.ModuleInfo

func (*Search) IndexDoc

func (sch *Search) IndexDoc(path string, remove bool)

IndexDoc 索引文件

func (*Search) Provision

func (sch *Search) Provision(ctx caddy.Context) error

Provision sets up the module. #caddy.Provisioner

func (*Search) Search

func (sch *Search) Search(queryStr string) map[string][]string

Search 搜索文件

func (*Search) SearchHTML

func (sch *Search) SearchHTML(w http.ResponseWriter, r *http.Request) error

SearchHTML renders the search results in the HTML template

func (*Search) SearchJSON

func (sch *Search) SearchJSON(w http.ResponseWriter, r *http.Request) error

SearchJSON renders the search results in JSON format

func (*Search) ServeHTTP

func (sch *Search) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) (err error)

ServeHTTP implements #caddyhttp.MiddlewareHandler.

func (*Search) Validate

func (sch *Search) Validate() error

Validate ensures md has a valid configuration. #caddy.Validator Validate should be a read-only function. It is run after the Provision() method.