Mirrors
/
ARDEN-documentation
mirror of https://github.com/aredn/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix links/referrers to external sites (#220)

This commit is contained in:
Steve 2022-11-18 08:39:07 -07:00 committed by GitHub
parent b3b1cee2f6
commit 25b003dda2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -2,7 +2,7 @@
This repository is for creating documentation for the AREDN project so it can be made available on ReadTheDocs.
## Viewing the Docs:
To view the AREDN documentation in a web browser, navigate to [https://arednmesh.readthedocs.io/en/latest/](https://arednmesh.readthedocs.io/en/latest/) or select your choice from the `Docs` dropdown menu on [https://arednmesh.org](https://arednmesh.org).
To view the AREDN documentation in a web browser, navigate to [https://arednmesh.readthedocs.io/en/latest/](https://arednmesh.readthedocs.io/en/latest/) or select your choice from the `Docs` dropdown menu on [https://www.arednmesh.org](https://www.arednmesh.org).
## Exporting to PDF:
While viewing the AREDN documentation in your web browser, you will see the contents list in the left panel. At the bottom of the panel is a drawer labeled "ReadTheDocs" showing the version you are viewing. Click the label bar to open it. From the drawer you can export the documentation set as a single PDF or Epub file. This is handy if you want to take a PDF copy of the guidebook with you into the field where you do not have Internet access.

2
arednGettingStarted/installing_firmware.rst
View File

@ -202,7 +202,7 @@ After the GL-iNet device is first booted and configured, navigate to the **Upgra
.. attention:: Be sure to uncheck the **Keep Settings** checkbox, since GL.iNet settings are incompatible with AREDN |trade| firmware.
The node will automatically reboot with the new AREDN |trade| firmware image. If for some reason your GL-iNet device gets into an unusable state, you should be able to recover using the process documented here:
`GL-iNet debrick procedure <https://docs.gl-inet.com/en/2/troubleshooting/debrick/>`_
`GL-iNet debrick procedure <https://docs.gl-inet.com/en/3/tutorials/debrick/>`_
After the Firmware Install
--------------------------

2
arednHow-toGuides/puttygen_ssh_keys.rst
View File

@ -28,7 +28,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
|
Give the key pair a suitable comment so that you will remember what the keys are used for. Here we just entered testkey@wu2s.com for an example. Whatever you enter in the "Key Comment" field must look like an email address with no spaces and the "@" present. Normally this field is used to identify a specific *username@hostname*. You can also password protect the SSH login by providing a passphrase if you desire. Record this passphrase so you will remember it for future use.
Give the key pair a suitable comment so that you will remember what the keys are used for. Here we just entered ``testkey@wu2s.com`` for an example. Whatever you enter in the "Key Comment" field must look like an email address with no spaces and the "@" present. Normally this field is used to identify a specific *username@hostname*. You can also password protect the SSH login by providing a passphrase if you desire. Record this passphrase so you will remember it for future use.
3. In PuTTYGen you can save your new keys to separate files for later use. To save the public key to a suitable location, click the *Save Public Key* button and enter a filename with a **.pub** extension. Then click the *Save Private Key* button to save your private key to the same location. Give your private key a **.ppk** file extension. Many people save their keys on a USB flash drive to maintain physical possession of them at all times.

4
arednServicesGuide/video_streaming.rst
View File

@ -25,7 +25,7 @@ IP Video Cameras
IP video cameras may have a fixed direction and focus, or they may be remote controlled `PTZ (Pan, Tilt, Zoom) <https://en.wikipedia.org/wiki/Pan%E2%80%93tilt%E2%80%93zoom_camera>`_ models. The cost and features for video cameras vary widely. On the low end is a very inexpensive Raspberry Pi Zero computer having an integrated camera, shown here next to the Ubiquiti Bullet radio. On the high end are the ruggedized commercial :abbr:`PTZ (Pan, Tilt, Zoom)` cameras which can cost hundreds of dollars, shown here with the bubble dome and infrared LEDs.
Many IP cameras stream video using `Real Time Streaming Protocol (RTSP) <https://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol>`_ in which missing packets are simply skipped during video display. It can be challenging to determine the URL of an RTSP stream, but there is a handy utility at `ispyconnect <https://www.ispyconnect.com/sources.aspx>`_, as well as packet capture utilities such as `Wireshark <https://en.wikipedia.org/wiki/Wireshark>`_, which may help. Frequently a camera supports multiple RTSP URLs each with a different resolution, so you can advertise any of them as a service on an AREDN |trade| node as required. Recently more cameras support `ONVIF (Open Network Video Interface Forum) <https://en.wikipedia.org/wiki/ONVIF>`_, which is a set of protocols and standards that includes RTSP. It supports camera discovery and PTZ camera control.
Many IP cameras stream video using `Real Time Streaming Protocol (RTSP) <https://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol>`_ in which missing packets are simply skipped during video display. It can be challenging to determine the URL of an RTSP stream, but there is a handy utility at `ispyconnect <https://www.ispyconnect.com/cameras>`_, as well as packet capture utilities such as `Wireshark <https://en.wikipedia.org/wiki/Wireshark>`_, which may help. Frequently a camera supports multiple RTSP URLs each with a different resolution, so you can advertise any of them as a service on an AREDN |trade| node as required. Recently more cameras support `ONVIF (Open Network Video Interface Forum) <https://en.wikipedia.org/wiki/ONVIF>`_, which is a set of protocols and standards that includes RTSP. It supports camera discovery and PTZ camera control.
A 1920x1080 resolution video stream at 60 frames/second can consume up to eight megabits/second of network bandwidth. Few AREDN |trade| networks can consistently support that load, but lower frame rates reduce the required bandwidth proportionally. Typically 720p at 10 frames per second is more than adequate for video surveillance.
@ -60,7 +60,7 @@ MotionEye
MotionEye is a lightweight video display program which runs on Linux and Raspberry Pi computers. It can connect to a variety of USB or IP cameras, and it has the ability to display video streams in a grid format accessible by any web browser on the mesh network. Authentication as a regular user or an administrator will display different menu options: view options for regular users or full administrative control for admin users.
The backend `Motion <https://motion-project.github.io/index.html>`_ engine is built to provide robust motion detection and event triggering. It also enables custom scripts to extend its features, for example to print the system temperature and update it every ten seconds on the display. Many AREDN |trade| operators implement MotionEye on low-power portable Raspberry Pi computers, and the `MotionEyeOS distro <https://github.com/ccrisan/motioneyeos/wiki>`_ installs the operating system with all dependencies on this platform. For additional information about MotionEye, visit this link: `MotionEye <https://github.com/ccrisan/motioneye/wiki>`_
The backend `Motion <https://motion-project.github.io/index.html>`_ engine is built to provide robust motion detection and event triggering. It also enables custom scripts to extend its features, for example to print the system temperature and update it every ten seconds on the display. Many AREDN |trade| operators implement MotionEye on low-power portable Raspberry Pi computers, and the `MotionEyeOS distro <https://github.com/motioneye-project/motioneyeos/wiki>`_ installs the operating system with all dependencies on this platform. For additional information about MotionEye, visit this link: `MotionEye <https://github.com/motioneye-project/motioneye/wiki>`_
.. image:: _images/motioneye.png
:alt: MotionEye Display

2
conf.py
View File

@ -44,7 +44,7 @@ extensions = [
]
rst_epilog = """
`Link: AREDN Webpage <https://arednmesh.org>`_
`Link: AREDN Webpage <https://www.arednmesh.org>`_
"""
# Include the trademark symbol in the prolog