From f3201cfda170fd6f4500455612abf689548b10a7 Mon Sep 17 00:00:00 2001 From: Greg Hesp Date: Thu, 5 Mar 2020 17:28:13 +0000 Subject: [PATCH] Updated documentation and release.js --- docs/404.html | 2 +- docs/788d3f90.ad352afc.js | 1 - docs/docs/cast/search/index.html | 2 +- docs/docs/cast/stop/index.html | 2 +- docs/docs/commands/broadcast/index.html | 2 +- docs/docs/commands/custom-commands/index.html | 2 +- docs/docs/commands/presets/index.html | 2 +- docs/docs/contributing/index.html | 2 +- docs/docs/getting-started/configuration/index.html | 2 +- docs/docs/getting-started/installation/index.html | 6 +++--- docs/docs/integration/hass/index.html | 2 +- docs/docs/integration/webcore/index.html | 2 +- docs/docs/introduction/index.html | 2 +- docs/docs/other/changes/index.html | 2 +- docs/docs/other/contributors/index.html | 2 +- docs/docs/other/faq/index.html | 2 +- docs/index.html | 2 +- docs/runtime~main.fe01ae88.js | 1 - 18 files changed, 18 insertions(+), 20 deletions(-) delete mode 100644 docs/788d3f90.ad352afc.js delete mode 100644 docs/runtime~main.fe01ae88.js diff --git a/docs/404.html b/docs/404.html index 0b2e5eb0..3e00698d 100644 --- a/docs/404.html +++ b/docs/404.html @@ -24,7 +24,7 @@ - + diff --git a/docs/788d3f90.ad352afc.js b/docs/788d3f90.ad352afc.js deleted file mode 100644 index 608c0be5..00000000 --- a/docs/788d3f90.ad352afc.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{104:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return o})),n.d(t,"metadata",(function(){return l})),n.d(t,"rightToc",(function(){return s})),n.d(t,"default",(function(){return p}));var r=n(1),a=n(6),i=(n(0),n(115)),o={id:"installation",title:"Installation",description:"How to install Assistant Relay"},l={id:"getting-started/installation",title:"Installation",description:"How to install Assistant Relay",source:"@site/docs\\getting-started\\installation.md",permalink:"/assistant-relay/docs/getting-started/installation",sidebar:"docs",previous:{title:"Contributing",permalink:"/assistant-relay/docs/contributing"},next:{title:"Configuration",permalink:"/assistant-relay/docs/getting-started/configuration"}},s=[{value:"Requirements",id:"requirements",children:[]},{value:"Installation",id:"installation",children:[]}],c={rightToc:s};function p(e){var t=e.components,n=Object(a.a)(e,["components"]);return Object(i.b)("wrapper",Object(r.a)({},c,n,{components:t,mdxType:"MDXLayout"}),Object(i.b)("p",null,"At its core, Assistant Relay is powered by Node.js"),Object(i.b)("h2",{id:"requirements"},"Requirements"),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},Object(i.b)("a",Object(r.a)({parentName:"li"},{href:"https://nodejs.org/en/"}),"Node.js")," version >= 10.13.0 (this can be checked by running ",Object(i.b)("inlineCode",{parentName:"li"},"node -v"),"). If you require multiple Node versions, you can use ",Object(i.b)("a",Object(r.a)({parentName:"li"},{href:"https://github.com/nvm-sh/nvm"}),"NVM")," to manage multiple versions on a single machine"),Object(i.b)("li",{parentName:"ul"},Object(i.b)("a",Object(r.a)({parentName:"li"},{href:"https://www.python.org/downloads/"}),"Python")," version >= 3.7 (If you're running Assistant Relay version <= 3.2, this is not required)"),Object(i.b)("li",{parentName:"ul"},Object(i.b)("a",Object(r.a)({parentName:"li"},{href:"https://pm2.keymetrics.io/"}),"PM2")," will be installed as a pre-requisite. If you do not already have it installed, please install after Node.js by running ",Object(i.b)("inlineCode",{parentName:"li"},"npm i pm2 -g")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("a",Object(r.a)({parentName:"li"},{href:"https://github.com/greghesp/assistant-relay/releases"}),"Assistant Relay")," - Make sure you download the latest ",Object(i.b)("strong",{parentName:"li"},"release.zip"),". Do not download the Source Code!")),Object(i.b)("h2",{id:"installation"},"Installation"),Object(i.b)("p",null,"To install Assistant Relay, unzip the contents of ",Object(i.b)("inlineCode",{parentName:"p"},"release.zip")," to a folder of your choosing. For these documents, the folder name will be ",Object(i.b)("inlineCode",{parentName:"p"},"assistant-relay")),Object(i.b)("p",null,"In the ",Object(i.b)("inlineCode",{parentName:"p"},"assistant-relay")," folder, open a terminal/command window and run the below command to install the required dependencies"),Object(i.b)("pre",null,Object(i.b)("code",Object(r.a)({parentName:"pre"},{}),"npm i\n")))}p.isMDXComponent=!0},115:function(e,t,n){"use strict";n.d(t,"a",(function(){return u})),n.d(t,"b",(function(){return m}));var r=n(0),a=n.n(r);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=a.a.createContext({}),p=function(e){var t=a.a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l({},t,{},e)),n},u=function(e){var t=p(e.components);return a.a.createElement(c.Provider,{value:t},e.children)},b={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},d=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(n),d=r,m=u["".concat(o,".").concat(d)]||u[d]||b[d]||i;return n?a.a.createElement(m,l({ref:t},c,{components:n})):a.a.createElement(m,l({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var c=2;c - + diff --git a/docs/docs/cast/stop/index.html b/docs/docs/cast/stop/index.html index 93408702..2e34f42d 100644 --- a/docs/docs/cast/stop/index.html +++ b/docs/docs/cast/stop/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/docs/commands/broadcast/index.html b/docs/docs/commands/broadcast/index.html index 65fc33d6..870fa24a 100644 --- a/docs/docs/commands/broadcast/index.html +++ b/docs/docs/commands/broadcast/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/docs/commands/custom-commands/index.html b/docs/docs/commands/custom-commands/index.html index aac38358..1bd29368 100644 --- a/docs/docs/commands/custom-commands/index.html +++ b/docs/docs/commands/custom-commands/index.html @@ -25,7 +25,7 @@ - + diff --git a/docs/docs/commands/presets/index.html b/docs/docs/commands/presets/index.html index f14dec5f..3eb8b527 100644 --- a/docs/docs/commands/presets/index.html +++ b/docs/docs/commands/presets/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/docs/contributing/index.html b/docs/docs/contributing/index.html index 0f1e16a4..0f76078f 100644 --- a/docs/docs/contributing/index.html +++ b/docs/docs/contributing/index.html @@ -25,7 +25,7 @@ - + diff --git a/docs/docs/getting-started/configuration/index.html b/docs/docs/getting-started/configuration/index.html index a5e16ea2..09235e79 100644 --- a/docs/docs/getting-started/configuration/index.html +++ b/docs/docs/getting-started/configuration/index.html @@ -25,7 +25,7 @@ - + diff --git a/docs/docs/getting-started/installation/index.html b/docs/docs/getting-started/installation/index.html index 0057de0f..bbc5b0bb 100644 --- a/docs/docs/getting-started/installation/index.html +++ b/docs/docs/getting-started/installation/index.html @@ -19,12 +19,12 @@
-

Installation

At its core, Assistant Relay is powered by Node.js

Requirements

  • Node.js version >= 10.13.0 (this can be checked by running node -v). If you require multiple Node versions, you can use NVM to manage multiple versions on a single machine
  • Python version >= 3.7 (If you're running Assistant Relay version <= 3.2, this is not required)
  • PM2 will be installed as a pre-requisite. If you do not already have it installed, please install after Node.js by running npm i pm2 -g
  • Assistant Relay - Make sure you download the latest release.zip. Do not download the Source Code!

Installation

To install Assistant Relay, unzip the contents of release.zip to a folder of your choosing. For these documents, the folder name will be assistant-relay

In the assistant-relay folder, open a terminal/command window and run the below command to install the required dependencies

npm i
+

Installation

At its core, Assistant Relay is powered by Node.js

Requirements

  • Node.js version >= 10.13.0 (this can be checked by running node -v). If you require multiple Node versions, you can use NVM to manage multiple versions on a single machine
  • Python version >= 3.7 (If you're running Assistant Relay version <= 3.2, this is not required)
  • PM2 will be installed as a pre-requisite. If you do not already have it installed, please install after Node.js by running npm i pm2 -g
  • Assistant Relay - Make sure you download the latest release.zip. Do not download the Source Code!

Installation

To install Assistant Relay, unzip the contents of release.zip to a folder of your choosing. For these documents, the folder name will be assistant-relay

In the assistant-relay folder, open a terminal/command window and run the below command to install the required dependencies

npm run setup

Once setup is complete, you can run the below command to start Assistant Relay using PM2.

npm run start

Note: If you don't want to run this with PM2, you can use npm run dev which will run Assistant Relay in its own instance. It won't restart though if it crashes, or if it forces a restart when you do something such as changing the port

- + @@ -36,7 +36,7 @@ - + diff --git a/docs/docs/integration/hass/index.html b/docs/docs/integration/hass/index.html index 9be4f5aa..6a91bdea 100644 --- a/docs/docs/integration/hass/index.html +++ b/docs/docs/integration/hass/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/docs/integration/webcore/index.html b/docs/docs/integration/webcore/index.html index 2ed49bed..ea826715 100644 --- a/docs/docs/integration/webcore/index.html +++ b/docs/docs/integration/webcore/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/docs/introduction/index.html b/docs/docs/introduction/index.html index a6b05d91..a97fb5be 100644 --- a/docs/docs/introduction/index.html +++ b/docs/docs/introduction/index.html @@ -25,7 +25,7 @@ - + diff --git a/docs/docs/other/changes/index.html b/docs/docs/other/changes/index.html index 5a2d543d..1e7e34cf 100644 --- a/docs/docs/other/changes/index.html +++ b/docs/docs/other/changes/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/docs/other/contributors/index.html b/docs/docs/other/contributors/index.html index 8dc3b2fe..04dce2ea 100644 --- a/docs/docs/other/contributors/index.html +++ b/docs/docs/other/contributors/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/docs/other/faq/index.html b/docs/docs/other/faq/index.html index 3b1a1bbe..ca073b16 100644 --- a/docs/docs/other/faq/index.html +++ b/docs/docs/other/faq/index.html @@ -25,7 +25,7 @@ - + diff --git a/docs/index.html b/docs/index.html index db98f5e4..e1569e28 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@ - + diff --git a/docs/runtime~main.fe01ae88.js b/docs/runtime~main.fe01ae88.js deleted file mode 100644 index 7c73184b..00000000 --- a/docs/runtime~main.fe01ae88.js +++ /dev/null @@ -1 +0,0 @@ -!function(e){function r(r){for(var n,f,c=r[0],u=r[1],i=r[2],d=0,b=[];d