configurations

Documentation

Index

• type AuthConfiguration
  • func GetAuthConfigurations() AuthConfiguration
• type DatabaseConfiguration
  • func GetDatabaseConfigurations() DatabaseConfiguration
• type EmailConfiguration
  • func GetEmailConfigurations() EmailConfiguration
• type NYTimesAPIConfig
  • func GetNYTimesAPIConfig() NYTimesAPIConfig
• type PathConfiguration
  • func GetPathConfigurations() PathConfiguration

Types

type AuthConfiguration

type AuthConfiguration struct {
	JWTCipherKey []byte
}

AuthConfiguration - Struct for Configurations

func GetAuthConfigurations

func GetAuthConfigurations() AuthConfiguration

GetAuthConfigurations - Retrieves the email data

type DatabaseConfiguration

type DatabaseConfiguration struct {
	DBServer   string
	DBName     string
	DBUser     string
	DBPassword string
}

DatabaseConfiguration - Struct for Configurations

func GetDatabaseConfigurations

func GetDatabaseConfigurations() DatabaseConfiguration

GetDatabaseConfigurations - Retrieves the database data

type EmailConfiguration

type EmailConfiguration struct {
	FromEmail  string
	Password   string
	MailServer string
	SMTPType   string
}

EmailConfiguration - Struct for Configurations

func GetEmailConfigurations

func GetEmailConfigurations() EmailConfiguration

GetEmailConfigurations - Retrieves the email data

type NYTimesAPIConfig

type NYTimesAPIConfig struct {
	Credentials  map[string]string `json:"credentials"`
	APIEndpoints map[string]string `json:"api_endpoints"`
}

NYTimesAPIConfig - Struct for NY Times API Configurations

func GetNYTimesAPIConfig

func GetNYTimesAPIConfig() NYTimesAPIConfig

GetNYTimesAPIConfig - Retrieves the email data

type PathConfiguration

type PathConfiguration struct {
	RawCorpusRoot     string
	CleanedCorpusRoot string
	ArchivePath       string
	ArticlePath       string
}

PathConfiguration - Struct for Configurations

func GetPathConfigurations

func GetPathConfigurations() PathConfiguration

GetPathConfigurations - Retrieves the email data