Skip to content

Commit

Permalink
Add ReadMe and Notice file
Browse files Browse the repository at this point in the history
  • Loading branch information
@jfantinhardesty
jfantinhardesty committed Jul 1, 2024
1 parent ca8bfb3 commit 2ab04c7
Show file tree
Hide file tree
Showing 3 changed files with 307 additions and 5 deletions.
204 changes: 204 additions & 0 deletions NOTICE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
--------------------- START OF THIRD PARTY NOTICE -----------------------------

NOTICES AND INFORMATION
Do Not Translate or Localize

This software incorporates material from third parties.

Notwithstanding any other terms, you may reverse engineer this software to the
extent required to debug changes to any libraries licensed under the GNU Lesser
General Public License.

Third Party Programs: The software may include third party programs that Seagate,
not the third party, licenses to you under this agreement. Notices, if any, for the
third party programs are included for your information only.
---------------------------------------------------------------------------------------





****************************************************************************

============================================================================
>>> github.com/openssl/openssl
==============================================================================

Apache License
Version 2.0, January 2004
https://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

****************************************************************************
99 changes: 97 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,97 @@
# nx-lyve-cloud-plugin
Cloud storage plugin for Network Optix Nx Meta VMS
# Nx-Lyve-Cloud-Plugin

Nx-Lyve-Cloud-Plugin is a cloud storage plugin for Network Optix VMS's including Nx Witness and Digital Watchdog
Spectrum. This plugin allows the user to easily configure their cloud and create a local mount of their cloud on their
system. This mount can then be used as a backup location for video recordings in the VMS. The plugins utilizes
[cloudfuse](https://github.com/Seagate/cloudfuse) to create and manage the local mount.

## Building the Nx-Lyve-Cloud-Plugin

The following are instructions to build our plugin from source.

The following are the currently supported platforms and architectures:

- Windows 10, 11 x64 (Microsoft Visual Studio).
- Linux Ubuntu 18.04, 20.04, 22.04, 24.04 (GCC or Clang) x64

### Ubuntu

You should have a modern version of GCC or Clang and cmake installed on your system.

#### 1. Clone GitHub repository

```bash
git clone https://github.com/Seagate/nx-lyve-cloud-plugin
cd nx-lyve-cloud-plugin
git checkout -b main origin/main
```

#### 2. Run the build script

Run one of the following to build the plugin.

The following will default to your OS selected C compiler.

```bash
./build_samples.sh --no-tests
```

The following will use gcc. You may also replace gcc/g++ with clang/clang++.

```bash
./build_samples.sh --no-tests -DCMAKE_CXX_COMPILER=gcc -DCMAKE_C_COMPILER=g++
```

After running the script the resulting .so file can be found at
`../nx-lyve-cloud-plugin-build/cloudfuse_plugin/libcloudfuse_plugin.so`.

### Windows

You should have a modern version of MSVC from Microsoft Visual Studio, cmake, and vcpkg installed on your system.

#### 1. Clone GitHub repository

```powershell
git clone https://github.com/Seagate/nx-lyve-cloud-plugin
cd nx-lyve-cloud-plugin
git checkout -b main origin/main
```

#### 2. Setup VCPKG with Cmake

Assuming you already have cmake installed and vcpkg, then we need to set the cmake toolchain to use the vcpkg toolchain.

```powershell
$Env:VCPKG_ROOT = "Path/To/Vcpkg"
```

#### 3. Run the build script

Run the following to build the plugin.

```powershell
./build_samples.bat --no-tests --debug
```

After running the script the resulting `.so` file can be found at
`..\nx-lyve-cloud-plugin-build\cloudfuse_plugin\Debug\cloudfuse_plugin.dll`.

## Installing the Nx-Lyve-Cloud-Plugin

To install the plugin, copy the `.dll` or `.so` file to the plugins folder of the VMS.

Additionally, you need to install cloudfuse on your system. Follow install instructions for cloudfuse
[here](https://github.com/Seagate/cloudfuse).

After installing cloudfuse, and copying the plugin file, restart the VMS and the plugin will appear in the System
Administration tab. Then you can enter your S3 credentials and a mount will appear on the system connected to the cloud.
This can be selected as a backup mount and video files will be backed up to the cloud.

## License

Most of the project is licensed under the [Mozilla Public License](https://www.mozilla.org/en-US/MPL/2.0/) and the rest
is under MIT; check the specific on each file to determine which is which.

### Third-Party Notices

See [notices](./NOTICE) for third party license notices.
9 changes: 6 additions & 3 deletions SECURITY.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Nx-Lyve-Cloud-Plugin Security Policy

We take security seriously. If you find any security vulnerabilities in any of the Nx-Lyve-Cloud-Plugin source code, or other binary tools, please report it to us as described below.
We take security seriously. If you find any security vulnerabilities in any of the Nx-Lyve-Cloud-Plugin source code, or
other binary tools, please report it to us as described below.

## Reporting Security Issues

Expand All @@ -9,11 +10,13 @@ We take security seriously. If you find any security vulnerabilities in any of t
If you have questions or general concerns, please email us at [ADD_EMAIL_ADDRESS](mailto: ADD_EMAIL_ADDRESS).
-->

To report an actual vulnerability, please use the form available at "[Seagate Responsible Vulnerability Disclosure Policy](https://www.seagate.com/legal-privacy/responsible-vulnerability-disclosure-policy/)"
To report an actual vulnerability, please use the form available at "[Seagate Responsible Vulnerability Disclosure
Policy](https://www.seagate.com/legal-privacy/responsible-vulnerability-disclosure-policy/)"

### Reporting Format

To make your reporting meaningful and help us understand the nature and scope of the issue, please include as much information as possible.
To make your reporting meaningful and help us understand the nature and scope of the issue, please include as much
information as possible.

### Preferred Languages

Expand Down

0 comments on commit 2ab04c7

Please sign in to comment.