package
0.20.0
Repository: https://github.com/drud/ddev.git
Documentation: pkg.go.dev

# Functions

AvailableDocrootLocations returns an of default docroot locations to look for.
CheckForConf checks for a config.yaml at the cwd or parent dirs.
CheckRouterPorts tries to connect to the ports the router will use as a heuristic to find out if they're available for docker to bind to.
Cleanup will remove ddev containers and volumes even if docker-compose.yml has been deleted.
CreateAppTable will create a new app table for describe and list output.
DiscoverDefaultDocroot returns the default docroot directory.
GetActiveApp returns the active App based on the current working directory or running siteName provided.
GetActiveAppRoot returns the fully rooted directory of the active app, or an error.
GetApps returns an array of ddev applications.
GetRouterStatus outputs router status and warning if not running or healthy, as applicable.
GetValidAppTypes returns the valid apptype keys from the appTypeMatrix.
IsValidAppType checks to see if the given apptype string is a valid configured apptype.
NewApp creates a new DdevApp struct with defaults set and overridden by any existing config.yml.
NewBackdropSettings produces a BackdropSettings object with default values.
NewDrupalSettings produces a DrupalSettings object with default.
NewDrushConfig produces a DrushConfig object with default.
NewWordpressConfig produces a WordpressConfig object with defaults.
PrepDdevDirectory creates a .ddev directory in the current working directory.
RenderAppRow will add an application row to an existing table for describe and list output.
RenderHomeRootedDir shortens a directory name to replace homedir with ~.
RenderRouterStatus returns a user-friendly string showing router-status.
RouterComposeYAMLPath returns the full filepath to the routers docker-compose yaml file.
StartDdevRouter ensures the router is running.
StopRouterIfNoContainers stops the router if there are no ddev containers running.
WriteDrushConfig writes out a drush config based on passed-in values.
WriteWordpressConfig dynamically produces valid wp-config.php file by combining a configuration object with a data-driven template.

# Constants

ConfigInstructions is used to add example hooks usage.
DDevComposeTemplate is used to create the main docker-compose.yaml file for a ddev site.
DdevDefaultPHPVersion is the default PHP version, overridden by $DDEV_PHP_VERSION.
DdevDefaultRouterHTTPPort is the starting router port, 80.
DdevDefaultRouterHTTPSPort is the starting https router port, 443.
DdevFileSignature is the text we use to detect whether a settings file is managed by us.
DdevRouterTemplate is the template for the generic router container.
DefaultProviderName contains the name of the default provider which will be used if one is not otherwise specified.
Drupal7Hooks adds a d7-specific hooks example for post-import-db.
Drupal8Hooks adds a d8-specific hooks example for post-import-db.
RouterProjectName is the "machine name" of the router docker-compose.
SiteConfigMissing defines the string used to denote when a site is missing its .ddev/config.yml file.
SiteDirMissing defines the string used to denote when a site is missing its application directory.
SiteNotFound defines the string used to denote a site where the containers were not found/do not exist.
SiteRunning defines the string used to denote running sites.
SiteStopped defines the string used to denote when a site is in the stopped state.
Typo3Hooks adds a TYPO3-specific hooks example for post-import-db.

# Variables

SequelproTemplate is the template for Sequelpro config.

# Structs

AppTypeFuncs struct defines the functions that can be called (if populated) for a given appType.
BackdropSettings holds database connection details for Backdrop.
Command defines commands to be run as pre/post hooks.
DdevApp is the struct that represents a ddev app, mostly its config from config.yaml.
DefaultProvider provides a no-op for the provider plugin interface methods.
DrupalSettings encapsulates all the configurations for a Drupal site.
DrushConfig encapsulates configuration for a drush settings file.
PantheonProvider provides pantheon-specific import functionality.
WordpressConfig encapsulates all the configurations for a WordPress site.

# Interfaces

Provider is the interface which all provider plugins must implement.