Skip to content

Commit d666794

Browse files
author
sschwartzman
committed
Added proxy obfuscation to pluginctl.sh, refined README
1 parent 3b3635e commit d666794

3 files changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,13 +99,20 @@ For additional security, this integration supports the using obfuscated values f
9999

100100
1. Prerequesite: [New Relic CLI is installed](https://github.com/newrelic/newrelic-cli#installation) on any supported platform.
101101
* **NOTE**: It does NOT need to be installed on the same host as the Unix Monitor. It is only used to generate the obfuscated keys, this integration handles deobfuscation independently.
102+
102103
2. Generate your obfuscated credentials using the following CLI command:
103104
```
104-
newrelic agent config obfuscate --key OBSCURING_KEY --value "CLEAR_TEXT_PROXY_PASSWORD"
105+
newrelic agent config obfuscate --key "OBSCURING_KEY" --value "CLEAR_TEXT_PROXY_PASSWORD"
106+
```
107+
In this command, `OBSCURING_KEY` can be any value you want. You can even point it at an existing environment variable. Examples:
105108
```
106-
The obscuring key may also be configured by setting the `NEW_RELIC_CONFIG_OBSCURING_KEY` environment variable.
109+
newrelic agent config obfuscate --key "IUsedS0methingRand0m!" --value "proxyPassword2020!"
110+
newrelic agent config obfuscate --key ${NEW_RELIC_CONFIG_OBSCURING_KEY} --value ${OUR_PROXY_PASSWORD}
111+
```
112+
113+
3. In the `proxy` object in `plugin.json`, populate the `proxy_username_obfuscated` and `proxy_password_obfuscated` attributes with the values returned by the CLI.
107114

108-
3. In the `proxy` object, populate the `proxy_username_obfuscated` and `proxy_password_obfuscated` attributes with the values returned by the CLI.
115+
4. In `pluginctl.sh`, uncomment the `NEW_RELIC_CONFIG_OBSCURING_KEY` variable, and set it to the same value or envrionment variable as you used in step 2 for `OBSCURING_KEY`.
109116

110117
### Dashboard deployment
111118

pluginctl.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ DELETE_LOGS_ON_STARTUP=true
3333
# OSX / MACOS:
3434
# PLUGIN_JAVA=/Library/Java/JavaVirtualMachines/<version>/Contents/Commands/java
3535

36+
#
37+
# Set to the value of your obfuscation key
38+
# Either directly as the key, or indirectly as another environment variable
39+
# NEW_RELIC_CONFIG_OBSCURING_KEY=your_key_or_envvar_here
40+
3641
### Do not change these unless instructed! ###
3742

3843
PLUGIN_NAME="New Relic Unix Monitor"

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<modelVersion>4.0.0</modelVersion>
44
<groupId>com.newrelic.experts</groupId>
55
<artifactId>newrelic-unix-monitor</artifactId>
6-
<version>0.2.0</version>
6+
<version>0.2.1</version>
77
<name>newrelic-unix-monitor</name>
88
<build>
99
<plugins>

0 commit comments

Comments
 (0)