diff options
Diffstat (limited to 'docs/_build/html/guides')
| -rw-r--r-- | docs/_build/html/guides/FAQ.html | 23 | ||||
| -rw-r--r-- | docs/_build/html/guides/source.html | 77 | ||||
| -rw-r--r-- | docs/_build/html/guides/validating-api.html | 9 |
3 files changed, 48 insertions, 61 deletions
diff --git a/docs/_build/html/guides/FAQ.html b/docs/_build/html/guides/FAQ.html index fe38493e..d71c73ef 100644 --- a/docs/_build/html/guides/FAQ.html +++ b/docs/_build/html/guides/FAQ.html @@ -275,8 +275,7 @@ Breathe.</p> <h3>Try before buy<a class="headerlink" href="#try-before-buy" title="Permalink to this headline">¶</a></h3> <p>Some users legitimately look around for an option to try before they buy and they are not savvy enough to <a class="reference external" href="https://github.com/pliablepixels/zmNinja">download the -code</a> and -<a class="reference external" href="https://github.com/pliablepixels/zmNinja/wiki/Running-zmNinja-from-Source">compile</a> +code</a> and compile (<a class="reference internal" href="source.html"><span class="doc">Building from Source</span></a>) for themselves. Fair enough. In that case, <a class="reference external" href="https://github.com/pliablepixels/zmNinja/releases">download the Desktop version</a> of zmNinja. It’s free and is the same code as mobile. Make sure the desktop @@ -340,13 +339,10 @@ you can download logs (cloud icon, desktop version)</li> be sure to mention which version was working and which was not. In this case, please make sure you have validated the APIs work</li> <li>Before you create an issue, please make sure you have read the -sections on <a class="reference external" href="https://github.com/pliablepixels/zmNinja/wiki/FAQ#connectionauthentication-issues">connection +sections on <a class="reference external" href="#connectionauthentication-issues">connection issues</a> -and -<a class="reference external" href="https://github.com/pliablepixels/zmNinja/wiki/FAQ#live-streaming-issues">streaming</a> -issues and <a class="reference external" href="https://github.com/pliablepixels/zmNinja/wiki/Validating-if-APIs-work-on-ZM">Step 6 of -validating</a> -APIs.</li> +and <a class="reference external" href="#live-streaming-issues">streaming</a> +issues and Step 6 of <a class="reference internal" href="validating-api.html"><span class="doc">Validating APIs</span></a></li> <li>Its often hard to infer a problem especially when its due to some unique apache/nginx mungling you might have done but haven’t told me about it. In such cases, try and give me remote access to your ZM for @@ -523,7 +519,7 @@ can use in zmNinja.</li> <code class="docutils literal"><span class="pre">https://myserver:myport/zm/cgi-bin</span></code></p> <ul class="simple"> <li>You are using Basic Authentication. See -<a class="reference external" href="#i-cant-see-streams-i-use-basic-auth">here</a></li> +<a class="reference external" href="#i-can-t-see-streams-i-use-basic-auth">here</a></li> <li>You have ‘multi-server’ configuration enabled and you have done it wrong. Go to ZM Web Console->Options->Servers - if you see any entries there and you don’t know what multi-server is, or you don’t @@ -532,7 +528,7 @@ use it, please disable multi-server</li> - example Apache’s <code class="docutils literal"><span class="pre">error.log</span></code> - see any image/jpg errors? That means you are missing libraries</li> <li>You have set up a multi-server install of ZM without knowing you did -See <a class="reference external" href="#i-cant-see-streams--multi-server-is-enabled">here</a></li> +See <a class="reference external" href="#i-can-t-see-streams-multi-server-is-enabled">here</a></li> <li>Look at zmNinja, ZoneMinder and web server error logs at the time of error - one of them should give more clues. Please send me <em>all</em> the logs if you ask for help</li> @@ -773,9 +769,9 @@ one</a>.</p> <p>ZoneMinder changed API packaging with ZM 1.30.2 and above. You will have to read your distro notes on how to <strong>properly</strong> update. Read <a class="reference external" href="https://forums.zoneminder.com/viewtopic.php?f=36&t=26002&start=30&hilit=api+broken">this</a> -thread. Before you think zmNinja is the problem, make sure your <a class="reference external" href="https://github.com/pliablepixels/zmNinja/wiki/Validating-if-APIs-work-on-ZM">APIs +thread. Before you think zmNinja is the problem, make sure your <cite>APIs are -working</a>. +working :doc:`validating-api</cite> Summary of reasons why zmNinja might have stopped working: - You did not check if your APIs are working after the upgrade - You did not upgrade properly (just updating the ZM package without following distro @@ -819,8 +815,7 @@ discussion</p> </div> <div class="section" id="apis-are-not-working-zm-console-works-fine"> <h3>APIs are not working ! ZM console works fine.<a class="headerlink" href="#apis-are-not-working-zm-console-works-fine" title="Permalink to this headline">¶</a></h3> -<p>Read -<a class="reference external" href="https://github.com/pliablepixels/zmNinja/wiki/Validating-if-APIs-work-on-ZM">this</a></p> +<p><a class="reference internal" href="validating-api.html"><span class="doc">Validating APIs</span></a></p> </div> <div class="section" id="i-m-using-mocord-record-and-i-don-t-see-events-without-alarms"> <h3>I’m using mocord/record and I don’t see events without alarms<a class="headerlink" href="#i-m-using-mocord-record-and-i-don-t-see-events-without-alarms" title="Permalink to this headline">¶</a></h3> diff --git a/docs/_build/html/guides/source.html b/docs/_build/html/guides/source.html index ce53f606..7430a695 100644 --- a/docs/_build/html/guides/source.html +++ b/docs/_build/html/guides/source.html @@ -97,18 +97,17 @@ </li> <li class="toctree-l2"><a class="reference internal" href="#download-zmninja">Download zmNinja</a></li> <li class="toctree-l2"><a class="reference internal" href="#configure-build-configure-zmninja-and-get-all-required-plugins">Configure build configure zmNinja and get all required plugins</a></li> -<li class="toctree-l2"><a class="reference internal" href="#making-an-ios-build">Making an iOS build</a></li> +<li class="toctree-l2"><a class="reference internal" href="#making-an-ios-build">Making an iOS build</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#harder-if-you-need-picture-notification-support-in-push">(Harder) If you need picture notification support in push</a></li> +<li class="toctree-l3"><a class="reference internal" href="#easier-if-you-don-t-need-picture-notification-support-in-push">(Easier) If you don’t need picture notification support in push</a></li> +</ul> +</li> <li class="toctree-l2"><a class="reference internal" href="#making-an-android-build">Making an Android build</a></li> <li class="toctree-l2"><a class="reference internal" href="#making-a-desktop-build">Making a desktop build</a><ul> <li class="toctree-l3"><a class="reference internal" href="#for-versions-1-3-018-and-beyond">For versions 1.3.018 and beyond</a><ul> <li class="toctree-l4"><a class="reference internal" href="#make-sure-you-have-all-the-dependencies">Make sure you have all the dependencies</a></li> </ul> </li> -<li class="toctree-l3"><a class="reference internal" href="#set-up-desktop-dependencies">Set up desktop dependencies</a></li> -<li class="toctree-l3"><a class="reference internal" href="#first-time-setup">First time setup</a></li> -<li class="toctree-l3"><a class="reference internal" href="#make-the-desktop-build">Make the desktop build</a></li> -<li class="toctree-l3"><a class="reference internal" href="#running-desktop-builds">Running desktop builds</a></li> -<li class="toctree-l3"><a class="reference internal" href="#subsequent-builds">Subsequent builds</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li> @@ -183,7 +182,7 @@ <h1>Building from Source<a class="headerlink" href="#building-from-source" title="Permalink to this headline">¶</a></h1> <p><strong>NOTE</strong> If you want to run it on your desktop, you can directly download desktop binaries -<a class="reference external" href="https://github.com/pliablepixels/zmNinja#desktop-platforms">here</a> +<a class="reference external" href="https://github.com/pliablepixels/releases">here</a> and if you want it for Android/iOS you can get from the play/appstore. This is only for those who <em>want</em> to run from source.</p> <blockquote> @@ -278,6 +277,31 @@ version</a></p> installed. You also need to have your developer certificates/etc. (I am not going to detail this out - there are many internet resources on this)</p> +<div class="section" id="harder-if-you-need-picture-notification-support-in-push"> +<h3>(Harder) If you need picture notification support in push<a class="headerlink" href="#harder-if-you-need-picture-notification-support-in-push" title="Permalink to this headline">¶</a></h3> +<p>As of Mar 2019, cordova-ios does not support multiple targets, nor does +it support automatic building of notification extensions. So there is manual work to be done:</p> +<ul class="simple"> +<li>Open up <code class="docutils literal"><span class="pre">platforms/ios/zmNinja.xcworkspace</span></code> in XCode</li> +<li>Go to <code class="docutils literal"><span class="pre">File->New->Target->Notification</span> <span class="pre">Service</span> <span class="pre">Extension</span></code>, select Objective C</li> +<li>In the “Product Name” put in <code class="docutils literal"><span class="pre">zmNinjaNotification</span></code> (your BundleID should now read <code class="docutils literal"><span class="pre">com.pliablepixels.zmninja-pro.zmNinjaNotification</span></code>)</li> +<li>Say “Yes” to “Activate zmNinjaNotification scheme?” popup</li> +<li>Now go to zmNinjaNotification target and make version and build same as zmNinja</li> +<li>Now in XCode Targets, select <code class="docutils literal"><span class="pre">zmNinjaNotification</span></code>, and make sure you select a Team and make sure Deployment Target is 10 or above</li> +<li>Change Deployment target to 10.1 (same as zmNinja target)</li> +<li><code class="docutils literal"><span class="pre">`cp</span> <span class="pre">www/external/NotificationService.m</span> <span class="pre">platforms/ios/zmNinjaNotication/</span></code></li> +<li><code class="docutils literal"><span class="pre">cd</span> <span class="pre">platforms/ios/</span></code></li> +<li><code class="docutils literal"><span class="pre">pod</span> <span class="pre">install</span></code></li> +</ul> +<p>You can now do <cite>build_ios.sh</cite>. However, after you build, you will have to go back to XCode +after the build to make the following changes:</p> +<ol class="arabic simple"> +<li>Sync notification version with app version</li> +<li>Change notification bundle ID back to com.pliablepixels.zmninja-pro.zmNinjaNotification (cordova removes the last word)</li> +</ol> +</div> +<div class="section" id="easier-if-you-don-t-need-picture-notification-support-in-push"> +<h3>(Easier) If you don’t need picture notification support in push<a class="headerlink" href="#easier-if-you-don-t-need-picture-notification-support-in-push" title="Permalink to this headline">¶</a></h3> <p>There are a few steps you need to take to get the iOS build working for the first time. If you don’t do this, you may get a compilation error that says <code class="docutils literal"><span class="pre">ld:</span> <span class="pre">library</span> <span class="pre">not</span> <span class="pre">found</span> <span class="pre">for</span> <span class="pre">-lGoogleToolboxForMac</span></code></p> @@ -301,6 +325,7 @@ is on in Background Modes and in iCloud section, Key-Value storage is enabled. If you see a “Fix issue” there, clicking on that button resolves everything.</p> </div> +</div> <div class="section" id="making-an-android-build"> <h2>Making an Android build<a class="headerlink" href="#making-an-android-build" title="Permalink to this headline">¶</a></h2> <p>Note that you need the <a class="reference external" href="http://developer.android.com/sdk/index.html">Android @@ -346,44 +371,6 @@ to automate the build process better.</p> <p>Your packages will be created in the <code class="docutils literal"><span class="pre">dist</span></code> folder</p> </div> </div> -<div class="section" id="set-up-desktop-dependencies"> -<h3>Set up desktop dependencies<a class="headerlink" href="#set-up-desktop-dependencies" title="Permalink to this headline">¶</a></h3> -<div class="code bash highlight-default"><div class="highlight"><pre><span></span><span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">electron</span> -<span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">asar</span> -</pre></div> -</div> -<p>Make sure <code class="docutils literal"><span class="pre">electron</span></code> is installed. You should be able to do a -<code class="docutils literal"><span class="pre">which</span> <span class="pre">electron</span></code></p> -<p>Also make sure <code class="docutils literal"><span class="pre">unzip</span></code> and <code class="docutils literal"><span class="pre">wget</span></code> tools are installed in your -system.</p> -</div> -<div class="section" id="first-time-setup"> -<h3>First time setup<a class="headerlink" href="#first-time-setup" title="Permalink to this headline">¶</a></h3> -<p>If this is the first time you are building a desktop version, you need -to download electron images for various platforms. There is a helper -script called <code class="docutils literal"><span class="pre">prepare_desktop.sh</span></code> that you can run. This creates a -directory called <code class="docutils literal"><span class="pre">desktop</span></code> inside your zmNinja directory. It currently -downloads all supported platforms.</p> -<div class="code bash highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">prepare_desktop</span><span class="o">.</span><span class="n">sh</span> -</pre></div> -</div> -<p>This will download a bunch of files. If completed successfully, you can -proceed to the next step.</p> -</div> -<div class="section" id="make-the-desktop-build"> -<h3>Make the desktop build<a class="headerlink" href="#make-the-desktop-build" title="Permalink to this headline">¶</a></h3> -<p>Once you are done with <code class="docutils literal"><span class="pre">prepare_desktop.sh</span></code>, you can do a -<code class="docutils literal"><span class="pre">./make_desktop.sh</span></code>. This will actually build images for all -platforms.</p> -</div> -<div class="section" id="running-desktop-builds"> -<h3>Running desktop builds<a class="headerlink" href="#running-desktop-builds" title="Permalink to this headline">¶</a></h3> -<p><code class="docutils literal"><span class="pre">cd</span></code> into the desktop directory and run whichever port you want</p> -</div> -<div class="section" id="subsequent-builds"> -<h3>Subsequent builds<a class="headerlink" href="#subsequent-builds" title="Permalink to this headline">¶</a></h3> -<p>You need to <code class="docutils literal"><span class="pre">./make_desktop.sh</span></code> each time you make changes.</p> -</div> </div> <div class="section" id="troubleshooting"> <h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2> diff --git a/docs/_build/html/guides/validating-api.html b/docs/_build/html/guides/validating-api.html index fd0eb148..2d66ce6c 100644 --- a/docs/_build/html/guides/validating-api.html +++ b/docs/_build/html/guides/validating-api.html @@ -209,8 +209,10 @@ response like:</p> <span class="p">}</span> </pre></div> </div> -<ul class="simple"> -<li>Step 6: (If you find your APIs show ok, but zmNinja has issues)</li> +<ul> +<li><p class="first">Step 6: (If you find your APIs show ok, but zmNinja has issues)</p> +<blockquote> +<div><ul class="simple"> <li>Open a browser, log into ZM</li> <li>Open a new tab, enter <code class="docutils literal"><span class="pre">http://server/zm/api/host/getVersion.json</span></code></li> <li>Now, right click and do a <code class="docutils literal"><span class="pre">View</span> <span class="pre">Source</span></code> in your browser (different @@ -219,6 +221,9 @@ source code view of the page. Do you ONLY see the JSON output or do you see gobs of HTML on top like <code class="docutils literal"><span class="pre"><pre</span> <span class="pre">class=</span></code> and lots of cake related messages? If you do, you need to fix it.</li> </ul> +</div></blockquote> +</li> +</ul> <p>if you find the page empty, your APIs/permissions have a problem. Please post in the ZM forums (<strong>please DON’T</strong> contact me first as its not a zmNinja bug)</p> |