diff options
Diffstat (limited to 'docs/_book/Usage')
| -rw-r--r-- | docs/_book/Usage/CLI.html | 72 | ||||
| -rw-r--r-- | docs/_book/Usage/Configuration.html | 2 | ||||
| -rw-r--r-- | docs/_book/Usage/Install.html | 2 |
3 files changed, 65 insertions, 11 deletions
diff --git a/docs/_book/Usage/CLI.html b/docs/_book/Usage/CLI.html index 5ff3602..b3809aa 100644 --- a/docs/_book/Usage/CLI.html +++ b/docs/_book/Usage/CLI.html @@ -353,16 +353,70 @@ <p><div class="alert alert-danger hints-alert"><div class="hints-icon"><i class="fa fa-exclamation-circle"></i></div><div class="hints-container"><p>This CLI assumes root access, so please run it with <code>sudo</code></p> </div></div></p> <h2 id="options">Options</h2> -<h4 id="sudo-lux-neo-uninstall"><code>sudo lux-neo uninstall</code></h4> +<h3 id="sudo-lux-neo-uninstall"><code>sudo lux-neo uninstall</code></h3> <p>Uninstall the whole thing. You will have to remove this script yourself.</p> -<h4 id="sudo-lux-neo-update"><code>sudo lux-neo update</code></h4> -<p>Update to the newest version on the current branch.</p> -<h4 id="sudo-lux-neo-conf"><code>sudo lux-neo conf</code></h4> +<h3 id="sudo-lux-neo-update-skipnode"><code>sudo lux-neo update (skipNode)</code></h3> +<p>Update to the newest version on the current branch. +If <code>skipNode</code> is the second argument, <code>npm</code> won't be run.</p> +<h3 id="sudo-lux-neo-conf"><code>sudo lux-neo conf</code></h3> <p>Open the strip-config in <code>nano</code>.</p> -<h4 id="sudo-lux-neo-start"><code>sudo lux-neo start</code></h4> -<p>Start the server.</p> -<h4 id="sudo-lux-neo-stop"><code>sudo lux-neo stop</code></h4> -<p>Stop the server.</p> +<h3 id="sudo-lux-neo-start-boot"><code>sudo lux-neo start (boot)</code></h3> +<p>Start the server. +If you add <code>boot</code>, it will start when the system boots:</p> +<pre><code class="lang-bash">sudo lux-neo start boot +</code></pre> +<h3 id="sudo-lux-neo-stop-boot"><code>sudo lux-neo stop (boot)</code></h3> +<p>Stop the server. +If you add <code>boot</code>, it will <em>NOT</em> start when the system boots:</p> +<pre><code class="lang-bash">sudo lux-neo start boot +</code></pre> +<h3 id="sudo-lux-neo-status"><code>sudo lux-neo status</code></h3> +<p>This will output the status of the app. First it reports if the service is running, +and some general info. Then it prints the systemd-status report.</p> +<p>Example output:</p> +<pre><code class="lang-text">Luxcena-neo-cli [args: 'status'] + +╭─────────────────────╮ +│ Service active: yes │ +│ Starts on boot: yes │ +│ Has failed: no │ +╰─────────────────────╯ + +━━━Service status━━━━━━━━━━━━━━━━━━ +● luxcena-neo.service - Luxcena Neo + Loaded: loaded (/etc/systemd/system/luxcena-neo.service; enabled; vendor preset: enabled) + Active: active (running) since Wed 2018-12-05 22:55:28 UTC; 6min ago + Main PID: 2365 (luxcena-neo.sh) + CGroup: /system.slice/luxcena-neo.service + ├─2365 /bin/bash /home/lux-neo/src/bin/luxcena-neo.sh + └─2367 node /home/lux-neo/src/app.js + +Dec 05 22:55:28 LUXCENA-STUE-SKAP systemd[1]: Started Luxcena Neo. +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +</code></pre> +<h3 id="sudo-lux-neo-log-serviceapp"><code>sudo lux-neo log service/app</code></h3> +<p>This shows the last 20 lines of the chosen log-file. And stays open to show +all new entries.</p> +<p>Example output:</p> +<pre><code class="lang-text">Luxcena-neo-cli [args: 'log app'] + +━━━App log (press ctrl+c to exit)━━━━━━━━━━━━━━━━━━ +[3.11.2018 23:5:21:401] EVENT Starting Luxcena-Neo... +[3.11.2018 23:5:22:462] SUCCESS Webserver now listening at *:8080 +</code></pre> +<h3 id="sudo-lux-neo-version"><code>sudo lux-neo version</code></h3> +<p>Currently not really doing anything usefull apart from showing which branch you are on.</p> +<p>Example output:</p> +<pre><code class="lang-text">Luxcena-neo-cli [args: 'version'] + +╭─────────────────────╮ +│ Version: Unknown │ +│ branch : dev │ +╰─────────────────────╯ +</code></pre> +<h3 id="sudo-lux-neo-selectbranch-branch"><code>sudo lux-neo selectBranch <branch></code></h3> +<p>This will change what branch you are on to <branch>. Stashing changes (shouldn't be a concern, but just saying it anyways).</branch></p> +<p><em>Please note that the version-checker now will just be useless, as it does not now what branch we really are on.</em></p> </section> @@ -402,7 +456,7 @@ <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"CLI","level":"1.2.3","depth":2,"next":{"title":"Scripting","level":"1.3","depth":1,"ref":"","articles":[{"title":"Support Library","level":"1.3.1","depth":2,"path":"Scripting/SupportLib/README.md","ref":"Scripting/SupportLib/README.md","articles":[]},{"title":"Examples","level":"1.3.2","depth":2,"ref":"","articles":[{"title":"Strandtest","level":"1.3.2.1","depth":3,"path":"Scripting/Examples/strandtest.md","ref":"Scripting/Examples/strandtest.md","articles":[]}]}]},"previous":{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},"dir":"ltr"},"config":{"plugins":["code","pretty-term","hints","comment","github","emphasize","api","offline","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"emphasize":{},"offline":{},"pretty-term":{},"github":{"url":"https://github.com/jakobst1n/luxcena-neo"},"livereload":{},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"code":{"copyButtons":true},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"api":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"comment":{"highlightCommented":true}},"theme":"default","author":"JakobST1n","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Luxcena-Neo wiki","gitbook":"*"},"file":{"path":"Usage/CLI.md","mtime":"2018-11-29T21:47:23.305Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-05T18:48:59.208Z"},"basePath":"..","book":{"language":""}}); + gitbook.page.hasChanged({"page":{"title":"CLI","level":"1.2.3","depth":2,"next":{"title":"Scripting","level":"1.3","depth":1,"ref":"","articles":[{"title":"Support Library","level":"1.3.1","depth":2,"path":"Scripting/SupportLib/README.md","ref":"Scripting/SupportLib/README.md","articles":[]}]},"previous":{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},"dir":"ltr"},"config":{"plugins":["code","pretty-term","hints","comment","github","emphasize","api","offline","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"emphasize":{},"offline":{},"pretty-term":{},"github":{"url":"https://github.com/jakobst1n/luxcena-neo"},"livereload":{},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"code":{"copyButtons":true},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"api":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"comment":{"highlightCommented":true}},"theme":"default","author":"JakobST1n","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Luxcena-Neo wiki","gitbook":"*"},"file":{"path":"Usage/CLI.md","mtime":"2018-12-05T23:12:33.977Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-05T23:08:01.913Z"},"basePath":"..","book":{"language":""}}); }); </script> </div> diff --git a/docs/_book/Usage/Configuration.html b/docs/_book/Usage/Configuration.html index 9428992..28abb96 100644 --- a/docs/_book/Usage/Configuration.html +++ b/docs/_book/Usage/Configuration.html @@ -441,7 +441,7 @@ This is the dma-channel used to generate the data-stream. If you for some reason <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Configuration","level":"1.2.2","depth":2,"next":{"title":"CLI","level":"1.2.3","depth":2,"path":"Usage/CLI.md","ref":"Usage/CLI.md","articles":[]},"previous":{"title":"Install","level":"1.2.1","depth":2,"path":"Usage/Install.md","ref":"Usage/Install.md","articles":[]},"dir":"ltr"},"config":{"plugins":["code","pretty-term","hints","comment","github","emphasize","api","offline","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"emphasize":{},"offline":{},"pretty-term":{},"github":{"url":"https://github.com/jakobst1n/luxcena-neo"},"livereload":{},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"code":{"copyButtons":true},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"api":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"comment":{"highlightCommented":true}},"theme":"default","author":"JakobST1n","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Luxcena-Neo wiki","gitbook":"*"},"file":{"path":"Usage/Configuration.md","mtime":"2018-11-30T10:47:07.758Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-05T18:48:59.208Z"},"basePath":"..","book":{"language":""}}); + gitbook.page.hasChanged({"page":{"title":"Configuration","level":"1.2.2","depth":2,"next":{"title":"CLI","level":"1.2.3","depth":2,"path":"Usage/CLI.md","ref":"Usage/CLI.md","articles":[]},"previous":{"title":"Install","level":"1.2.1","depth":2,"path":"Usage/Install.md","ref":"Usage/Install.md","articles":[]},"dir":"ltr"},"config":{"plugins":["code","pretty-term","hints","comment","github","emphasize","api","offline","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"emphasize":{},"offline":{},"pretty-term":{},"github":{"url":"https://github.com/jakobst1n/luxcena-neo"},"livereload":{},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"code":{"copyButtons":true},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"api":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"comment":{"highlightCommented":true}},"theme":"default","author":"JakobST1n","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Luxcena-Neo wiki","gitbook":"*"},"file":{"path":"Usage/Configuration.md","mtime":"2018-11-30T10:47:07.758Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-05T23:08:01.913Z"},"basePath":"..","book":{"language":""}}); }); </script> </div> diff --git a/docs/_book/Usage/Install.html b/docs/_book/Usage/Install.html index bca71ef..d6e301e 100644 --- a/docs/_book/Usage/Install.html +++ b/docs/_book/Usage/Install.html @@ -416,7 +416,7 @@ This is also where you will find possible reasons for a failed install.</li> <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Install","level":"1.2.1","depth":2,"next":{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},"previous":{"title":"Usage","level":"1.2","depth":1,"path":"Usage/README.md","ref":"Usage/README.md","articles":[{"title":"Install","level":"1.2.1","depth":2,"path":"Usage/Install.md","ref":"Usage/Install.md","articles":[]},{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},{"title":"CLI","level":"1.2.3","depth":2,"path":"Usage/CLI.md","ref":"Usage/CLI.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["code","pretty-term","hints","comment","github","emphasize","api","offline","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"emphasize":{},"offline":{},"pretty-term":{},"github":{"url":"https://github.com/jakobst1n/luxcena-neo"},"livereload":{},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"code":{"copyButtons":true},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"api":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"comment":{"highlightCommented":true}},"theme":"default","author":"JakobST1n","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Luxcena-Neo wiki","gitbook":"*"},"file":{"path":"Usage/Install.md","mtime":"2018-11-30T10:21:42.095Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-05T18:48:59.208Z"},"basePath":"..","book":{"language":""}}); + gitbook.page.hasChanged({"page":{"title":"Install","level":"1.2.1","depth":2,"next":{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},"previous":{"title":"Usage","level":"1.2","depth":1,"path":"Usage/README.md","ref":"Usage/README.md","articles":[{"title":"Install","level":"1.2.1","depth":2,"path":"Usage/Install.md","ref":"Usage/Install.md","articles":[]},{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},{"title":"CLI","level":"1.2.3","depth":2,"path":"Usage/CLI.md","ref":"Usage/CLI.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["code","pretty-term","hints","comment","github","emphasize","api","offline","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"emphasize":{},"offline":{},"pretty-term":{},"github":{"url":"https://github.com/jakobst1n/luxcena-neo"},"livereload":{},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"code":{"copyButtons":true},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"api":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"comment":{"highlightCommented":true}},"theme":"default","author":"JakobST1n","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Luxcena-Neo wiki","gitbook":"*"},"file":{"path":"Usage/Install.md","mtime":"2018-11-30T10:21:42.095Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-05T23:08:01.913Z"},"basePath":"..","book":{"language":""}}); }); </script> </div> |