├── LICENSE ├── README.md └── vvv /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # VVV Site Wizard 2 | 3 | ## Important: 4 | 5 | **I'm not very active on this project, but [bradp](https://github.com/bradp) is doing great work on his fork of this project, [Variable VVV](https://github.com/bradp/vv).** 6 | 7 | Version 1.1.3 8 | 9 | This bash script makes it easy to spin up a new WordPress site using [Varying Vagrant Vagrants](https://github.com/Varying-Vagrant-Vagrants/VVV). 10 | 11 | ## Installation 12 | 13 | Download the script and run `./vvv` from the directory the script is placed in. 14 | 15 | To run the script from anywhere, you can place `vvv` in a folder included in your PATH environment variable. 16 | 17 | If you don't want to define the path each time you run the script, open the file and uncomment the line at the top defining `path`. Set that to the root folder of VVV on your machine. **Note:** You do not need to do this if VVV is installed in the default location (`~/vagrant-local/`). 18 | 19 | ## Usage 20 | 21 | Type `vvv` in the command line to use. None of the options are required: if a required piece of information is not included in the original command, the wizard will prompt you for it. 22 | 23 | ### Options 24 | 25 | |Option|Name |Description| 26 | |------|-----------|-----------| 27 | |`-a` |action |`new`/`create`/`make` runs the site creation wizard, `rm`/`delete`/`teardown` runs the site teardown wizard, `list` lists all current VVV sites| 28 | |`-d` |domain |Desired domain (e.g. mysite.dev)| 29 | |`-f` |files only |Do not provision Vagrant, just create the site directory and files| 30 | |`-i` |image proxy|Load images by proxy from the live site (so you don't have to download the uploads folder)| 31 | |`-l` |live URL |URL of the live site, currently only used if loading images by proxy| 32 | |`-n` |site name |Desired name for the site directory (e.g. mysite)| 33 | |`-p` |path |Path to VVV root (e.g. ~/vagrant-local)| 34 | |`-v` |version |Version of WordPress to install| 35 | |`-x` |debug |Turn on WP_DEBUG and WP_DEBUG_LOG| 36 | 37 | Examples: 38 | 39 | ``` 40 | vvv -a new 41 | vvv -a create -n mysite -d mysite.dev -v 3.9.1 -x 42 | vvv -a make -fxil mysite.com -n mysite -d mysite.dev -v 3.9.1 43 | vvv -a delete mysite 44 | vvv -a list 45 | ``` 46 | 47 | ## Site Creation Wizard 48 | 49 | Creating a site does the following: 50 | 51 | * Halts Vagrant (if running) 52 | * Creates a web root for the site in the `www` folder containing three files: `vvv-init.sh`, `wp-cli.yml`, and `vvv-hosts` 53 | * `vvv-init.sh` tells Vagrant to create a database if one does not exist and install the latest version of WordPress (via WP-CLI) the next time Vagrant is provisioned 54 | * `wp-cli.yml` tells WP-CLI that WordPress is in the htdocs folder 55 | * `vvv-hosts` contains the hosts entry to give your site a nice custom domain (the domain is set in the wizard) 56 | * Creates a file in the `nginx-config` folder to handle server settings for your site 57 | * Restarts Vagrant with `vagrant up --provision` 58 | 59 | Provisioning Vagrant takes a couple of minutes, but this is a crucial step as it downloads WordPress into your site's htdocs directory and runs the installation. If you want to skip provisioning and install WordPress manually, you can run the new site's `vvv-init.sh` file directly in the Vagrant shell. 60 | 61 | ## Site Teardown Wizard 62 | 63 | Deleting a site does the following: 64 | 65 | * Halts Vagrant (if running) 66 | * Deletes the site's web root (which deletes the `vvv-init.sh`, `wp-cli.yml`, and `vvv-hosts` files as well) 67 | * Deletes the file in the `nginx-config` folder pertaining to the site 68 | 69 | Note that it does not delete the site's database. 70 | 71 | ## Questions? 72 | 73 | Ping me on Twitter at [@alisothegeek](http://twitter.com/alisothegeek). 74 | 75 | ## Changelog 76 | 77 | ### 1.1.3 78 | 79 | * Fix forward slashes in a live site URL (used for the image proxy) causing an error 80 | * Fix done_text implementation in the site teardown wizard 81 | 82 | ### 1.1.2 83 | 84 | * Add the ability to load images by proxy from the live site (props [@TheLastCicada](https://gist.github.com/TheLastCicada/ee6775c5f269f5f5389f)) 85 | * Fix bug where wp_debug was not set properly when set via command option 86 | 87 | ### 1.1.1 88 | 89 | * Add default VVV install path to script (if VVV is installed in default location, `path` no longer needs to be explicitly defined) 90 | 91 | ### 1.1 92 | 93 | * Add ability to select WordPress version (props [@adamsilverstein](https://github.com/aliso/vvv-site-wizard/pull/10)) 94 | * Add ability to define `WP_DEBUG` and `WP_DEBUG_LOG` 95 | * Convert positional parameters to command line options for maximum flexibility 96 | 97 | ### 1.0.1 98 | 99 | * Switch to using WP-CLI instead of SVN to install WordPress 100 | * Allow for tab completions when defining directories 101 | 102 | ### 1.0 103 | 104 | * Initial release 105 | -------------------------------------------------------------------------------- /vvv: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # ============================================================================= 4 | # VVV Site Setup Script 5 | # By Alison Barrett 6 | # https://github.com/aliso/vvv-site-wizard 7 | # 8 | # Version 1.1.3 9 | # 10 | # This script automates the creation & deletion of new WordPress sites using 11 | # Varying Vagrant Vagrants (https://github.com/Varying-Vagrant-Vagrants/VVV). 12 | # 13 | # Usage: 14 | # vvv [-a create|delete|list] [-n site] [-v version] [-d domain] 15 | # [-p path/to/vvv] [-f] [-x] 16 | # ============================================================================= 17 | # 18 | # When not called from the VVV root directory, the script will prompt the user 19 | # for the path to VVV. To run this from any directory and skip that prompt, 20 | # uncomment the following line and set it to the VVV root dir: 21 | #path=/path/to/vvv/root 22 | 23 | # ============================================================================= 24 | # Helper function for printing out usage information. 25 | # ============================================================================= 26 | usage() { 27 | printf "Usage: vvv [-a create|delete|list] [-n site] [-v version] [-d domain] [-p path/to/vvv] [-f] [-x]\n\n"\ 28 | "Options:\n"\ 29 | "-a action Can be create, delete, or list\n"\ 30 | "-d domain Desired domain (e.g. mysite.dev)\n"\ 31 | "-f files only Do not provision Vagrant, just create the site directory and files\n"\ 32 | "-i image proxy Load images by proxy from the live site (so you don't have to download the uploads folder)\n"\ 33 | "-l live URL URL of the live site, currently only used if loading images by proxy\n"\ 34 | "-n site name Desired name for the site directory (e.g. mysite)\n"\ 35 | "-p path Path to VVV root (e.g. ~/vagrant-local)\n"\ 36 | "-v version Version of WordPress to install\n"\ 37 | "-x debug Turn on WP_DEBUG and WP_DEBUG_LOG\n"\ 38 | "\n" 39 | exit 1; 40 | } 41 | 42 | # ============================================================================= 43 | # Helper function since a green "Done." is used in a lot of places 44 | # ============================================================================= 45 | done_text() { echo -e "\033[32mDone.\033[0m"; return; } 46 | 47 | # ============================================================================= 48 | # Helper function to make colored text easier to code and more readable 49 | # within the code. 50 | # ============================================================================= 51 | cecho() { 52 | message=$1 53 | color=${2:-'default'} 54 | attribute=${3:-'none'} 55 | 56 | color_type='3' 57 | color_code='0' 58 | if [[ $color = 'black' ]]; then 59 | color_code='0' 60 | elif [[ $color = 'red' ]]; then 61 | color_code='1' 62 | elif [[ $color = 'green' ]]; then 63 | color_code='2' 64 | elif [[ $color = 'yellow' ]]; then 65 | color_code='3' 66 | elif [[ $color = 'blue' ]]; then 67 | color_code='4' 68 | elif [[ $color = 'magenta' ]]; then 69 | color_code='5' 70 | elif [[ $color = 'cyan' ]]; then 71 | color_code='6' 72 | elif [[ $color = 'white' ]]; then 73 | color_code='7' 74 | fi 75 | 76 | attribute_code='' 77 | if [[ $attribute = 'bold' ]]; then 78 | attribute_code=';1' 79 | elif [[ $attribute = 'underlined' ]]; then 80 | attribute_code=';4' 81 | elif [[ $attribute = 'reverse' ]]; then 82 | attribute_code=';7' 83 | elif [[ $attribute = 'background' ]]; then 84 | color_type='0;1;4' 85 | fi 86 | 87 | # set text attributes 88 | echo -en "\033[${color_type}${color_code}${attribute_code}m" 89 | # echo text 90 | echo -en "$message" 91 | # reset text attributes 92 | echo -en "\033[0m\n" 93 | 94 | return 95 | } 96 | 97 | # ============================================================================= 98 | # Help 99 | # ============================================================================= 100 | if [[ "$1" = 'help' || "$1" = '-h' ]]; then 101 | usage 102 | exit 1 103 | fi 104 | 105 | # ============================================================================= 106 | # Vaaaaaars! 107 | # ============================================================================= 108 | files_only=false 109 | wp_debug=false 110 | 111 | while getopts "xfil:a:n:v:p:d:" opt; do 112 | case $opt in 113 | a) 114 | action=$OPTARG >&2 115 | ;; 116 | n) 117 | site=$OPTARG >&2 118 | ;; 119 | f) 120 | files_only=true >&2 121 | ;; 122 | v) 123 | version=$OPTARG >&2 124 | ;; 125 | p) 126 | path=$OPTARG >&2 127 | ;; 128 | d) 129 | domain=$OPTARG >&2 130 | ;; 131 | x) 132 | wp_debug=y >&2 133 | ;; 134 | i) 135 | image_proxy=y >&2 136 | ;; 137 | l) 138 | live_site_url=$OPTARG >&2 139 | ;; 140 | \?) 141 | cecho "Invalid option: -$OPTARG" red 142 | exit 1 143 | ;; 144 | :) 145 | cecho "Option -$OPTARG requires an argument" red 146 | exit 1 147 | ;; 148 | esac 149 | done 150 | 151 | # ============================================================================= 152 | # Get the action if it was not specified 153 | # ============================================================================= 154 | while [ -z $action ]; do 155 | read -e -p "Action (create|delete|list): " action 156 | 157 | if [ -z $action ]; then 158 | cecho "You must choose an action." red 159 | elif [[ $action != 'create' && $action != 'delete' && $action != 'list' ]]; then 160 | cecho "Answer create, delete, or list." red 161 | unset action 162 | fi 163 | done 164 | 165 | # ============================================================================= 166 | # Get the VVV root directory if the user is entering a valid command 167 | # 168 | # This is placed outside of the action conditionals below because setting the 169 | # directory is required for every possible action. 170 | # ============================================================================= 171 | if [[ $action = 'new' || $action = 'make' || $action = 'create' || $action = 'delete' || $action = 'teardown' || $action = 'rm' || $action = 'list' ]]; then 172 | # Get VVV root dir 173 | if [ ! -z $path ]; then 174 | path=$path 175 | else 176 | current_dir=`pwd` 177 | if [ -e "$current_dir/Vagrantfile" ]; then 178 | path=`pwd` 179 | elif [ -e ~/vagrant-local/Vagrantfile ]; then 180 | path=~/vagrant-local 181 | else 182 | while [ -z $path ]; do 183 | read -e -p "VVV install directory: " path 184 | 185 | # Make sure directory is actually a VVV root 186 | if [ ! -e "$path/Vagrantfile" ]; then 187 | cecho "Path specified is not a VVV root directory." red bold 188 | unset path 189 | fi 190 | done 191 | fi 192 | fi 193 | path=${path%/} 194 | fi 195 | 196 | # ============================================================================= 197 | # Create a site 198 | # 199 | # New sites are created with a fresh installation of WordPress trunk that 200 | # updates each time Vagrant is provisioned (vagrant up --provision). 201 | # 202 | # New site credentials: 203 | # Username: admin 204 | # Password: password 205 | # 206 | # If you want to see the files that are created without spinning up the new 207 | # site, use a third parameter of 'filesonly'. Example: 208 | # vvv [new|create|make] site filesonly 209 | # ============================================================================= 210 | if [[ $action = 'new' || $action = 'make' || $action = 'create' ]]; then 211 | 212 | files_only_text='' 213 | if [[ "$files_only" = true ]]; then 214 | files_only_text=" (file creation only)" 215 | fi 216 | cecho "\nNew VVV Site Setup$files_only_text" blue bold 217 | 218 | # Prompt user for vars 219 | # ============================================================================= 220 | 221 | # Get site dir name if not supplied as argument 222 | if [ -d "$path/www/$site" ]; then 223 | cecho "Directory $path/www/$site already exists." red 224 | unset site 225 | fi 226 | while [ -z $site ]; do 227 | read -e -p "Name of new site directory: " site 228 | 229 | if [ -z $site ]; then 230 | cecho "You must enter a directory name." red 231 | elif [ -d "$path/www/$site" ]; then 232 | cecho "Directory already exists." red 233 | unset site 234 | fi 235 | done 236 | 237 | # Get database name 238 | db_name=$site 239 | 240 | # Get local URL 241 | while [ -z $domain ]; do 242 | echo -n "Domain to use (leave blank for $site.dev): " 243 | read domain 244 | if [ -z $domain ]; then 245 | domain="$site.dev" 246 | fi 247 | done 248 | 249 | if [ ! -z $version ]; then 250 | # Attempt to verify the existence of the version (hacky) 251 | if curl -s http://codex.wordpress.org/Version_$version | grep 'currently no text' > /dev/null; then 252 | cecho "Version $version not found, try again" red 253 | unset version 254 | else 255 | installversion=" --version=$version" 256 | fi 257 | fi 258 | 259 | while [[ -z $version ]]; do 260 | # Get WordPress version 261 | echo -n "WordPress version to install (leave blank for release version): " 262 | read version 263 | if [ -z $version ]; then 264 | installversion="" 265 | version="(release version)" 266 | else 267 | # Attempt to verify the existence of the version (hacky) 268 | if curl -s http://codex.wordpress.org/Version_$version | grep 'currently no text' > /dev/null; then 269 | cecho "Version $version not found, try again" red 270 | unset version 271 | else 272 | installversion=" --version=$version" 273 | fi 274 | fi 275 | done 276 | 277 | # Ask if WP_DEBUG should be turned on 278 | while [ -z $wp_debug ]; do 279 | echo -n "Enable WP_DEBUG and WP_DEBUG_LOG (y/n): " 280 | read wp_debug 281 | if [[ $wp_debug != 'y' && $wp_debug != 'n' ]]; then 282 | cecho "Answer y or n." red 283 | unset wp_debug 284 | fi 285 | done 286 | 287 | # Ask if images should be loaded from the live site 288 | while [ -z $image_proxy ]; do 289 | echo -n "Load images from live site (y/n): " 290 | read image_proxy 291 | if [[ $image_proxy != 'y' && $image_proxy != 'n' ]]; then 292 | cecho "Answer y or n." red 293 | unset image_proxy 294 | fi 295 | done 296 | 297 | if [[ $image_proxy == 'y' ]]; then 298 | while [ -z $live_site_url ]; do 299 | read -e -p "Live site URL (no http:// or trailing slash): " live_site_url 300 | done 301 | fi 302 | 303 | # Inform the user of what's about to happen and give them a chance to back out 304 | # ============================================================================= 305 | cecho "\nAbout to perform the following:" normal bold 306 | echo -e "* Halt Vagrant (if running)\n* Create directory $site in $path/www\n* Create files vvv-init.sh, wp-cli.yml, and vvv-hosts in directory $site\n* Create file $site.conf in $path/config/nginx-config/sites" 307 | if [[ "$files_only" = false ]]; then 308 | echo -e "* Run \`vagrant up --provision\` to initialize site" 309 | else 310 | cecho "\nNote: You will need to run \`vagrant up --provision\` to initialize the new site before $domain will load in a browser." red 311 | fi 312 | 313 | cecho "\nProvisioning Vagrant will do the following:" default bold 314 | echo -e "* Create database $site\n* Install WordPress $version in the htdocs directory\n* Make the site visible at $domain" 315 | 316 | echo -en "\n" 317 | while [ -z $continue_create ]; do 318 | echo -n "Continue (y/n)? " 319 | read continue_create 320 | 321 | if [[ $continue_create = 'n' ]]; then 322 | cecho "Site setup aborted." red 323 | exit 324 | elif [[ $continue_create != 'y' ]]; then 325 | cecho "Answer y or n." red 326 | unset continue_create 327 | fi 328 | done 329 | 330 | # Start the par-tay 331 | # ============================================================================= 332 | cecho "\nNew VVV setup starting for site '$site'" green 333 | cd $path 334 | vagrant halt 335 | 336 | # Create site folder with vvv-init.sh file 337 | # ============================================================================= 338 | cd $path/www 339 | echo -en "Creating site directory, wp-cli.yml, and vvv-init.sh file... " 340 | mkdir $site && cd $site 341 | 342 | printf "path: htdocs" > wp-cli.yml 343 | 344 | wp_debug_text='' 345 | if [[ $wp_debug = 'y' ]]; then 346 | wp_debug_text=" --extra-php < vvv-init.sh 364 | 365 | done_text 366 | 367 | # Add vvv-hosts file for domain in the site's www root 368 | # ============================================================================= 369 | cd $path/www/$site 370 | echo -en "Adding $domain to new vvv-hosts file... " 371 | touch vvv-hosts 372 | printf "$domain\n" >> vvv-hosts 373 | done_text 374 | 375 | # Add site conf file to nginx-config 376 | # ============================================================================= 377 | cd $path/config/nginx-config/sites 378 | echo -en "Creating nginx-config/sites/$site.conf... " 379 | sed -e "s|testserver\.com|$domain|" \ 380 | -e "s|wordpress-local|$site/htdocs|" local-nginx-example.conf-sample > $site.conf 381 | 382 | if [[ $image_proxy = 'y' ]]; then 383 | sed -e $'s|\}|\\\n\\\t# Directives to send expires headers and turn off 404 error logging\.\\\n\\\tlocation ~\* \\.\(js\|css\|png\|jpg\|jpeg\|gif\|ico\)\$ \{\\\n\\\t\texpires 24h;\\\n\\\t\\\tlog_not_found off;\\\n\\\t\\\ttry_files \$uri \$uri\/ @production;\\\n\\\t\}\\\n\\\n\\\tlocation @production \{\\\n\\\t\\\tresolver 8\.8\.8\.8;\\\n\\\t\\\tproxy_pass http://LIVE_URL/$uri;\\\n\\\t\}\\\n\}|' -e "s|LIVE_URL|$live_site_url|" $site.conf > tmp.conf 384 | rm $site.conf 385 | mv tmp.conf $site.conf 386 | fi 387 | 388 | done_text 389 | 390 | # vagrant waaaaay up 391 | # ============================================================================= 392 | cd $path 393 | if [[ "$files_only" = false ]]; then 394 | echo -e "Running vagrant up --provision... " 395 | vagrant up --provision 396 | fi 397 | 398 | # OMG we're done. 399 | # ============================================================================= 400 | if [[ "$files_only" = true ]]; then 401 | cecho "\nRemember to run \`vagrant up --provision\` to initialize the new site." red 402 | fi 403 | 404 | cecho "\nNew VVV Site Setup: Done!" blue bold 405 | echo "Directory: $path/www/$site" 406 | echo "URL: $domain" 407 | echo "Username: admin" 408 | echo "Password: password" 409 | 410 | exit 411 | 412 | # ============================================================================= 413 | # Delete a site 414 | # 415 | # This will remove the site folder from www and remove the .conf file from 416 | # nginx-config. Sites and folders installed by default with VVV cannot be 417 | # deleted this way. 418 | # ============================================================================= 419 | elif [[ $action = 'teardown' || $action = 'delete' || $action = 'rm' ]]; then 420 | 421 | cecho "\nVVV Site Teardown" blue bold 422 | 423 | # Get site dir name if not supplied as argument 424 | while [ -z $site ]; do 425 | echo -n "Site directory to delete: " 426 | read site 427 | 428 | if [[ -z $site || ! -d "$path/www/$site" ]]; then 429 | cecho "You must enter a valid directory from $path/www/." 430 | unset site 431 | elif [[ $site = 'wordpress-default' || $site = 'wordpress-develop' || $site = 'wordpress-trunk' || $site = 'default' || $site = 'phpcs' || $site = 'vvv-hosts' || $site = 'wp-cli' || $site = '.gitshow' ]]; then 432 | cecho "This script can't delete the default VVV folders." red 433 | unset site 434 | fi 435 | done 436 | 437 | # Start the deletion par-tay 438 | # ============================================================================= 439 | echo -e "\nAbout to perform the following:\n\n* Halt Vagrant (if running)\n* Delete directory $site in $path/www\n* Delete file $site.conf in $path/config/nginx-config/sites\n" 440 | while [ -z $continue_delete ]; do 441 | echo -n "Continue (y/n)? " 442 | read continue_delete 443 | if [ $continue_delete = 'y' ]; then 444 | cecho "\nVVV teardown starting for site '$site'" green 445 | cd $path 446 | 447 | vagrant halt 448 | 449 | # Delete the site folder 450 | echo -en "Removing directory $site... " 451 | rm -rf $path/www/$site 452 | done_text 453 | 454 | # Remove the nginx conf file 455 | echo -en "Removing nginx config file $site.conf... " 456 | rm $path/config/nginx-config/sites/$site.conf 457 | done_text 458 | 459 | # Delorted. 460 | cecho "\nVVV Site Teardown: Done!" blue bold 461 | exit 462 | 463 | elif [ $continue_delete = 'n' ]; then 464 | cecho "Site teardown aborted." red 465 | exit 466 | else 467 | cecho "Answer y or n." red 468 | unset continue_delete 469 | fi 470 | done 471 | exit 472 | 473 | # ============================================================================= 474 | # List VVV sites 475 | # 476 | # This lists the VVV sites currently present in the www folder, including the 477 | # sites installed by default with VVV (wordpress-default, wordpress-trunk, 478 | # and wordpress-dev). 479 | # ============================================================================= 480 | elif [[ $action = 'list' ]]; then 481 | 482 | cd $path/www 483 | find . -maxdepth 1 -mindepth 1 -type d -print0 | while IFS= read -d '' filename; do 484 | filename=${filename:2} 485 | if [[ $filename != 'default' && $filename != 'phpcs' && $filename != 'wp-cli' ]]; then 486 | echo $filename 487 | fi 488 | done 489 | exit 490 | 491 | else 492 | usage 493 | exit 494 | fi 495 | --------------------------------------------------------------------------------