mdk/config-dist.json

   1 // Moodle Development Kit configuration file
   2 //
   3 // A comment in this file MUST be preceded by white spaces or nothing.
   4 //
   5 // This configuration file will be looked for in those directories:
   6 // - ~/.moodle-sdk/config.json
   7 // - /etc/moodle-sdk/config.json
   8 // - <MDK>/config.json
   9 //
  10 {
  11     // Directories to work with.
  12     // All of them must exist and must be writeable by the current user.
  13     // www and storage CANNOT point to the same directory and must be writeable.
  14     "dirs": {
  15         // The web directory you are going to access Moodle from, typically your virtual host DocumentRoot.
  16         // A symlink to the web directory of your Moodle instance will be created here.
  17         "www": "~/www",
  18         // The directory where the instances will be stored.
  19         "storage": "~/moodles",
  20         // A directory used by MDK to store different kind of things such as scripts and backups.
  21         "moodle": "~/.moodle-sdk",
  22         // Used for cached repositories and stuff which could be shared system-wide.
  23         "mdk": "~/.moodle-sdk"
  24     },
  25
  26     // List of remotes to work with
  27     // The integration branch MUST end with integration.git
  28     "remotes": {
  29         "stable": "git://git.moodle.org/moodle.git",
  30         "integration": "git://git.moodle.org/integration.git",
  31         "mine": "git@github.com:YourGitHub/moodle.git"
  32     },
  33
  34     // Database access
  35     "db": {
  36         // Name prefix for all databases created by mdk. Affects the database name only, not the tables.
  37         "namePrefix": "",
  38         "mariadb": {
  39             "host": "localhost",
  40             "port": "3306",
  41             "user": "root",
  42             "passwd": "root"
  43         },
  44         "mysqli": {
  45             "host": "localhost",
  46             "port": "3306",
  47             "user": "root",
  48             "passwd": "root"
  49         },
  50         "pgsql": {
  51             "host": "localhost",
  52             "port": "5432",
  53             "user": "root",
  54             "passwd": "root"
  55         }
  56     },
  57
  58     // Define the way your want things to be called
  59     "wording": {
  60
  61         // How to name your instances
  62         "prefixStable": "stable_",
  63         "prefixIntegration": "integration_",
  64         "prefixMaster": "master",
  65         "suffixSeparator": "_",
  66
  67         // How to name your branches
  68         // Read the doc about Python regular expressions if you need to modify them
  69         // http://docs.python.org/library/re.html
  70         "branchFormat": "MDL-%(issue)s-%(version)s",
  71         "branchSuffixSeparator": "-",
  72         "branchRegex": "^MDL-(?P<issue>[0-9]+)-(?P<version>[0-9a-z]+)(-(?P<suffix>[a-z0-9_-]+))?",
  73
  74         // How to name your Moodle installation
  75         "integration": "Integration",
  76         "master": "Master",
  77         "stable": "Stable",
  78         "mariadb": "MariaDB",
  79         "mysqli": "MySQL",
  80         "pgsql": "PostgreSQL"
  81     },
  82
  83     // CI Server related settings
  84     "ci": {
  85         "url": "https://integration.moodle.org",
  86         "token": null
  87     },
  88
  89     // The information for integrating MDK with Jira
  90     "tracker": {
  91         "url": "https://tracker.moodle.org/",
  92         "username": false,
  93         "fieldnames" : {
  94             "repositoryurl" : "Pull  from Repository",
  95             "27" : {
  96                 "branch" : "Pull 2.7 Branch",
  97                 "diffurl" : "Pull 2.7 Diff URL"
  98             },
  99             "29" : {
 100                 "branch" : "Pull 2.9 Branch",
 101                 "diffurl" : "Pull 2.9 Diff URL"
 102             },
 103             "30" : {
 104                 "branch" : "Pull 3.0 Branch",
 105                 "diffurl" : "Pull 3.0 Diff URL"
 106             },
 107             "31" : {
 108                 "branch" : "Pull 3.1 Branch",
 109                 "diffurl" : "Pull 3.1 Diff URL"
 110             },
 111             "master" : {
 112                 "branch" : "Pull Master Branch",
 113                 "diffurl" : "Pull Master Diff URL"
 114             }
 115         }
 116     },
 117     // The base for diff URLs, you can use the following wildcards:
 118     // - %branch%: The branch name;
 119     // - %stablebranch%: The stable branch (MOODLE_23_STABLE, MOODLE_24_STABLE, master, ...);
 120     // - %headcommit%: The head commit.
 121     // This is used to populate the fields on the tracker issue.
 122     "diffUrlTemplate": "https://github.com/YourGitHub/moodle/compare/%headcommit%...%branch%",
 123
 124     // The public acccess URL of your repository. It is used to populate the fields on the tracker issue,
 125     // and as the common read-only URL of the remote 'myRemote'.
 126     "repositoryUrl": "git://github.com/YourGitHub/moodle.git",
 127
 128     // Plugins related settings.
 129     "plugins": {
 130
 131         // Set this setting to false to disable the caching of plugins locally.
 132         "fileCache": true,
 133
 134         // Local repository for plugins missing on the database.
 135         "localRepository": {
 136             "auth_mdk": {
 137                 ">=20": {
 138                     "downloadurl": "https://github.com/FMCorz/moodle-auth_mdk/archive/master.zip"
 139                 }
 140             }
 141         }
 142     },
 143
 144     // The scheme to set during an install (http or https)
 145     "scheme": "http",
 146     // The host name to set during an install
 147     "host": "localhost",
 148     // Path to your Moodle instances, http://host/path/ should point to dirs.www.
 149     "path": "m",
 150     // Moodle admin login
 151     "login": "admin",
 152     // Moodle admin password
 153     "passwd": "test",
 154     // What to call your remote, the one pointing to remotes.mine
 155     "myRemote": "github",
 156     // What to call the upstream remote, the one pointing to the official repositoriy (stable or integration)
 157     "upstreamRemote": "origin",
 158
 159     // Config setting that should be set in config.php when an instance is being installed.
 160     "forceCfg": {
 161         // The following example will set CFG->divertallemailsto to "root@localhost.local".
 162         // "divertallemailsto": "root@localhost.local"
 163     },
 164
 165     // Behat related settings
 166     "behat": {
 167
 168         // From 2.7 Behat requires a different wwwroot than the one set in config.php.
 169         // MDK assumes that the only thing that will differ between the wwwroot and
 170         // behat wwwroot is the host, nothing else. Use a ServerAlias or /etc/hosts entries.
 171         "host": "127.0.0.1",
 172         // The number of seconds the behat command will sleep after launching the PHP Server, or Selenium.
 173         "launchSleep": 5
 174     },
 175
 176     // The name of the data directory (in dirs.storage/instanceName/)
 177     "dataDir": "moodledata",
 178     // The name of the www directory (in dirs.storage/instanceName/)
 179     "wwwDir": "moodle",
 180     // The name of the extra directory, it will be used to store different things of an instance (in dirs.storage/instanceName/)
 181     "extraDir": "extra",
 182     // The name of the web accessible directory that MDK uses to give access to the extraDirs (created in dirs.www/).
 183     "mdkDir": "mdk",
 184
 185     // The default engine to use when not specified
 186     "defaultEngine": "mysqli",
 187
 188     // Path to Git
 189     "git": "/usr/bin/git",
 190     // Path to PHP
 191     "php": "/usr/bin/php",
 192     // Path to Java
 193     "java": "/usr/bin/java",
 194     // Path to Grunt
 195     "grunt": "/usr/local/bin/grunt",
 196     // Path to recess
 197     "recess": "/usr/local/bin/recess",
 198     // Path to lessc
 199     "lessc": "/usr/local/bin/lessc",
 200     // Path to shifter
 201     "shifter": "/usr/bin/shifter",
 202     // Path to yuidoc
 203     "yuidoc": "/usr/local/bin/yuidoc",
 204     // Path to your favourite editor. Set to null to guess it from the System environment.
 205     "editor": null,
 206
 207     // Debug level of MDK. 'debug', 'info', 'warning', 'error' or 'critical'.
 208     "debug": "info",
 209
 210     // When enabled, MDK will try to be smart to identify the parent commit of the current branch. Instead of
 211     // using the stable branch it will match the branch name with an issue number and compare it with the commit
 212     // messages. The first commit message that does not match the pattern MDL-12345 will be used as the headcommit.
 213     "smartHeadCommitSearch": true,
 214
 215     // Limit the search of the head commit to the last n commits.
 216     "smartHeadCommitLimit": 50,
 217
 218     // Name of the symlink pointing to the data directory to create in the www directory
 219     // during an instance creation. If false, the symlink won't be created.
 220     "symlinkToData": false,
 221
 222     // By default MDK caches origin as a local mirror. It is much faster when it comes to upgrading
 223     // a couple of instances at the same time. MDK will update the mirror as often as it needs to,
 224     // but if you are not using MDK to upgrade your instances, you might want to disable this
 225     // functionality to only rely on the real origin. Creating new instances will not be affected
 226     // by this setting.
 227     "useCacheAsUpstreamRemote": true,
 228
 229     // You should not edit this, this is the branch that is considered as master by developers.
 230     "masterBranch": 32,
 231
 232     // Aliases for MDK commands.
 233     // An alias starting with a ! will be executed through the command line. Those also
 234     // can use placeholders for arguments: $1, $2, ...
 235     // Examples:
 236     //   "upall": "update --all". `mdk upall` will execute `mdk update --all`
 237     //   "ls": "!ls -al". `mdk ls` will execute `ls -al`
 238     "aliases": {
 239         "check": "doctor",
 240         "list": "info -l",
 241         "theme": "!mdk info -v theme -e $1 $2"
 242     }
 243 }