flaresolverr

Documentation

Index

• Constants
• func ResolveConfigPath() (string, error)
• func SaveConfig(cfg Config) (string, error)
• type ChallengeResolutionResult
• type Config
  • func DefaultConfig() Config
  • func LoadConfig() (Config, []string)
  • func PrepareConfig(cfg Config) Config
• type Cookie
• type HealthResponse
• type IndexResponse
• type Logger
• type Proxy
• type Server
  • func NewServer(cfg Config) *Server
  • func (s *Server) Handler() http.Handler
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Shutdown(ctx context.Context) error
• type Service
  • func NewService(cfg Config) *Service
  • func (s *Service) ApplyConfig(cfg Config)
  • func (s *Service) Close() error
  • func (s *Service) ControllerV1(ctx context.Context, req *V1Request) (V1Response, int)
  • func (s *Service) Health(context.Context) HealthResponse
  • func (s *Service) Index(ctx context.Context) IndexResponse
• type V1Request
• type V1Response

Constants

const (
	StatusOK    = "ok"
	StatusError = "error"
)

Functions

func ResolveConfigPath

func ResolveConfigPath() (string, error)

func SaveConfig

func SaveConfig(cfg Config) (string, error)

Types

type ChallengeResolutionResult

type ChallengeResolutionResult = browserpkg.ChallengeResolutionResult

type Config

type Config struct {
	Host                string
	Port                int
	BrowserBackend      string // "auto" | "chromedriver" | "geckodriver"
	BrowserPath         string
	DriverPath          string
	DriverCacheDir      string
	DriverAutoDownload  bool
	ChromeForTestingURL string
	Headless            bool
	StartupUserAgent    string
	LogLevel            string
	LogHTML             bool
	DebugLogging        bool
	DisableMedia        bool
	PrometheusEnabled   bool
	PrometheusPort      int
	DefaultProxy        *Proxy
	Version             string
	Logger              *slog.Logger
}

func DefaultConfig

func DefaultConfig() Config

func LoadConfig

func LoadConfig() (Config, []string)

func PrepareConfig

func PrepareConfig(cfg Config) Config

type Cookie

type Cookie = browserpkg.Cookie

type HealthResponse

type HealthResponse struct {
	Status string `json:"status"`
}

type IndexResponse

type IndexResponse struct {
	Msg       string `json:"msg"`
	Version   string `json:"version"`
	UserAgent string `json:"userAgent"`
}

type Logger

type Logger interface {
	Debug(msg string, args ...any)
	Info(msg string, args ...any)
	Warn(msg string, args ...any)
	Error(msg string, args ...any)
}

type Proxy

type Proxy = browserpkg.Proxy

type Server

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

func NewServer

func NewServer(cfg Config) *Server

func (*Server) Handler

func (s *Server) Handler() http.Handler

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

type Service

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

func NewService

func NewService(cfg Config) *Service

func (*Service) ApplyConfig

func (s *Service) ApplyConfig(cfg Config)

func (*Service) Close

func (s *Service) Close() error

func (*Service) ControllerV1

func (s *Service) ControllerV1(ctx context.Context, req *V1Request) (V1Response, int)

func (*Service) Health

func (s *Service) Health(context.Context) HealthResponse

func (*Service) Index

func (s *Service) Index(ctx context.Context) IndexResponse

type V1Request

type V1Request struct {
	Cmd               string   `json:"cmd,omitempty"`
	Cookies           []Cookie `json:"cookies,omitempty"`
	MaxTimeout        int      `json:"maxTimeout,omitempty"`
	Proxy             *Proxy   `json:"proxy,omitempty"`
	Session           string   `json:"session,omitempty"`
	SessionTTLMinutes int      `json:"session_ttl_minutes,omitempty"`
	Headers           any      `json:"headers,omitempty"`
	UserAgent         string   `json:"userAgent,omitempty"`

	URL               string `json:"url,omitempty"`
	PostData          string `json:"postData,omitempty"`
	ReturnOnlyCookies bool   `json:"returnOnlyCookies,omitempty"`
	ReturnScreenshot  bool   `json:"returnScreenshot,omitempty"`
	Download          *bool  `json:"download,omitempty"`
	ReturnRawHTML     *bool  `json:"returnRawHtml,omitempty"`
	WaitInSeconds     int    `json:"waitInSeconds,omitempty"`
	DisableMedia      *bool  `json:"disableMedia,omitempty"`
	TabsTillVerify    *int   `json:"tabs_till_verify,omitempty"`
}

type V1Response

type V1Response struct {
	Status         string                     `json:"status"`
	Message        string                     `json:"message"`
	Session        string                     `json:"session,omitempty"`
	Sessions       []string                   `json:"sessions,omitempty"`
	StartTimestamp int64                      `json:"startTimestamp,omitempty"`
	EndTimestamp   int64                      `json:"endTimestamp,omitempty"`
	Version        string                     `json:"version,omitempty"`
	Solution       *ChallengeResolutionResult `json:"solution,omitempty"`
}