![\"\"](\"https:\/\/kb.apiscp.com\/wp-content\/uploads\/2017\/02\/beacon.png\"){kind=tracking}
<\/p>\n<\/p>\n
Beacon is a scripting companion to apnscp<\/a>\u00a0that provides a simple interface to interacting with more than 2,000 commands<\/a>\u00a0exposed in apnscp. If apnscp can do it so can you, minus a pretty interface of course! Beacon may also be downloaded from our github repo<\/a>.<\/p>\n Beacon requires an API key for authentication. Visit Dev<\/strong> > API Keys<\/strong> within apnscp<\/a> to create your API key. On first use, specify If\u00a0everything went as expected, your domain will be printed out.<\/p>\n Once the key is set, you can skip –key=… unless you change the key again, in which case specify –key=… and –set<\/strong> to overwrite the key. If you’re running Beacon on your desktop to interact with apnscp, use –key=… in conjunction with –endpoint<\/strong>=https:\/\/launchpad.url.in.the.panel:2083\/soap. Your endpoint URI is provided in\u00a0Dev<\/strong> > API Keys<\/strong>.<\/p>\n Each Beacon command consists of the imperative, Which will return an array of three elements, 1, 5 and 15-minute load averages.<\/p>\n Parameters, if necessary, follow command invocation. Primitives are simply passed as-is observing shell special characters<\/a> and variable interpolation<\/a> rules. When working with booleans, use “0” instead of “false”. Omitted parameters must be explicitly specified with an empty string (“”).\u00a0Arrays may either be formatted with or without its numeric indices. Hash keys precede the value. Arrays and hashes are enclosed with “[]”, infinitely nested, and hash keys are postfixed with a colon.<\/p>\n By default, Beacon presents itself in human-readable format with print_r<\/a>. Use No trailing EOL marker is included in the actual output for ease of parsing.<\/p>\n Chaining is the real magic in Beacon. By mixing shell data types and Beacon, it’s easy to store output and work with it.<\/p>\n Iterate over all domains. Check each domain if WordPress is current, update if not.<\/p>\n Creates a new addon domain, then installs WordPress, Drupal, or any web app<\/a>. “${n,,}” takes the parameter\u00a0n\u00a0<\/em>and converts to lowercase in bash v4+ using case modifiers<\/a>.<\/p>\nGetting Started<\/h2>\n
--key<\/code> to set the key:<\/p>\nbeacon exec --key=AAAA-BBBB-CCCC-DDDD common_get_web_server_name<\/code><\/p>\nCommand Format<\/h2>\n
exec<\/code>, followed by the module name + method name, both in lowercase and delimited by an underscore. For example, to check system load average, which is exposed as “get_load<\/a>” in the “Common” module, it is formatted as common_get_load:<\/p>\nbeacon exec common_get_load<\/code><\/p>\nParameters<\/h2>\n
Primitive examples<\/h3>\n
beacon exec sql_create_mysql_database test
\nbeacon exec common_get_service_value siteinfo admin_user
\nbeacon exec file_chown \/var\/www\/myfile.txt myadmin 1
\n<\/code><\/p>\nArray\/hash examples<\/h3>\n
beacon exec file_set_acls \/var\/www\/ myotheruser rwx [recursive:1]
\nbeacon exec sql_create_mysql_database foobar
\nbeacon exec wordpress_update_themes mydomain.com \"\" [avada,twentyseventeen]<\/code><\/p>\nInterpreting Responses<\/h2>\n
--format=json<\/code> to output the result as JSON and as bash-friendly arrays, --format=bash:<\/code><\/p>\n$ beacon exec --format=json common_get_load<\/code>
\n{\"1\":\"0.52\",\"5\":\"0.82\",\"15\":\"0.94\"}
\n$ beacon exec --format=bash common_get_load<\/code>
\n(['1']='0.47' ['5']='0.81' ['15']='0.94')<\/code><\/p>\nChaining<\/h2>\n
Checking if all WordPress domains are current<\/h3>\n
# () also works in lieu of declare -a...<\/code> declare -a DOMAINS=$(beacon exec \u00a0--format=bash aliases_list_aliases)<\/code> for domain in ${DOMAINS[@]} ; do<\/code> \u00a0 \u00a0 STATUS=$(beacon eval wordpress_is_current $domain)<\/code> \u00a0 \u00a0 if [$STATUS == 0]; then continue ; fi<\/code> \u00a0 \u00a0 beacon wordpress_update $domain\u00a0<\/code> done<\/code><\/pre>\nCreate an addon domain, then install WordPress or Drupal onto it<\/h3>\n
function newdomain {\r\n domain=${1,,}\r\n app=${2,,}\r\n path=\/var\/www\/${domain}\r\n beacon exec aliases_add_shared_domain $domain $path\r\n beacon exec aliases_synchronize_changes\r\n beacon exec ${app}_install $domain \r\n}<\/pre>\nIntrospection<\/h2>\n