New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add instructions for Vagrant Share #466
Merged
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e6d9dc6
Add first pass of Vagrant Share instructions
BronsonQuick 039d346
Remove the mention of using ngrok inside the machine
BronsonQuick 77214b1
Change to a placeholder
BronsonQuick 87735ad
Alter the wording
BronsonQuick a4ce6c3
Add a debugging section
BronsonQuick File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -83,3 +83,37 @@ In normal circumstances editing Chassis' own ``wp-config.php`` file is discourag | |
This will prevent WP-CLI from loading ``wp-settings.php`` twice. | ||
|
||
With this configuration you should now be ready to develop against WordPress Core. | ||
|
||
Vagrant Share | ||
------------- | ||
|
||
Vagrant Share enables the ability to generate a temporary URL which you can share with people to allow them access to your local Chassis installation. | ||
|
||
1. **Install ngrok** | ||
|
||
Vagrant Share requires `ngrok` to be installed on the host machine. | ||
You can verify if this is installed by running `which ngrok` in a terminal. If there is no output then you will need to download and install `ngrok`_. | ||
Once you've downloaded `ngrok` unzip it: `unzip /path/to/ngrok-stable-darwin-amd64.zip` | ||
Move ngrok: `mv /path/to/ngrok /usr/local/bin/ngrok` | ||
|
||
2. **Run Vagrant Share** | ||
|
||
You now need to run `vagrant share --http=vagrant.local:80`. If you're using a custom domain then you will need to use that e.g. `vagrant share --http=<your-custom-domain>.local:80`. | ||
You will then have a temporary URL generated for you. e.g. `http://bea1a5c2.ngrok.io`. You need to leave this running in the background. | ||
|
||
3. **Alter your Chassis config** | ||
|
||
Alter one of your Chassis config files to include the additional URL without the `http://`. e.g. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should probably just be |
||
.. code-block:: yaml | ||
|
||
hosts: | ||
- vagrant.local | ||
- bea1a5c2.ngrok.io | ||
|
||
4. **Reprovision Vagrant** | ||
|
||
You now need to run `vagrant provision` and you should be able to access your Chassis box with the URL generated in Step 2. | ||
If you see an error when you run `vagrant provision` then try running it again. | ||
If you're still having trouble accessing the URL try a `vagrant reload` after you've run a successful `vagrant provision`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe move these lines to a debugging subsection below? |
||
|
||
.. _ngrok: https://ngrok.com/download |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could use a placeholder name here (e.g.
http://<id>.ngrok.io
) instead to make it clearer.