Documentation
¶
Index ¶
- Variables
- func NewCDN(config CDNConfig) *s3.S3
- func NewDB(config DatabaseConfig) (*sqlx.DB, error)
- func NewMQ(conf MQConfig) (*amqp.Connection, error)
- func Transact(db *sqlx.DB, txFunc func(*sqlx.Tx) error) (err error)
- type CDNConfig
- type DatabaseConfig
- type JWTClaims
- type MQConfig
- type Mail
- type MailConfig
- type Mailer
- type Permission
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrNoCookie = errors.New("failed to find token cookie") ErrInvalidCookie = errors.New("invalid cookie") )
Functions ¶
func NewDB ¶ added in v0.7.0
func NewDB(config DatabaseConfig) (*sqlx.DB, error)
NewDB Initialises the connection to the database
Types ¶
type CDNConfig ¶ added in v0.7.0
CDNConfig represents a configuration to connect to a CDN / S3 instance
type DatabaseConfig ¶ added in v0.7.0
type DatabaseConfig struct {
Host string
Port string
SSLMode string
Name string
Username string
Password string
}
DatabaseConfig represents a configuration to connect to an SQL database
type JWTClaims ¶
type JWTClaims struct {
UserID int `json:"id"`
Permissions []Permission `json:"perms"`
jwt.StandardClaims
}
JWTClaims represents an identifiable JWT
func GetTokenEcho ¶ added in v0.7.0
GetToken will return the JWT claims from a valid JWT token
type Mail ¶ added in v0.7.0
type Mail struct {
Subject string
To string
Cc []string
Bcc []string
From string
// contains filtered or unexported fields
}
Mail represents an email to be sent
type MailConfig ¶ added in v0.7.0
MailConfig represents a configuration to connect to an SMTP server
type Mailer ¶ added in v0.7.0
type Mailer struct {
*mail.SMTPClient
Enabled bool
}
Mailer encapsulates the dependency
func NewMailer ¶ added in v0.7.0
func NewMailer(config MailConfig) (*Mailer, error)
NewMailer creates a new SMTP client
type Permission ¶ added in v0.7.0
Permission represents the permissions that a user has
Click to show internal directories.
Click to hide internal directories.