cmd

Documentation

Index

• Variables
• type AppConfig
• type CORSConfig
• type CacheConfig
• type CaptchaConfig
• type CircuitBreakerConfig
• type Config
• type Config2Captcha
• type EngineConfig
• type ResilienceConfig
• type ServerConfig

Variables

var RootCmd = &cobra.Command{
	Use:          "openserp",
	Short:        "Open SERP",
	Long:         `Get [Google, Yandex, Baidu] search engine results via API or CLI.`,
	Version:      version,
	SilenceUsage: true,
	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
		err := initializeConfig(cmd)
		if err != nil {
			return err
		}
		if err := browserprofile.LoadProfilesFromJSON(config.App.ProfilesJSON); err != nil {
			return fmt.Errorf("load app.profiles: %w", err)
		}

		logFormat, err := core.NormalizeLogFormat(config.App.LogFormat)
		if err != nil {
			return err
		}
		config.App.LogFormat = logFormat

		core.InitLogger(config.Server.IsVerbose, config.Server.IsDebug, config.App.LogFormat)
		logrus.WithField("config", fmt.Sprintf("%+v", config)).Debug("Final config")
		return nil
	},
}

Types

type AppConfig

type AppConfig struct {
	Timeout        int    `mapstructure:"timeout"`
	BrowserPath    string `mapstructure:"browser_path"`
	ProfilesJSON   string `mapstructure:"profiles"`
	IsBrowserHead  bool   `mapstructure:"head"`
	IsLeaveHead    bool   `mapstructure:"leave_head"`
	IsLeakless     bool   `mapstructure:"leakless"`
	BlockResources string `mapstructure:"block_resources"`
	BlockTrackers  bool   `mapstructure:"block_trackers"`
	DebugEndpoints bool   `mapstructure:"debug_endpoints"`
	LogFormat      string `mapstructure:"log_format"`
}

type CORSConfig

type CORSConfig struct {
	Enabled      bool   `mapstructure:"enabled"`
	AllowOrigins string `mapstructure:"allow_origins"`
	AllowMethods string `mapstructure:"allow_methods"`
	AllowHeaders string `mapstructure:"allow_headers"`
	MaxAge       int    `mapstructure:"max_age"`
}

type CacheConfig

type CacheConfig struct {
	TTLSeconds int `mapstructure:"ttl_seconds"`
	MaxSize    int `mapstructure:"max_size"`
}

type CaptchaConfig

type CaptchaConfig struct {
	SolverEnabled bool `mapstructure:"solver_enabled"`
}

type CircuitBreakerConfig

type CircuitBreakerConfig struct {
	Failures        int `mapstructure:"failures"`
	RecoverySeconds int `mapstructure:"recovery_seconds"`
	Successes       int `mapstructure:"successes"`
}

type Config

type Config struct {
	Server           ServerConfig         `mapstructure:"server"`
	App              AppConfig            `mapstructure:"app"`
	Proxies          core.ProxiesConfig   `mapstructure:"proxies"`
	Cache            CacheConfig          `mapstructure:"cache"`
	Resilience       ResilienceConfig     `mapstructure:"resilience"`
	CircuitBreaker   CircuitBreakerConfig `mapstructure:"circuit_breaker"`
	CORS             CORSConfig           `mapstructure:"cors"`
	Captcha          CaptchaConfig        `mapstructure:"captcha"`
	Config2Capcha    Config2Captcha       `mapstructure:"2captcha"`
	GoogleConfig     EngineConfig         `mapstructure:"google"`
	YandexConfig     EngineConfig         `mapstructure:"yandex"`
	BaiduConfig      EngineConfig         `mapstructure:"baidu"`
	BingConfig       EngineConfig         `mapstructure:"bing"`
	DuckDuckGoConfig EngineConfig         `mapstructure:"duckduckgo"`
}

type Config2Captcha

type Config2Captcha struct {
	ApiKey string `mapstructure:"apikey"`
}

type EngineConfig

type EngineConfig struct {
	core.SearchEngineOptions `mapstructure:",squash"`
	Proxy                    string `mapstructure:"proxy"`
}

type ResilienceConfig

type ResilienceConfig struct {
	MaxRetries            int  `mapstructure:"max_retries"`
	AllowEndpointFallback bool `mapstructure:"allow_endpoint_fallback"`
}

type ServerConfig

type ServerConfig struct {
	Host          string `mapstructure:"host"`
	Port          int    `mapstructure:"port"`
	ConfigPath    string `mapstructure:"config_path"`
	IsDebug       bool   `mapstructure:"debug"`
	IsVerbose     bool   `mapstructure:"verbose"`
	IsRawRequests bool   `mapstructure:"raw_requests"`
	Insecure      bool   `mapstructure:"insecure"`
}