wifi-tally_Oostendam/documentation/build/server/index.html

173 lines
8.8 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Server &mdash; Oostendam Tallies documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/drawio.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Tally Patches" href="../patches.html" />
<link rel="prev" title="Hardware Setup" href="../hardware/index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> Oostendam Tallies
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../overview.html">Tallies Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hardware/index.html">Hardware Setup</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Server</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#build-the-server">Build the server</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../patches.html">Tally Patches</a></li>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Migrating:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../migration.html">Migrating to a new PC</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Oostendam Tallies</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Server</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/server/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="server">
<h1>Server<a class="headerlink" href="#server" title="Permalink to this heading"></a></h1>
<p>The tallies require a server that will direct the tallies and figure out the status of the <code class="docutils literal notranslate"><span class="pre">BlackMagic</span> <span class="pre">ATEM</span></code>.</p>
<section id="build-the-server">
<h2>Build the server<a class="headerlink" href="#build-the-server" title="Permalink to this heading"></a></h2>
<p>Navigate to <code class="docutils literal notranslate"><span class="pre">wifi-tally/hub</span></code> and run the <code class="docutils literal notranslate"><span class="pre">build_server.sh</span></code>.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>./build_server.sh
<span class="go">&gt; wifi-tally-hub@0.1.0 build</span>
<span class="go">&gt; next build</span>
<span class="go">Browserslist: caniuse-lite is outdated. Please run:</span>
<span class="go">npx browserslist@latest --update-db</span>
<span class="go">info - Creating an optimized production build</span>
<span class="go">info - Compiled successfully</span>
<span class="go">info - Collecting page data</span>
<span class="go">[== ] info - Generating static pages (0/1)info - Finalizing page optimizati</span>
<span class="go">info - Finalizing page optimization</span>
<span class="go">Page Size First Load JS</span>
<span class="go">┌ λ / 4.55 kB 94.4 kB</span>
<span class="go">├ /_app 0 B 59.2 kB</span>
<span class="go">├ ○ /404 3.01 kB 62.2 kB</span>
<span class="go">├ λ /config 1.48 kB 91.3 kB</span>
<span class="go">└ λ /tally/[tallyName] 1.48 kB 91.3 kB</span>
<span class="go">+ First Load JS shared by all 59.2 kB</span>
<span class="go">├ chunks/07ed33f3.bca366.js 68 B</span>
<span class="go">├ chunks/commons.94f2cd.js 11 kB</span>
<span class="go">├ chunks/framework.9ec1f7.js 39.9 kB</span>
<span class="go">├ chunks/main.7e5158.js 7.2 kB</span>
<span class="go">├ chunks/pages/_app.627bfb.js 284 B</span>
<span class="go">├ chunks/webpack.e06743.js 751 B</span>
<span class="go">└ css/ba2fd543a36dbb3ceef1.css 25.9 kB</span>
<span class="go">λ (Server) server-side renders at runtime (uses getInitialProps or getServerSideProps)</span>
<span class="go">○ (Static) automatically rendered as static HTML (uses no initial props)</span>
<span class="go">● (SSG) automatically generated as static HTML + JSON (uses getStaticProps)</span>
<span class="gp gp-VirtualEnv">(ISR)</span> <span class="go">incremental static regeneration (uses revalidate in getStaticProps)</span>
<span class="go">[ ===] info - Generating static pages (0/1)%</span>
</pre></div>
</div>
<p>To run the server, navigate to <code class="docutils literal notranslate"><span class="pre">wifi-tally/hub</span></code> and execute <code class="docutils literal notranslate"><span class="pre">run_server.sh</span></code></p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>./run_server.sh
<span class="go">&gt; wifi-tally-hub@0.1.0 start</span>
<span class="go">&gt; node server.js --env=production</span>
<span class="go">Using mixer configuration &quot;null&quot;</span>
<span class="go">No video mixer connected.</span>
<span class="go">Listening for Tallies on 0.0.0.0:7411</span>
<span class="go">Web Server available on http://localhost:3000</span>
<span class="gp gp-VirtualEnv">(node:117081)</span> <span class="go">ExperimentalWarning: The Fetch API is an experimental feature. This feature could change at any time</span>
</pre></div>
</div>
<p>Depending on the OS of the stream PC you might need to create a new shell script to execute the <strong>npm run start</strong> command to run the server.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../hardware/index.html" class="btn btn-neutral float-left" title="Hardware Setup" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../patches.html" class="btn btn-neutral float-right" title="Tally Patches" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Eljakim.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>