confpar

Documentation

Overview

Package confpar provide the core parameters of the config

Index

• type Access
• type Content
• type Logging
• type PortRange
• type ServerCert
• type SyncAndDelete
• type TLS

Types

type Access

type Access struct {
	User          string            `json:"user"`            // User authenticating
	Pass          string            `json:"pass"`            // Password used for authentication
	Fs            string            `json:"fs"`              // Backend used for accessing file
	Params        map[string]string `json:"params"`          // Backend parameters
	Logging       Logging           `json:"logging"`         // Logging parameters
	ReadOnly      bool              `json:"read_only"`       // Read-only access
	Shared        bool              `json:"shared"`          // Shared FS instance
	SyncAndDelete *SyncAndDelete    `json:"sync_and_delete"` // Local empty directory and synchronization
}

Access provides rules around any access

type Content

type Content struct {
	Version                  int        `json:"version"`                     // File format version
	ListenAddress            string     `json:"listen_address"`              // Address to listen on
	PublicHost               string     `json:"public_host"`                 // Public host to listen on
	MaxClients               int        `json:"max_clients"`                 // Maximum clients who can connect
	Accesses                 []*Access  `json:"accesses"`                    // Accesses offered to users
	PassiveTransferPortRange *PortRange `json:"passive_transfer_port_range"` // Listen port range
	Logging                  Logging    `json:"logging"`                     // Logging parameters
	TLS                      *TLS       `json:"tls"`                         // TLS Config
}

Content defines the content of the config file

type Logging

type Logging struct {
	FtpExchanges bool `json:"ftp_exchanges"` // Log all ftp exchanges
	FileAccesses bool `json:"file_accesses"` // Log all file accesses
}

Logging defines how we will log accesses

type PortRange

type PortRange struct {
	Start int `json:"start"` // Start of the range
	End   int `json:"end"`   // End of the range
}

PortRange defines a port-range ... used only for the passive transfer listening range at this stage.

type ServerCert

type ServerCert struct {
	Cert string `json:"cert"` // Public certificate(s)
	Key  string `json:"key"`  // Private key
}

ServerCert defines the TLS server certificate config

type SyncAndDelete

type SyncAndDelete struct {
	Enable    bool   `json:"enable"`    // Instant write
	Directory string `json:"directory"` // Directory
}

SyncAndDelete provides

type TLS

type TLS struct {
	ServerCert *ServerCert `json:"server_cert"` // Server certificates
}

TLS define the TLS Config