Add troubleshooting helper

Chassis / Chassis

📦 Chassis is a virtual server for your WordPress site, built using Vagrant.

http://chassis.io/

GNU Lesser General Public License v3.0

621 stars 84 forks source link

Add troubleshooting helper #612

Open rmccue opened 5 years ago

rmccue commented 5 years ago

We should add a tool for troubleshooting common issues.

I'll dump a couple of examples of things that might be nice for the debug command:

Sometimes avahi stops working on the box and the url doesn't resolve in the browser: sudo service avahi-daemon restart can fix this. We can check the status with service avahi-daemon status

Sometimes an install will fail and give a 255 error. This often tends to be caused by PHP throwing errors. We could try and toggle on error reporting and running the command again to see if that works. We could maybe grep the logs/php output for fatals. A few ways to replicate this could be having missing files in require_once or a dodgy setup of Memcache(d).

Originally posted by @BronsonQuick in https://github.com/Chassis/Chassis/issues/497#issuecomment-374829998

rmccue commented 5 years ago

Sometimes people have multiple VMs running. We can run a DNS query (dns-sd -G v4 vagrant.local) and check that a) only one result exists, and b) it matches the machine's IP

BronsonQuick commented 5 years ago

@rmccue I've just been having a bit of a think about this. I'm guessing we'd write this in Ruby as a Vagrant plugin so we'd be able to do something like vagrant chassis help and vagrant chassis -h perhaps?

Oh wait, you mentioned debug so vagrant chassis debug then?

I'm keen for your thoughts on how you'd like to approach this so I can have a bit of a crack at it sometime. Thank you Sir!

BronsonQuick commented 5 years ago

Sometimes the user needs to update apt for a provision to work correctly sudo apt-get update

BronsonQuick commented 5 years ago

Sometimes the developer might not get the spaces correct in their yaml files so that'll get an error like this:

ERROR: Could not load config: (/Volumes/Sites/chassis/content/config.local.yaml): did not find expected '-' indicator while parsing a block collection at line 16 column 3

BronsonQuick commented 5 years ago

Old config files might reference extensions that we've moved into the official Chassis organisation. e.g.

Please change roborourke/chassis-openssl to roborourke/chassis_openssl in your yaml configuration file.