Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,6 @@ public void generateDocs() throws IOException, TemplateException, IntegrationExc
FileUtils.deleteDirectory(outputDir);
troubleshootingDir.mkdirs();

// Metadata that Zoomin needs
FileUtils.copyFileToDirectory(new File(docsProjectDir, "custom.properties"), outputDir);
FileUtils.copyFileToDirectory(new File(docsProjectDir, "classification.xml"), outputDir);

File templatesDir = new File(docsSrcMainResourcesDir, "templates");
TemplateProvider templateProvider = new TemplateProvider(templatesDir, docsProject.getVersion().toString());

Expand All @@ -80,8 +76,7 @@ public void generateDocs() throws IOException, TemplateException, IntegrationExc
FileUtils.copyDirectory(sourceMarkdownDir, outputDir);
createMarkdownFromFreemarker(templateProvider, troubleshootingDir, "exit-codes", new ExitCodePage(helpJson.getExitCodes()));
createMarkdownFromFreemarker(templateProvider, runningDir, "status-file", new DetectorStatusCodes(helpJson.getDetectorStatusCodes()));
// Commenting out in 9.4 to manually create detectors table
// handleDetectors(templateProvider, outputDir, helpJson);

handleProperties(templateProvider, outputDir, helpJson);
createFromFreemarker(templateProvider, "downloadlocations.ftl", new File(installDir, "downloadlocations.md"));
}
Expand All @@ -101,33 +96,6 @@ private void createFromFreemarker(TemplateProvider templateProvider, String temp
template.process(data, writer);
}
}
// Commenting out in 9.4 to manually create detectors table
/* private void handleDetectors(TemplateProvider templateProvider, File baseOutputDir, HelpJsonData helpJson) throws IOException, TemplateException {
File outputDir = new File(baseOutputDir, "components");
List<DetectorType> detectorTypes = new ArrayList<>();
helpJson.getDetectors().stream()
.sorted(Comparator.comparing(HelpJsonDetectorRule::getDetectorType))
.forEach(detectorRule -> {
List<DetectorEntryPoint> entryPointsForRule = new ArrayList<>();
detectorRule.getEntryPoints().forEach(entry -> {
List<Detectable> detectables = entry.getDetectables().stream()
.map(detectable -> new Detectable(
detectable.getDetectableName(),
detectable.getDetectableLanguage(),
detectable.getDetectableForge(),
detectable.getDetectableRequirementsMarkdown(),
detectable.getDetectableAccuracy()
))
.collect(Collectors.toList());
DetectorEntryPoint entryPoint = new DetectorEntryPoint(entry.getName(), detectables);
entryPointsForRule.add(entryPoint);
});
DetectorType detectorType = new DetectorType(detectorRule.getDetectorType(), entryPointsForRule);
detectorTypes.add(detectorType);
});

createMarkdownFromFreemarker(templateProvider, outputDir, "detectors", new DetectorCascadePage(detectorTypes));
} */

private String encodePropertyLocation(String propertyName) {
if (!propertyName.equals(propertyName.trim())) {
Expand Down
21 changes: 21 additions & 0 deletions documentation/FluidTopicsControlFile.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<controlFile>
<resources>
<resource>
<filePath>detect.ditamap</filePath>
<originId>bd_detect-latest</originId>
<clusterId>bd_detect</clusterId>
<metas>
<meta key="Product">
<value>detect</value>
</meta>
<meta key="Version">
<value>latest</value>
</meta>
<meta key="Access">
<value>access_all</value>
</meta>
</metas>
</resource>
</resources>
</controlFile>
82 changes: 0 additions & 82 deletions documentation/classification.xml

This file was deleted.

3 changes: 0 additions & 3 deletions documentation/custom.properties

This file was deleted.

4 changes: 2 additions & 2 deletions documentation/keywords.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
<keydef keys="var_bu_name"><topicmeta><keywords><keyword>Black Duck</keyword></keywords></topicmeta></keydef>
<keydef keys="binary_repo_type"><topicmeta><keywords><keyword>Artifactory</keyword></keywords></topicmeta></keydef>
<keydef keys="source_project_name"><topicmeta><keywords><keyword>blackduck-detect</keyword></keywords></topicmeta></keydef>
<keydef keys="bash_script_name"><topicmeta><keywords><keyword>detect11.sh</keyword></keywords></topicmeta></keydef>
<keydef keys="powershell_script_name"><topicmeta><keywords><keyword>detect11.ps1</keyword></keywords></topicmeta></keydef>
<keydef keys="bash_script_name"><topicmeta><keywords><keyword>detect12.sh</keyword></keywords></topicmeta></keydef>
<keydef keys="powershell_script_name"><topicmeta><keywords><keyword>detect12.ps1</keyword></keywords></topicmeta></keydef>
<keydef keys="blackduck_signature_scanner_name"><topicmeta><keywords><keyword>Black Duck Signature Scanner</keyword></keywords></topicmeta></keydef>
<keydef keys="blackduck_signature_scan_act"><topicmeta><keywords><keyword>Black Duck signature scan</keyword></keywords></topicmeta></keydef>
<keydef keys="dockerinspector_name"><topicmeta><keywords><keyword>Black Duck Docker Inspector</keyword></keywords></topicmeta></keydef>
Expand Down
Empty file modified documentation/scripts/checkSize.sh
100755 → 100644
Empty file.
Empty file modified documentation/scripts/diff_doc.sh
100755 → 100644
Empty file.
Empty file modified documentation/scripts/findOrphans.sh
100755 → 100644
Empty file.
Empty file modified documentation/scripts/ftl2md.sh
100755 → 100644
Empty file.
2 changes: 1 addition & 1 deletion documentation/src/main/markdown/configuring/commandline.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ There is a space before and between each complete property setting, but there ar
For example,
to set property *detect.project.name*:
```
bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.name=MyProject
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=MyProject
```
2 changes: 1 addition & 1 deletion documentation/src/main/markdown/configuring/configfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For example, if you wanted to set property *detect.project.name* using a configu
could do it as follows:
````
echo "detect.project.name=myproject" > application.properties
bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.source.path=/opt/projects/project1
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.source.path=/opt/projects/project1
````
Because the configuration file has one of the file names that Spring looks for by default
(in this case, application.properties) and exists in one of the locations
Expand Down
4 changes: 2 additions & 2 deletions documentation/src/main/markdown/configuring/envvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ is the property name converted to uppercase, with period characters (".") conver
characters ("_"). For example:
```
export DETECT_PROJECT_NAME=MyProject
bash <(curl -s -L https://detect.blackduck.com/detect11.sh)
bash <(curl -s -L https://detect.blackduck.com/detect12.sh)
```

On Windows, the environment variable name can either be the original property
name, or the property name converted to uppercase with period characters (".") converted to underscore
characters ("_"). For example:
```
$Env:DETECT_PROJECT_NAME = MyProject
powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect"
powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect"
```
2 changes: 1 addition & 1 deletion documentation/src/main/markdown/configuring/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Populate it with property assignments as previously described.
To select one or more profiles on the [detect_product_short] command line, assign the the comma-separated list of profiles
to the Spring Boot property *spring.profiles.active*:
```
bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --spring.profiles.active={profilename}
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --spring.profiles.active={profilename}
```

This capability is provided by Spring Boot. For more information, refer to
Expand Down
2 changes: 0 additions & 2 deletions documentation/src/main/markdown/currentreleasenotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

**Notices**

[company_name] [solution_name] has been renamed [detect_product_long] with page links, documentation, and other URLs updated accordingly. Update any [detect_product_short] documentation, or other bookmarks you may have. See the [Domain Change FAQ](https://community.blackduck.com/s/article/Black-Duck-Domain-Change-FAQ).
* Please make use of repo.blackduck.com and detect.blackduck.com for code downloads.
* [detect_product_short] script downloads should only be accessed via detect.blackduck.com.
* [detect_product_short] 10.0.0 and later will only work when using repo.blackduck.com.
* If you are using [detect_product_short] 8 or 9 it is essential to update to 8.11.2 or 9.10.1 respectively.

* [bd_product_long] [SCA Scan Service (SCASS)](https://community.blackduck.com/s/question/0D5Uh00000O2ZSYKA3/black-duck-sca-new-ip-address-requirements-for-2025) requires customers add or update IP addresses configured in their network firewalls or allow lists. This action is required to successfully route scan data to the service for processing.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
The Self Update feature will call the `/api/tools/detect` API end point to check for the existence of a specified [detect_product_short] version in [bd_product_short] under the **Admin > System Settings > [detect_product_short] > [detect_product_short] Version** drop-down. If a version that is eligible for upgrade or downgrade has been specified, the request to download that version of the [detect_product_short] .jar will execute and the current run of [detect_product_short] will invoke it for the requested scan.

[detect_product_short] will download the required version from the repository when the service is hosted, or from a custom URL as configured in [bd_product_short], when internally hosted. To support self-update via internal hosting, the [detect_product_short] binary must be in a location accessible via https to all executing [detect_product_short] instances.
Centralized [detect_product_short] Version Management feature support in [bd_product_short] is available from [bd_product_short] version 2023.4.0 onwards.

<!-- Variables do not resolve when in a note format hence the hardcoding below -->
<note type="information">
Expand All @@ -28,9 +27,7 @@ If the [detect_product_short] URL of the [detect_product_short] .jar file to dow

If the [bd_product_short] “Internally Hosted” option has been selected and a [detect_product_short] download location has not been provided, the feature will not be enabled.

For further [bd_product_short] configuration information, refer to the documentation provided under the topic:
<xref href="DetectLocation.dita" scope="peer"> Hosting location for [detect_product_short].
<data name="facets" value="pubname=bd-hub"/>
For further [bd_product_short] configuration information, refer to the documentation provided under the topic: [Hosting location for Detect](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/hosting-location-for-black-duck-detect.html).

## [detect_product_short] log examples for self update

Expand Down
2 changes: 1 addition & 1 deletion documentation/src/main/markdown/gettingstarted/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Before you start using [detect_product_short], it is recommended that you become

For a quick tutorial see: [Introduction to Scanning](https://community.blackduck.com/s/article/Black-Duck-Introduction-to-Scanning).

<note type="note">[detect_product_short] documentation is incremental in nature with new functionality and changes indentified in the [Release notes](../currentreleasenotes.md) and [Properties](../properties/all-properties.md). However, documentation is also available for previous [detect_product_short] versions by navigating to the documentation portal [linked here](https://documentation.blackduck.com/bundle) and clicking on the **Archived** button.</note>
<note type="note">[detect_product_short] documentation is incremental in nature with new functionality and changes indentified in the [Release notes](../currentreleasenotes.md) and [Properties](../properties/all-properties.md). However, documentation is also available for previous [detect_product_short] versions by navigating to the documentation portal [linked here](https://docs.blackduck.com) and selecting one of the hosted document versions from the drop-down when viewing [detect_product_short] documentation.</note>

Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In the junit4 case, [detect_product_short] will:

Once the scan is complete, navigate with your browser to the [bd_product_short] Project BOM URL to see the Bill Of Materials for junit4.

For guidance on getting started using, and viewing results in [bd_product_short], check out [Getting Started with Black Duck SCA](https://documentation.blackduck.com/bundle/bd-hub/page/Administration/Hub101.html)
For guidance on getting started using, and viewing results in [bd_product_short], check out [Getting Started with Black Duck SCA](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/getting-started-with-black-duck-sca.html)

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

* Licensed installation of the current version of [bd_product_short] with access credentials.
Visit the [Black Duck release page](https://github.com/blackducksoftware/hub/releases) to determine the current version of [bd_product_short].
* For information regarding compatible versions of [bd_product_short], consult the [bd_product_short] [Release Compatibility page](https://documentation.blackduck.com/bundle/blackduck-compatibility/page/topics/Black-Duck-Release-Compatibility.html)
* For information regarding compatible versions of [bd_product_short], consult the [bd_product_short] [Release Compatibility page](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/black-duck-sca-release-compatibility.html)
* The [bd_product_short] notifications module must be enabled.
* A [bd_product_short] user with the [required roles](usersandroles.md).
* On Alpine Linux you will also need to override the Java installation used by the [blackduck_signature_scanner_name] as
Expand All @@ -66,5 +66,4 @@ The risk report requires that the following fonts are installed:

## Supported [detect_product_short] versions and Service duration

For information about support and service durations for [detect_product_short] versions, consult the
<xref href="Support-and-Service-Schedule.dita" scope="peer"> Support and Service Schedule.<data name="facets" value="pubname=blackduck-compatibility"/>
For information about support and service durations for [detect_product_short] versions, consult the [Support and Service Schedule](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/product-maintenance-support-and-service-schedule.html).
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Properties in [detect_product_long] provide information used to determine how an
When setting a property value, the property name is prefixed with two hyphens (--).

````
bash <(curl -s -L https://detect.blackduck.com/detect11.sh) <--property=value>
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) <--property=value>
````

Example using properties to specify project name and [bd_product_short] URL:

````
bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.name=MyProject --blackduck.url=https://blackduck.yourdomain.com
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=MyProject --blackduck.url=https://blackduck.yourdomain.com
````

<note type="note">When configuring [detect_product_short] via environment variables or configuration file, specific property handling applies. See [Using environment variables](../../configuring/envvars.md) or [Using a configuration file](../../configuring/configfile.md).</note>
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

Any user can download [detect_product_short] and run a scan, however you must configure a user/API token in [bd_product_short] for the [detect_product_short] scan to be analyzed by [bd_product_short].

For more information on creating a [bd_product_short] user token, please consult the documentation provided by [bd_product_short] under the topic:
<xref href="MyAccessTokens.dita" scope="peer"> Managing user access tokens.
<data name="facets" value="pubname=bd-hub"/></xref>
For more information on creating a [bd_product_short] user token, please consult the documentation provided by [bd_product_short] under the topic: [Managing user access tokens](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/managing-user-access-tokens.html).


**The following user roles are required for the user that you create in [bd_product_short]**
Expand Down
Loading