Skip to content

Commit

Permalink
Add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
tonur committed Jan 18, 2024
1 parent 373c97a commit 43508e7
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Christoffer Kragh Pedersen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Tenable-Exporter
Simple Tenable exporter to get Open-Telemetry metrics of Tenable Scans and Vulnerabilities.

## Usage
Run the Docker image with the following variables:
``` yaml
TIO_ACCESS_KEY:
TIO_SECRET_KEY:
SECURITYCENTER_NETWORK_ADDRESS:
SC_USERNAME:
SC_PASSWORD:
```
``` sh
docker run -p 8080:<your_port> -e TIO_ACCESS_KEY=your_access_key -e TIO_SECRET_KEY=your_secret_key -e SECURITYCENTER_NETWORK_ADDRESS=your_sc_address -e SC_USERNAME=your_sc_username -e SC_PASSWORD=your_sc_password tonur/tenable-exporter
```

You need to specify either (TIO_ACCESS_KEY, TIO_SECRET_KEY, SECURITYCENTER_NETWORK_ADDRESS), (SC_USERNAME, SC_PASSWORD) or all of them to have this image do anything. In the case of only SC Environment Variables supplied, only the Scanning metrics is updated and in the case of only TIO + Network Address supplied, only the Vulnerabilities is updated.

0 comments on commit 43508e7

Please sign in to comment.