You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 25, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+38-38Lines changed: 38 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -1,41 +1,41 @@
1
-
#WPLib Box
1
+
#WPLib Box
2
2
3
3
**The EASIEST way to get a local WordPress development environment**, using Vagrant.
4
4
5
5
----
6
6
7
-
## [CLICK HERE](https://slackpass.io/wplib) for **quick help** via [`wplib.slack.com#box`](FAQ.md#slack).
8
-
## [CLICK HERE](FAQ.md#troubleshooting) for **troubleshooting** and other [FAQs](FAQ.md).
7
+
## [CLICK HERE](https://slackpass.io/wplib) for **quick help** via [`wplib.slack.com#box`](FAQ.md#slack).
8
+
## [CLICK HERE](FAQ.md#troubleshooting) for **troubleshooting** and other [FAQs](FAQ.md).
9
9
10
10
----
11
11
12
-
-[Why Use WPLib Box?](#why-wplib-box)
13
-
-[Services & Software Included](#whats-included)
14
-
-[Required Hardware](#required-hw)
15
-
-[Required Software](#required-sw)
16
-
-[Quickstart](#quickstart)
17
-
-[Setting the Domain Name](#setting-domain)
18
-
-[Changing the Local IP Address](#change-ip)
19
-
-[Default PHP Version for the Web](#web-php)
20
-
-[Switching PHP Versions](#switching-php)
21
-
-[Logging into the WordPress Admin](#wp-admin)
22
-
-[The WordPress Database Credentials](#wpdb)
23
-
-[The MySQL Credentials](#mysql-credentials)
24
-
-[Connecting to MySQL in Terminal](#mysql-terminal)
25
-
-[The SSH Credentials](#ssh-credentials)
26
-
-[Logging into SSH as root](#ssh-root)
27
-
-[Debugging PHP with XDEBUG and PhpStorm](#xdebug)
28
-
-[Internet Sharing](#internet-sharing)
29
-
-[Troubleshooting](#troubleshooting)
30
-
-[How are we the Best?](#how-best)
12
+
-[Why Use WPLib Box?](#why-wplib-box)
13
+
-[Services & Software Included](#whats-included)
14
+
-[Required Hardware](#required-hw)
15
+
-[Required Software](#required-sw)
16
+
-[Quickstart](#quickstart)
17
+
-[Setting the Domain Name](#setting-domain)
18
+
-[Changing the Local IP Address](#change-ip)
19
+
-[Default PHP Version for the Web](#web-php)
20
+
-[Switching PHP Versions](#switching-php)
21
+
-[Logging into the WordPress Admin](#wp-admin)
22
+
-[The WordPress Database Credentials](#wpdb)
23
+
-[The MySQL Credentials](#mysql-credentials)
24
+
-[Connecting to MySQL in Terminal](#mysql-terminal)
25
+
-[The SSH Credentials](#ssh-credentials)
26
+
-[Logging into SSH as root](#ssh-root)
27
+
-[Debugging PHP with XDEBUG and PhpStorm](#xdebug)
28
+
-[Internet Sharing](#internet-sharing)
29
+
-[Troubleshooting](#troubleshooting)
30
+
-[How are we the Best?](#how-best)
31
31
-[3rd Party WPLib Box Projects](#3rd-party)
32
-
-[Status of Issues](#issues-status)
33
-
-[Future Plans](#future-plans)
32
+
-[Status of Issues](#issues-status)
33
+
-[Future Plans](#future-plans)
34
34
35
35
---
36
36
37
37
<aid="why-wplib-box"></a>
38
-
##Why Use WPLib Box?
38
+
##Why Use WPLib Box?
39
39
40
40
Why Use WPLib Box for WordPress local development instead of one of the other Vagrant boxes for WordPress such as [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV), [VIP QuickStart](https://github.com/Automattic/vip-quickstart), [Trellis](https://github.com/roots/trellis) or [one of the others](http://wptavern.com/13-vagrant-resources-for-wordpress-development)?
41
41
@@ -47,7 +47,7 @@ Our **GOAL** is to be:
47
47
48
48
And one more goal we achieved is that our box supports **PhpStorm+XDEBUG debugging** with the least effort required on your part.
49
49
50
-
We think that once you try WPLib Box you will agree that we have succeeded. Want to know [**how**](#how) we did it?
50
+
We think that once you try WPLib Box you will agree that we have succeeded. Want to know [**how**](#how) we did it?
51
51
52
52
<aid="whats-included"></a>
53
53
## Services & Software Included
@@ -86,7 +86,7 @@ Since WPLib Box is distributed as a virtual machine image of a 64-bit distributi
86
86
87
87
<aid="for-mac"></a>
88
88
<aid="for-linux"></a>
89
-
###For Mac & Linux Users
89
+
###For Mac & Linux Users
90
90
91
91
To run WPLib Box requires the following software be installed:
92
92
@@ -96,17 +96,17 @@ To run WPLib Box requires the following software be installed:
96
96
- Install the [Vagrant Triggers](https://github.com/emyl/vagrant-triggers) plugin by running `vagrant plugin install vagrant-triggers`
97
97
98
98
<aid="for-windows"></a>
99
-
###For Windows Users
99
+
###For Windows Users
100
100
101
101
- Install everything from the Mac & Linux Users list above
102
102
- Ensure that no other VM platform is running (either VMware or Hyper-V) as they will prevent VirtualBox from operating.
103
103
- Install [Git](https://git-scm.com/downloads) version 2 or greater **OR** download the `.ZIP` file and unzip instead.
104
104
105
105
<aid="quickstart"></a>
106
-
##Quickstart
106
+
##Quickstart
107
107
After making sure you have the necessary software, run the following commands
108
108
109
-
###For Mac or Linux users:
109
+
###For Mac or Linux users:
110
110
111
111
# cd ~/Sites, or cd into whichever directory you store your website projects in
112
112
cd ~/Sites
@@ -115,7 +115,7 @@ After making sure you have the necessary software, run the following commands
115
115
vagrant up
116
116
open "http://wplib.box"
117
117
118
-
###For Windows users:
118
+
###For Windows users:
119
119
120
120
# cd into whichever directory you store your website projects in.
121
121
# For example, your user profile: C:\Users\{current user}\Sites
@@ -132,7 +132,7 @@ After making sure you have the necessary software, run the following commands
132
132
After this you should have a running WPLib Box via Vagrant and VirtualBox and a website loaded at the local `wplib.box` domain.
133
133
134
134
<aid="setting-domain"></a>
135
-
##Setting the Domain Name
135
+
##Setting the Domain Name
136
136
137
137
To use WPLib Box for a local domain name other than `wplib.box` edit the `HOSTNAME` file _(with no extension)_
138
138
and replace the text `"wplib.box"` with your preferred local domain name _(we recommend `"your-production-2nd-level-domain.dev"` e.g. if `google.com` then use `google.dev`):_
@@ -160,7 +160,7 @@ If you need to change that for any reason simply **edit the file named just `IP`
160
160
161
161
<aid="web-php"></a>
162
162
## Default PHP Version for the Web
163
-
The default version fot the web is `7.0.x`. Instructions to [switch to PHP 5.6](FAQ.md#switch-php) are on our FAQ.
163
+
The default version fot the web is `7.0.x`. Instructions to [switch to PHP 5.6](FAQ.md#switch-php) are on our FAQ.
164
164
165
165
<aid="switching-php"></a>
166
166
## Switching PHP Versions
@@ -233,7 +233,7 @@ There is no `root` user _per-se_ in WPLib Box, only the `vagrant` user. You have
233
233
<aid="xdebug"></a>
234
234
## Debugging PHP with XDEBUG and PhpStorm
235
235
236
-
See instructions [**here**](https://github.com/wplib/connect.tech-atlanta-2016/blob/master/debugging-with-phpstorm-xdebug.md#debugging-with-phpstorm-and-xdebug).
236
+
See instructions [**here**](https://github.com/wplib/connect.tech-atlanta-2016/blob/master/debugging-with-phpstorm-xdebug.md#debugging-with-phpstorm-and-xdebug).
237
237
238
238
<aid="internet-sharing"></a>
239
239
## Internet Sharing
@@ -243,11 +243,11 @@ Internet sharing is implemented with [localtunnel.me](https://localtunnel.me), w
243
243
<aid="troubleshooting"></a>
244
244
## Troubleshooting
245
245
246
-
If you are having trouble with WPLib Box please check out our Troubleshooting section of our [**FAQ**](FAQ.md#troubleshooting) and/or you can also [reach out to our support team](FAQ.md#support) for **quick help** on Slack and via other channels.
246
+
If you are having trouble with WPLib Box please check out our Troubleshooting section of our [**FAQ**](FAQ.md#troubleshooting) and/or you can also [reach out to our support team](FAQ.md#support) for **quick help** on Slack and via other channels.
247
247
248
248
249
249
<aid="how-best"></a>
250
-
##How are we the Best?
250
+
##How are we the Best?
251
251
252
252
How have we been able to make **WPLib Box** the:
253
253
@@ -279,13 +279,13 @@ Give it a try and see if you don't agree.
279
279
-[**WPLib Box Maker**](https://github.com/ArtOfWP/generator-wplibbox) from [ArtOfWP](https://github.com/ArtOfWP): _Generates a custom WPLib Box setup using [Yeoman](http://yeoman.io/)._
280
280
281
281
<aid="issues-status"></a>
282
-
##Status of Issues
282
+
##Status of Issues
283
283
We are using Waffle.io to help us manage our GitHub issue queue:
284
284
285
285
[](https://waffle.io/wplib/wplib-box)
286
286
[](http://waffle.io/wplib/wplib-box)
287
287
288
288
<aid="future-plans"></a>
289
-
##Future Plans
289
+
##Future Plans
290
290
291
291
We have many plans for the WPLib platform. This is just a start. Watch this repo to keep up to date.
0 commit comments