Skip to content

Commit

Permalink
Revert " "Updated the installation procedure for IAST""
Browse files Browse the repository at this point in the history
This reverts commit d8ae25b.
  • Loading branch information
newrelic707195 committed Oct 28, 2024
1 parent d8ae25b commit 5833eea
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 33 deletions.
103 changes: 70 additions & 33 deletions src/content/docs/iast/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,10 @@ freshnessValidatedDate: never
---

<Callout variant="important">
Run IAST with non-production deployments only. IAST tests by invoking HTTP requests with an exploit payload. You must use IAST in non-production environments with only simulated data to avoid both data corruption and introducing exploits into your live code. In addition, when you run IAST on new code in pre-production, you catch potential vulnerabilities before they go live.
Run IAST with non-production deployments only. IAST tests the application by invoking HTTP requests with an exploit payload. You must use IAST in non-production environments with only simulated data to avoid both data corruption and introducing exploits into your live code. In addition, when you run IAST on new code in pre-production, you catch potential vulnerabilities before they go live.

Check notice on line 12 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L12

[Microsoft.Wordiness] Consider using 'also' instead of 'In addition'.
Raw output
{"message": "[Microsoft.Wordiness] Consider using 'also' instead of 'In addition'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 12, "column": 278}}}, "severity": "INFO"}
</Callout>

To install New Relic IAST:

<Steps>
<Step>
Go to <DNT>**[one.newrelic.com](https://one.newrelic.com) > All capabilities > IAST**</DNT> and click <DNT>**Set up IAST with applications**</DNT>.

<img
title="Set up IAST with applications"
alt="Set up IAST with applications"
src="/images/iast_screenshot-full_install.webp"
/>
</Step>

<Step>
Confirm IAST isn't running in a production environment and click <DNT>**Continue**</DNT>.

</Step>

<Step>
Select the language of your application and complete the steps.

<img
title="Install New Relic IAST"
alt="Install New Relic IAST"
src="/images/iast_screenshot-crop_install.webp"
/>
</Step>

<Step>
## Configuration File Settings
Make sure your `newrelic.yml` config file is updated as follows:

<CollapserGroup>
Expand Down Expand Up @@ -82,20 +54,85 @@ To install New Relic IAST:
```
</Collapser>
</CollapserGroup>


To install New Relic IAST:

<Steps>
<Step>
Go to <DNT>**[one.newrelic.com](https://one.newrelic.com) > All capabilities > IAST** </DNT> and click <DNT>**Install**</DNT>.

<img
title="Set up IAST with applications"
alt="Set up IAST with applications"
src="/images/iast_screenshot-full_install.webp"
/>
</Step>

<Step>
Make sure IAST should not be run in production environment and click <DNT>**Continue**</DNT>.

Check failure on line 73 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L73

[Microsoft.Contractions] Use 'shouldn't' instead of 'should not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'shouldn't' instead of 'should not'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 73, "column": 20}}}, "severity": "ERROR"}

Check notice on line 73 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L73

[Microsoft.Passive] 'be run' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be run' looks like passive voice.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 73, "column": 31}}}, "severity": "INFO"}
<img
title="IAST Install Instruction Screen"
alt="IAST Installation Instruction Screen"
src="/images/iast-install-steps.webp"
/>

</Step>

<Step>
Select the language of your application and complete the steps. The application languages supported are: Java, Node, and Go.
<img
title="Install New Relic IAST"
alt="Install New Relic IAST"
src="/images/iast_screenshot-crop_install.webp"
/>
</Step>

<Step>
Once you've completed all the steps, restart your application and generate traffic against the application's APIs.
Once you select the application language, make sure to follow the on-screen instructions and must watch the [relevant application language video](/docs/iast/install/#check-out-these-demo-videos-for-setting-up-iast-with-different-application-languages) for successful installation of IAST.

Check notice on line 92 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L92

[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).
Raw output
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 92, "column": 5}}}, "severity": "INFO"}

<Callout variant="caution">
- You may encounter error if on-screen instructions are not followed properly.

Check notice on line 95 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L95

[new-relic.ComplexWords] Consider using 'meet' instead of 'encounter'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'meet' instead of 'encounter'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 95, "column": 13}}}, "severity": "INFO"}

Check failure on line 95 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L95

[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 95, "column": 55}}}, "severity": "ERROR"}

Check notice on line 95 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L95

[new-relic.Adverbs] Consider removing 'properly'.
Raw output
{"message": "[new-relic.Adverbs] Consider removing 'properly'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 95, "column": 72}}}, "severity": "INFO"}
- You may not be able to generate the traffic for your application if the video instructions for your **selected application language** are not followed.

Check failure on line 96 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L96

[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 96, "column": 139}}}, "severity": "ERROR"}
</Callout>

> The below screen has been shown for Java Application language selected.

Click on the **Next** to complete the steps further.


<img
title="Install New Relic IAST"
alt="Install New Relic IAST"
src="/images/iast-install-java.webp"
/>

</Step>

<Step>
Follow the steps and on-screen instructions as per your screen.

Check notice on line 113 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L113

[Microsoft.Wordiness] Consider using 'per' instead of 'as per'.
Raw output
{"message": "[Microsoft.Wordiness] Consider using 'per' instead of 'as per'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 113, "column": 49}}}, "severity": "INFO"}

Click <DNT>**See your data**</DNT> to see an overview of your tested application.
<img
title="Install New Relic IAST"
alt="New Relic IAST on-screen instructions"
src="/images/iast-see-your-data-button.webp"
/>

</Step>

<Step>
Click <DNT>**See your data**</DNT> to see an overview of your tested application.
The below screen will show IAST test results as per your configurations.

Check notice on line 125 in src/content/docs/iast/install.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/iast/install.mdx#L125

[Microsoft.Wordiness] Consider using 'per' instead of 'as per'.
Raw output
{"message": "[Microsoft.Wordiness] Consider using 'per' instead of 'as per'.", "location": {"path": "src/content/docs/iast/install.mdx", "range": {"start": {"line": 125, "column": 50}}}, "severity": "INFO"}
<img
title="Install New Relic IAST"
alt="New Relic IAST See your data tab"
src="/images/iast-see-your-data.webp"
/>

</Step>
</Steps>

For more detailed instructions, check out these examples demo below.
## Check out these demo videos for setting up IAST with different application languages

<CollapserGroup>
<Collapser
Expand Down
Binary file added static/images/iast-install-java.webp
Binary file not shown.
Binary file added static/images/iast-install-steps.webp
Binary file not shown.
Binary file added static/images/iast-see-your-data-button.webp
Binary file not shown.
Binary file added static/images/iast-see-your-data.webp
Binary file not shown.

0 comments on commit 5833eea

Please sign in to comment.