Documentation
¶
Index ¶
- Constants
- Variables
- func ArrayContainsString(slice []string, element string) bool
- func GetValidMariaDBVersions() []string
- func GetValidMySQLVersions() []string
- func GetValidOmitContainers() []string
- func GetValidPHPVersions() []string
- func GetValidProviders() []string
- func GetValidWebserverTypes() []string
- func IsDockerToolbox() bool
- func IsInternetActive() bool
- func IsValidMariaDBVersion(MariaDBVersion string) bool
- func IsValidMySQLVersion(v string) bool
- func IsValidOmitContainers(containerList []string) bool
- func IsValidPHPVersion(phpVersion string) bool
- func IsValidProvider(provider string) bool
- func IsValidWebserverType(webserverType string) bool
Constants ¶
const ( ProviderDrudS3 = "drud-s3" ProviderPantheon = "pantheon" // ProviderDefault contains the name of the default provider which will be used if one is not otherwise specified. ProviderDefault = "default" )
Providers
const ( PHP56 = "5.6" PHP70 = "7.0" PHP71 = "7.1" PHP72 = "7.2" PHP73 = "7.3" PHP74 = "7.4" )
PHP Versions
const ( MariaDB55 = "5.5" MariaDB100 = "10.0" MariaDB101 = "10.1" MariaDB102 = "10.2" MariaDB103 = "10.3" MariaDB104 = "10.4" )
MariaDB Versions
const ( MySQL55 = "5.5" MySQL56 = "5.6" MySQL57 = "5.7" MySQL80 = "8.0" )
Oracle MySQL versions
const ( MariaDB = "mariadb" MySQL = "mysql" )
Database Types
const ( DdevSSHAgentContainer = "ddev-ssh-agent" DBAContainer = "dba" DBContainer = "db" WebContainer = "web" RouterContainer = "ddev-router" )
Container types used with ddev
const ( WebserverNginxFPM = "nginx-fpm" WebserverApacheFPM = "apache-fpm" WebserverApacheCGI = "apache-cgi" )
Webserver types
const ( AppTypeBackdrop = "backdrop" AppTypeDrupal6 = "drupal6" AppTypeDrupal7 = "drupal7" AppTypeDrupal8 = "drupal8" AppTypePHP = "php" AppTypeTYPO3 = "typo3" AppTypeWordPress = "wordpress" AppTypeMagento = "magento" AppTypeMagento2 = "magento2" )
App types
const ( // DdevDefaultRouterHTTPPort is the default router HTTP port DdevDefaultRouterHTTPPort = "80" // DdevDefaultRouterHTTPSPort is the default router HTTPS port DdevDefaultRouterHTTPSPort = "443" // DdevDefaultPHPMyAdminPort is the default router port for dba/PHPMyadmin DdevDefaultPHPMyAdminPort = "8036" // DdevDefaultMailhogPort is the default router port for Mailhog DdevDefaultMailhogPort = "8025" // DdevDefaultTLD is the top-level-domain used by default, can be overridden DdevDefaultTLD = "ddev.site" )
Ports and other defaults
const PHPDefault = PHP73
PHPDefault is the default PHP version, overridden by $DDEV_PHP_VERSION
Variables ¶
var InstrumentationTags = map[string]string{}
var NFSMountEnabledDefault = false
NFSMountEnabledDefault is default value for app.NFSMountEnabled
var ValidMariaDBVersions = map[string]bool{ MariaDB55: true, MariaDB100: true, MariaDB101: true, MariaDB102: true, MariaDB103: true, MariaDB104: true, }
var ValidMySQLVersions = map[string]bool{ MySQL55: true, MySQL56: true, MySQL57: true, MySQL80: true, }
var ValidOmitContainers = map[string]bool{ DBContainer: true, DdevSSHAgentContainer: true, DBAContainer: true, }
var ValidPHPVersions = map[string]bool{ PHP56: true, PHP70: true, PHP71: true, PHP72: true, PHP73: true, PHP74: true, }
ValidPHPVersions should be updated whenever PHP versions are added or removed, and should be used to ensure user-supplied values are valid.
var ValidProviders = map[string]bool{ ProviderDefault: true, ProviderDrudS3: true, ProviderPantheon: true, }
ValidProviders should be updated whenever provider plugins are added or removed, and should be used to ensure user-supplied values are valid.
var ValidWebserverTypes = map[string]bool{ WebserverNginxFPM: true, WebserverApacheFPM: true, WebserverApacheCGI: true, }
ValidWebserverTypes should be updated whenever supported webserver types are added or removed, and should be used to ensure user-supplied values are valid.
var WebserverDefault = WebserverNginxFPM
WebserverDefault is the default webserver type, overridden by $DDEV_WEBSERVER_TYPE
Functions ¶
func ArrayContainsString ¶
ArrayContainsString returns true if slice contains element
func GetValidMariaDBVersions ¶ added in v1.12.0
func GetValidMariaDBVersions() []string
GetValidMariaDBVersions is a helper function that returns a list of valid MariaDB versions.
func GetValidMySQLVersions ¶ added in v1.12.0
func GetValidMySQLVersions() []string
GetValidMySQLVersions is a helper function that returns a list of valid MySQL versions.
func GetValidOmitContainers ¶ added in v1.12.0
func GetValidOmitContainers() []string
GetValidOmitContainers is a helper function that returns a list of valid containers for OmitContainers.
func GetValidPHPVersions ¶ added in v1.12.0
func GetValidPHPVersions() []string
GetValidPHPVersions is a helper function that returns a list of valid PHP versions.
func GetValidProviders ¶ added in v1.12.0
func GetValidProviders() []string
GetValidProviders is a helper function that returns a list of valid providers.
func GetValidWebserverTypes ¶ added in v1.12.0
func GetValidWebserverTypes() []string
GetValidWebserverTypes is a helper function that returns a list of valid webserver types.
func IsDockerToolbox ¶ added in v1.8.0
func IsDockerToolbox() bool
IsDockerToolbox detects if the running docker is docker toolbox It shouldn't be run much as it requires actually running the executable. This lives here instead of in dockerutils to avoid unecessary import cycles. Inspired by https://stackoverflow.com/questions/43242218/how-can-a-script-distinguish-docker-toolbox-and-docker-for-windows
func IsInternetActive ¶ added in v1.9.0
func IsInternetActive() bool
IsInternetActive() checks to see if we have a viable internet connection. It just tries a quick DNS query. This requires that the named record be query-able.
func IsValidMariaDBVersion ¶ added in v1.12.0
IsValidMariaDBVersion is a helper function to determine if a MariaDB version is valid, returning true if the supplied MariaDB version is valid and false otherwise.
func IsValidMySQLVersion ¶ added in v1.12.0
IsValidMySQLVersion is a helper function to determine if a MySQL version is valid, returning true if the supplied version is valid and false otherwise.
func IsValidOmitContainers ¶ added in v1.12.0
IsValidOmitContainers is a helper function to determine if a the OmitContainers array is valid
func IsValidPHPVersion ¶ added in v1.12.0
IsValidPHPVersion is a helper function to determine if a PHP version is valid, returning true if the supplied PHP version is valid and false otherwise.
func IsValidProvider ¶ added in v1.12.0
IsValidProvider is a helper function to determine if a provider value is valid, returning true if the supplied provider is valid and false otherwise.
func IsValidWebserverType ¶ added in v1.12.0
IsValidWebserverType is a helper function to determine if a webserver type is valid, returning true if the supplied webserver type is valid and false otherwise.
Types ¶
This section is empty.