From ee042fc7bfa55ffa2c3b4471276a3b3a7cf95dea Mon Sep 17 00:00:00 2001 From: Pliable Pixels Date: Fri, 15 Mar 2019 10:27:55 -0400 Subject: doc fixes --- docs/_build/html/_sources/guides/FAQ.rst.txt | 21 +++--- docs/_build/html/_sources/guides/source.rst.txt | 75 ++++++++-------------- .../html/_sources/guides/validating-api.rst.txt | 15 +++-- 3 files changed, 43 insertions(+), 68 deletions(-) (limited to 'docs/_build/html/_sources') diff --git a/docs/_build/html/_sources/guides/FAQ.rst.txt b/docs/_build/html/_sources/guides/FAQ.rst.txt index c5ecc3c6..b36936d7 100644 --- a/docs/_build/html/_sources/guides/FAQ.rst.txt +++ b/docs/_build/html/_sources/guides/FAQ.rst.txt @@ -55,8 +55,7 @@ Try before buy Some users legitimately look around for an option to try before they buy and they are not savvy enough to `download the -code `__ and -`compile `__ +code `__ and compile (:doc:`source`) for themselves. Fair enough. In that case, `download the Desktop version `__ of zmNinja. It's free and is the same code as mobile. Make sure the desktop @@ -128,12 +127,9 @@ How to report errors - Before you create an issue, please make sure you have read the sections on `connection - issues `__ - and - `streaming `__ - issues and `Step 6 of - validating `__ - APIs. + issues <#connectionauthentication-issues>`__ + and `streaming <#live-streaming-issues>`__ + issues and Step 6 of :doc:`validating-api` - 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 @@ -332,7 +328,7 @@ In the above case my zmNinja cgi-bin setting is ``https://myserver:myport/zm/cgi-bin`` - You are using Basic Authentication. See - `here <#i-cant-see-streams-i-use-basic-auth>`__ + `here <#i-can-t-see-streams-i-use-basic-auth>`__ - 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 @@ -341,7 +337,7 @@ In the above case my zmNinja cgi-bin setting is - example Apache's ``error.log`` - see any image/jpg errors? That means you are missing libraries - You have set up a multi-server install of ZM without knowing you did - See `here <#i-cant-see-streams--multi-server-is-enabled>`__ + See `here <#i-can-t-see-streams-multi-server-is-enabled>`__ - Look at zmNinja, ZoneMinder and web server error logs at the time of error - one of them should give more clues. Please send me *all* the logs if you ask for help @@ -605,7 +601,7 @@ to read your distro notes on how to **properly** update. Read `this `__ thread. Before you think zmNinja is the problem, make sure your `APIs are -working `__. +working :doc:`validating-api` 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 @@ -651,8 +647,7 @@ discussion APIs are not working ! ZM console works fine. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Read -`this `__ +:doc:`validating-api` I'm using mocord/record and I don't see events without alarms ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/_build/html/_sources/guides/source.rst.txt b/docs/_build/html/_sources/guides/source.rst.txt index 75785de7..87252e09 100644 --- a/docs/_build/html/_sources/guides/source.rst.txt +++ b/docs/_build/html/_sources/guides/source.rst.txt @@ -3,7 +3,7 @@ Building from Source **NOTE** If you want to run it on your desktop, you can directly download desktop binaries -`here `__ +`here `__ and if you want it for Android/iOS you can get from the play/appstore. This is only for those who *want* to run from source. @@ -113,6 +113,32 @@ 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) +(Harder) If you need picture notification support in push +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +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: + +- Open up ``platforms/ios/zmNinja.xcworkspace`` in XCode +- Go to ``File->New->Target->Notification Service Extension``, select Objective C +- In the "Product Name" put in ``zmNinjaNotification`` (your BundleID should now read ``com.pliablepixels.zmninja-pro.zmNinjaNotification``) +- Say "Yes" to "Activate zmNinjaNotification scheme?" popup +- Now go to zmNinjaNotification target and make version and build same as zmNinja +- Now in XCode Targets, select ``zmNinjaNotification``, and make sure you select a Team and make sure Deployment Target is 10 or above +- Change Deployment target to 10.1 (same as zmNinja target) +- ```cp www/external/NotificationService.m platforms/ios/zmNinjaNotication/`` +- ``cd platforms/ios/`` +- ``pod install`` + +You can now do `build_ios.sh`. However, after you build, you will have to go back to XCode +after the build to make the following changes: + +1. Sync notification version with app version +2. Change notification bundle ID back to com.pliablepixels.zmninja-pro.zmNinjaNotification (cordova removes the last word) + + +(Easier) If you don't need picture notification support in push +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + 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 ``ld: library not found for -lGoogleToolboxForMac`` @@ -201,53 +227,6 @@ You now have the following options: Your packages will be created in the ``dist`` folder -Set up desktop dependencies -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code:: bash - - npm install -g electron - npm install -g asar - -Make sure ``electron`` is installed. You should be able to do a -``which electron`` - -Also make sure ``unzip`` and ``wget`` tools are installed in your -system. - -First time setup -~~~~~~~~~~~~~~~~ - -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 ``prepare_desktop.sh`` that you can run. This creates a -directory called ``desktop`` inside your zmNinja directory. It currently -downloads all supported platforms. - -.. code:: bash - - ./prepare_desktop.sh - -This will download a bunch of files. If completed successfully, you can -proceed to the next step. - -Make the desktop build -~~~~~~~~~~~~~~~~~~~~~~ - -Once you are done with ``prepare_desktop.sh``, you can do a -``./make_desktop.sh``. This will actually build images for all -platforms. - -Running desktop builds -~~~~~~~~~~~~~~~~~~~~~~ - -``cd`` into the desktop directory and run whichever port you want - -Subsequent builds -~~~~~~~~~~~~~~~~~ - -You need to ``./make_desktop.sh`` each time you make changes. - Troubleshooting --------------- diff --git a/docs/_build/html/_sources/guides/validating-api.rst.txt b/docs/_build/html/_sources/guides/validating-api.rst.txt index 0b3d478b..a2acdfae 100644 --- a/docs/_build/html/_sources/guides/validating-api.rst.txt +++ b/docs/_build/html/_sources/guides/validating-api.rst.txt @@ -49,13 +49,14 @@ response like: } - Step 6: (If you find your APIs show ok, but zmNinja has issues) -- Open a browser, log into ZM -- Open a new tab, enter ``http://server/zm/api/host/getVersion.json`` -- Now, right click and do a ``View Source`` in your browser (different - browsers may have different names for it). This brings up a full - source code view of the page. Do you ONLY see the JSON output or do - you see gobs of HTML on top like ``