Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/varying-vagrant-vagrants/custom-site-template-develop
A VVV site template for working on WordPress Core development. For client development use the custom-site-template instead
https://github.com/varying-vagrant-vagrants/custom-site-template-develop
vagrant varying-vagrant-vagrants vvv wordpress
Last synced: about 1 month ago
JSON representation
A VVV site template for working on WordPress Core development. For client development use the custom-site-template instead
- Host: GitHub
- URL: https://github.com/varying-vagrant-vagrants/custom-site-template-develop
- Owner: Varying-Vagrant-Vagrants
- Created: 2017-07-01T22:34:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-28T15:21:24.000Z (about 1 year ago)
- Last Synced: 2024-03-26T22:13:39.770Z (9 months ago)
- Topics: vagrant, varying-vagrant-vagrants, vvv, wordpress
- Language: Shell
- Homepage:
- Size: 130 KB
- Stars: 7
- Watchers: 10
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VVV Custom site template (WP Core development)
This site template is a great way to test the bleeding edge versions of WordPress, or contribute to development of WordPress core. Ideal for contributor days, Trac tickets, etc
For general WP work such as theme building or plugin development, use the normal custom site template instead. Only use this if you want the bleeding edge trunk version of WordPress.
## Overview
This template will allow you to create a WordPress core dev environment running wordpress trunk using only `config/config.yml`.
The supported environments are:
- A single site
- A subdomain multisite
- A subdirectory multisite
## Pulling In Updates
This template will attempt to update on provision, but if that fails, you can enter the `public_html` folder and manually update. This can be done using `svn up` if SVN is used, and `git pull` if git is used. GUI tools such as TortoiseSVN, Visual Studio Code, and other GUIs, can be used to update the folder too.
## Switching from SVN to Git
```shell
vagrant ssh
cd /srv/www/[wordpress-trunk] # the folder name
./bin/develop_git
```
Running this command will convert an svn based checkout to git and will require some time to run.
## Configuration
### Options
| Key | Default | Description |
|-------------|----------------------------|---------------------------------------------------------------------------------------------------|
| `db_name` | The sites name | The name of the MySQL database to create and install to |
| `site_title` | The first host of the site | The title of the site after install |
| `vcs` | `svn` | The type of WP checkout to make when first creating the site, valid values are `svn` and `git` |
| `wp_type` | `single` | Defines what kind of site gets installed, `subdomain` `subdirectory` or `single` are valid values |
| `npm` | `true` | Execute NPM during the provision |
### The Minimum Required Configuration
```yaml
my-site:
repo: https://github.com/Varying-Vagrant-Vagrants/custom-site-template-develop
hosts:
- my-site.test
```
This settings will use as default SVN to download WordPress-develop but it is possible to switch to git:
Site in config.yml
Setting
Value
my-site:
repo: https://github.com/Varying-Vagrant-Vagrants/custom-site-template-develop
hosts:
- my-site.test
custom:
vcs: git # using 'svn' will force this vcs
Domain
my-site.test
Site Title
my-site.test
DB Name
my-site
Site Type
Single
### WordPress Multisite with Subdomains
```yaml
my-site:
repo: https://github.com/Varying-Vagrant-Vagrants/custom-site-template-develop
hosts:
- multisite.test
- site1.multisite.test
- site2.multisite.test
custom:
wp_type: subdomain
```
| Setting | Value |
|------------|---------------------|
| Domain | multisite.test |
| Site Title | multisite.test |
| DB Name | my-site |
| Site Type | Subdomain Multisite |
## Configuration Options
```yaml
hosts:
- foo.test
- bar.test
- baz.test
```
Defines the domains and hosts for VVV to listen on. The first domain in this list is your sites primary domain.
```yaml
custom:
site_title: My Awesome Dev Site
```
Defines the site title to be set upon installing WordPress.
```yaml
custom:
wp_type: single
```
Defines the type of install you are creating. Valid values are:
- single
- subdomain
- subdirectory
```yaml
custom:
db_name: super_secet_db_name
```
Defines the DB name for the installation.