mirror of
https://gh.wpcy.net/https://github.com/Chassis/puppet-wp.git
synced 2026-05-05 00:44:41 +08:00
68 lines
18 KiB
HTML
68 lines
18 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Core | Puppet WP</title>
|
||
<meta name="description" content="This module enables the easy use of WP CLI to control your WordPress site through Puppet manifests. It provides an easy abstraction for common WP CLI commands as well as installing the WP CLI binaries as needed.">
|
||
|
||
|
||
<link rel="preload" href="/puppet-wp/assets/css/0.styles.3555fada.css" as="style"><link rel="preload" href="/puppet-wp/assets/js/app.fa6aeef6.js" as="script"><link rel="preload" href="/puppet-wp/assets/js/2.9c067755.js" as="script"><link rel="preload" href="/puppet-wp/assets/js/12.01d6689e.js" as="script"><link rel="prefetch" href="/puppet-wp/assets/js/10.3ae47639.js"><link rel="prefetch" href="/puppet-wp/assets/js/11.8480f621.js"><link rel="prefetch" href="/puppet-wp/assets/js/13.e9402967.js"><link rel="prefetch" href="/puppet-wp/assets/js/14.1e5c138a.js"><link rel="prefetch" href="/puppet-wp/assets/js/15.2d20c5af.js"><link rel="prefetch" href="/puppet-wp/assets/js/16.606b6d78.js"><link rel="prefetch" href="/puppet-wp/assets/js/17.125632f9.js"><link rel="prefetch" href="/puppet-wp/assets/js/18.33b23e9b.js"><link rel="prefetch" href="/puppet-wp/assets/js/19.b33e4957.js"><link rel="prefetch" href="/puppet-wp/assets/js/20.d44dba7e.js"><link rel="prefetch" href="/puppet-wp/assets/js/21.da1bc37d.js"><link rel="prefetch" href="/puppet-wp/assets/js/22.7925425c.js"><link rel="prefetch" href="/puppet-wp/assets/js/23.ed2e32a3.js"><link rel="prefetch" href="/puppet-wp/assets/js/24.b1665b07.js"><link rel="prefetch" href="/puppet-wp/assets/js/3.95ca6637.js"><link rel="prefetch" href="/puppet-wp/assets/js/4.acbad4b1.js"><link rel="prefetch" href="/puppet-wp/assets/js/5.afc655ad.js"><link rel="prefetch" href="/puppet-wp/assets/js/6.3c605811.js"><link rel="prefetch" href="/puppet-wp/assets/js/7.589df22e.js"><link rel="prefetch" href="/puppet-wp/assets/js/8.23fbfed4.js"><link rel="prefetch" href="/puppet-wp/assets/js/9.02ff3dc3.js">
|
||
<link rel="stylesheet" href="/puppet-wp/assets/css/0.styles.3555fada.css">
|
||
</head>
|
||
<body>
|
||
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/puppet-wp/" class="home-link router-link-active"><!----> <span class="site-name">Puppet WP</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/puppet-wp/" class="nav-link">Home</a></div><div class="nav-item"><a href="/puppet-wp/installation/" class="nav-link">Installation</a></div><div class="nav-item"><a href="/puppet-wp/classes/" class="nav-link router-link-active">Classes</a></div> <a href="https://github.com/chassis/puppet-wp" target="_blank" rel="noopener noreferrer" class="repo-link">
|
||
GitHub
|
||
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/puppet-wp/" class="nav-link">Home</a></div><div class="nav-item"><a href="/puppet-wp/installation/" class="nav-link">Installation</a></div><div class="nav-item"><a href="/puppet-wp/classes/" class="nav-link router-link-active">Classes</a></div> <a href="https://github.com/chassis/puppet-wp" target="_blank" rel="noopener noreferrer" class="repo-link">
|
||
GitHub
|
||
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Installation</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/puppet-wp/installation/" class="sidebar-link">Installation</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Classes</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/puppet-wp/classes/cap.html" class="sidebar-link">Cap</a></li><li><a href="/puppet-wp/classes/cli.html" class="sidebar-link">CLI</a></li><li><a href="/puppet-wp/classes/command.html" class="sidebar-link">Command</a></li><li><a href="/puppet-wp/classes/comment.html" class="sidebar-link">Comment</a></li><li><a href="/puppet-wp/classes/config.html" class="sidebar-link">Config</a></li><li><a href="/puppet-wp/classes/core.html" class="active sidebar-link">Core</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/puppet-wp/classes/core.html#description" class="sidebar-link">Description</a></li><li class="sidebar-sub-header"><a href="/puppet-wp/classes/core.html#attributes" class="sidebar-link">Attributes</a></li></ul></li><li><a href="/puppet-wp/classes/option.html" class="sidebar-link">Option</a></li><li><a href="/puppet-wp/classes/params.html" class="sidebar-link">Params</a></li><li><a href="/puppet-wp/classes/plugin.html" class="sidebar-link">Plugin</a></li><li><a href="/puppet-wp/classes/rewrite.html" class="sidebar-link">Rewrite</a></li><li><a href="/puppet-wp/classes/role.html" class="sidebar-link">Role</a></li><li><a href="/puppet-wp/classes/theme.html" class="sidebar-link">Theme</a></li><li><a href="/puppet-wp/classes/user.html" class="sidebar-link">User</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Docs</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/puppet-wp/docs/" class="sidebar-link">Documentation</a></li><li><a href="/puppet-wp/docs/puppet-forge.html" class="sidebar-link">Puppet Forge</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Licence</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/puppet-wp/licence/" class="sidebar-link">Licence</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="core"><a href="#core" aria-hidden="true" class="header-anchor">#</a> Core</h1> <ul><li><a href="/puppet-wp/classes/site.html#description">Description</a></li> <li><a href="/puppet-wp/classes/site.html#attributes">Attributes</a></li></ul> <h2 id="description"><a href="#description" aria-hidden="true" class="header-anchor">#</a> Description</h2> <p>Downloads, installs, and manages a WordPress installation.</p> <h2 id="attributes"><a href="#attributes" aria-hidden="true" class="header-anchor">#</a> Attributes</h2> <div class="language-puppet extra-class"><pre class="language-puppet"><code> wp<span class="token punctuation">::</span>core <span class="token punctuation">{</span> <span class="token string">'resource title'</span><span class="token punctuation">:</span>
|
||
<span class="token attr-name">url</span> <span class="token operator">=></span> <span class="token comment"># The URL of the WordPress site.</span>
|
||
<span class="token attr-name">location</span> <span class="token operator">=></span> <span class="token comment"># The location to run the command.</span>
|
||
<span class="token attr-name">siteurl</span> <span class="token operator">=></span> <span class="token comment"># The URL of the WordPress site.</span>
|
||
<span class="token attr-name">sitename</span> <span class="token operator">=></span> <span class="token comment"># The name of the site.</span>
|
||
<span class="token attr-name">admin_user</span> <span class="token operator">=></span> <span class="token comment"># The site administrators username.</span>
|
||
<span class="token attr-name">admin_email</span> <span class="token operator">=></span> <span class="token comment"># The site administrators email address.</span>
|
||
<span class="token attr-name">admin_password</span> <span class="token operator">=></span> <span class="token comment"># The site administrators password.</span>
|
||
<span class="token attr-name">network</span> <span class="token operator">=></span> <span class="token comment"># If the site is a multisite.</span>
|
||
<span class="token attr-name">subdomains</span> <span class="token operator">=></span> <span class="token comment"># Whether the multisite installation is in subfolders or subdomains.</span>
|
||
<span class="token attr-name">user</span> <span class="token operator">=></span> <span class="token comment"># The user to run the installation as.</span>
|
||
<span class="token punctuation">}</span>
|
||
</code></pre></div><h3 id="url"><a href="#url" aria-hidden="true" class="header-anchor">#</a> url</h3> <p>The URL of the site. e.g. <code>http://vagrant.local/</code>.</p> <h3 id="location"><a href="#location" aria-hidden="true" class="header-anchor">#</a> location</h3> <p>The location to run the command. e.g. <code>/vagrant</code>.</p> <h3 id="siteurl"><a href="#siteurl" aria-hidden="true" class="header-anchor">#</a> siteurl</h3> <p>The URL of the site including the protocol. e.g. <code>http://vagrant.local/</code>.</p> <h3 id="sitename"><a href="#sitename" aria-hidden="true" class="header-anchor">#</a> sitename</h3> <p>(<em>If omitted, this attribute’s value defaults to <code>WordPress Site</code>.</em>)</p> <p>The name of your site. e.g. <code>My Amazing Site</code></p> <h3 id="admin-user"><a href="#admin-user" aria-hidden="true" class="header-anchor">#</a> admin_user</h3> <p>(<em>If omitted, this attribute’s value defaults to <code>admin</code>.</em>)</p> <p>The site administrator user name. e.g. <code>bronson</code></p> <h3 id="admin-email"><a href="#admin-email" aria-hidden="true" class="header-anchor">#</a> admin_email</h3> <p>(<em>If omitted, this attribute’s value defaults to <code>admin@example.com</code>.</em>)</p> <p>The site administrators email address.</p> <h3 id="admin-password"><a href="#admin-password" aria-hidden="true" class="header-anchor">#</a> admin_password</h3> <p>(<em>If omitted, this attribute’s value defaults to <code>password</code>.</em>)</p> <p>The site administrators password: e.g. <code>aLbRY!Q9Qfh7YZ.h9jd!</code></p> <h3 id="network"><a href="#network" aria-hidden="true" class="header-anchor">#</a> network</h3> <p>(<em>If omitted, this attribute’s value defaults to <code>false</code>.</em>)</p> <p>Whether or note the site is a multisite.</p> <p>Values: <code>true</code>, <code>false</code>.</p> <h3 id="subdomains"><a href="#subdomains" aria-hidden="true" class="header-anchor">#</a> subdomains</h3> <p>(<em>If omitted, this attribute’s value defaults to <code>false</code>.</em>)</p> <p>Whether or not the multiste is setup as a subdomain. If this is set to <code>false</code> then WordPress multisite will be setup for subfolders.</p> <p>Values: <code>true</code>, <code>false</code>.</p> <h3 id="user"><a href="#user" aria-hidden="true" class="header-anchor">#</a> user</h3> <p>(<em>If omitted, this attribute’s value defaults to <code>www-data</code>.</em>)</p> <p>The user to use to run the command.</p> <h4 id="examples"><a href="#examples" aria-hidden="true" class="header-anchor">#</a> Examples</h4> <p>Setup a normal WordPress installation.</p> <div class="language-puppet extra-class"><pre class="language-puppet"><code> wp<span class="token punctuation">::</span>core <span class="token punctuation">{</span> <span class="token string">'Setup a WordPress Site'</span><span class="token punctuation">:</span>
|
||
<span class="token attr-name">url</span> <span class="token operator">=></span> <span class="token string"><span class="token double-quoted">"http://vagrant.local/"</span></span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">location</span> <span class="token operator">=></span> <span class="token string">'/vagrant'</span>
|
||
<span class="token attr-name">sitename</span> <span class="token operator">=></span> <span class="token string">'My Amazing Site'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_user</span> <span class="token operator">=></span> <span class="token string">'bronson'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_email</span> <span class="token operator">=></span> <span class="token string">'bronson@here.com'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_password</span> <span class="token operator">=></span> <span class="token string">'aLbRY!Q9Qfh7YZ.h9jd!'</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">}</span>
|
||
</code></pre></div><p>Setup a WordPress multisite installation in subfolders.</p> <div class="language-puppet extra-class"><pre class="language-puppet"><code> wp<span class="token punctuation">::</span>core <span class="token punctuation">{</span> <span class="token string">'Setup a WordPress Site'</span><span class="token punctuation">:</span>
|
||
<span class="token attr-name">url</span> <span class="token operator">=></span> <span class="token string"><span class="token double-quoted">"http://vagrant.local/"</span></span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">location</span> <span class="token operator">=></span> <span class="token string">'/vagrant'</span>
|
||
<span class="token attr-name">sitename</span> <span class="token operator">=></span> <span class="token string">'My Amazing Site'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_user</span> <span class="token operator">=></span> <span class="token string">'bronson'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_email</span> <span class="token operator">=></span> <span class="token string">'bronson@here.com'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_password</span> <span class="token operator">=></span> <span class="token string">'aLbRY!Q9Qfh7YZ.h9jd!'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">network</span> <span class="token operator">=></span> <span class="token boolean">true</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">}</span>
|
||
</code></pre></div><p>Setup a WordPress multisite installation with subdomains.</p> <div class="language-puppet extra-class"><pre class="language-puppet"><code> wp<span class="token punctuation">::</span>core <span class="token punctuation">{</span> <span class="token string">'Setup a WordPress Site'</span><span class="token punctuation">:</span>
|
||
<span class="token attr-name">url</span> <span class="token operator">=></span> <span class="token string"><span class="token double-quoted">"http://vagrant.local/"</span></span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">location</span> <span class="token operator">=></span> <span class="token string">'/vagrant'</span>
|
||
<span class="token attr-name">sitename</span> <span class="token operator">=></span> <span class="token string">'My Amazing Site'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_user</span> <span class="token operator">=></span> <span class="token string">'bronson'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_email</span> <span class="token operator">=></span> <span class="token string">'bronson@here.com'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">admin_password</span> <span class="token operator">=></span> <span class="token string">'aLbRY!Q9Qfh7YZ.h9jd!'</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">network</span> <span class="token operator">=></span> <span class="token boolean">true</span><span class="token punctuation">,</span>
|
||
<span class="token attr-name">subdomains</span> <span class="token operator">=></span> <span class="token boolean">true</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">}</span>
|
||
</code></pre></div></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/chassis/puppet-wp/edit/master/classes/core.md" target="_blank" rel="noopener noreferrer">Suggest an edit!</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <div class="last-updated"><span class="prefix">Last Updated: </span> <span class="time">9/4/2019, 5:36:24 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
|
||
←
|
||
<a href="/puppet-wp/classes/config.html" class="prev">
|
||
Config
|
||
</a></span> <span class="next"><a href="/puppet-wp/classes/option.html">
|
||
Option
|
||
</a>
|
||
→
|
||
</span></p></div> </main></div><div class="global-ui"></div></div>
|
||
<script src="/puppet-wp/assets/js/app.fa6aeef6.js" defer></script><script src="/puppet-wp/assets/js/2.9c067755.js" defer></script><script src="/puppet-wp/assets/js/12.01d6689e.js" defer></script>
|
||
</body>
|
||
</html>
|
