Allow selecting which sites to make active

[tnorthcutt]

I keep a number of sites (~20 right now) on one VVV install. Most of those, however, are only around for the rare instance when I need to work on them, and 90%+ of the time, I don't need them available. To speed up destroy, halt, up, provision, etc. it would be great to have a way to indicate which sites should be loaded at any given time. Perhaps a simple text file that provision.sh can look for, and if found, would then use to load only the sites explicitly defined?

I'm not sure if that's the best approach (and if it is, how exactly to implement that), but if given some direction, I'd be happy to submit a PR to implement this functionality.

[westonruter]

Great idea.

Probably the best way to go about implementing this is to introduce a .gitignore'ed file which contains the paths to exclude when provision.sh does these find calls:

• for SITE_CONFIG_FILE in $(find /srv/www -maxdepth 5 -name 'vvv-init.sh'); do
• for SITE_CONFIG_FILE in $(find /srv/www -maxdepth 5 -name 'vvv-nginx.conf'); do
• find /srv/www/ -maxdepth 5 -name 'vvv-hosts'

For that matter, the file could have the list of files paths to search instead of the ones to exclude. In other words, if the includes file does not exist, use /srv/www. If it does exist, use the paths inside the file in the find command.

[tnorthcutt]

@westonruter thanks, that helps a lot. I'd lean toward having a list of paths to explicitly include, as opposed to exclude. Got any naming suggestions for the file?

included-sites
sites-include
include-only

[DrewAPicture]

+1. This is a great idea.

[westonruter]

As a big bonus for explicitly whitelisting paths to include, the performance of the provisioning will be drastically improved. If you have a lot of sites in your VVV like I do, and a lot of directories, it can take a long time for these find commands to search through the /srv/www directory tree (and it has to do it 3 times). So as part of this, we could switch to -maxdepth 1.

[tnorthcutt]

Roger, so if the included-sites (do we like that name?) file is found, then also change the maxdepth flag to -1?

[westonruter]

Yes, bingo. 👍

[ereckers]

This is something I've been struggling with. I also run a ton of sites out of /www that I wouldn't mind skipping at times, even though I like keeping them around to reference code while developing. In my use case, I always wondered if I could just drop a file in the project directory called something like vvv-skip, next to vvv-init.sh and vvv-nginx.conf.

[westonruter]

I think the filename should be something like auto-setup-include-paths.

[jeremyfelt]

Dig this idea. Agree with explicitly whitelisting paths to include.

I would love if this transitioned to a YAML config file over time, though I think we're okay with an individual file right now.

[tnorthcutt]

@jeremyfelt YAML is far enough out of my reach that I'm not the one for that 😄.

I'll move forward with a simple text file, with each directory to include on a separate line.

[joeguilmette]

+1, this is great

[TobiasBg]

How about copying the webserver approach for naming, i.e. something like sites-available and sites-enabled?

[alainux]

+1

[westonruter]

@TobiasBg the problem with that is the sites being enabled will be arbitrary paths, not just directory names. You can't (or shouldn't) have a file named www/acmeclient/example.com/config.