Skip to content
This repository was archived by the owner on Apr 21, 2026. It is now read-only.

Commit f668ca7

Browse files
committed
Adjust background image to beta alert. Document how to add a scanner. Strip /scanners/ from scanner directory.
1 parent 1454da1 commit f668ca7

3 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Since we work with various different tools, it is even more important to keep a
7777

7878
### Adding a scanner or persistence provider
7979

80-
Scanner and persistence provider are referred as integrations. Scanner, which are integrated into our secureCodeBox project have their own repository in which the main documentation must be written in the README.md. Persistence provider documentation is located at `/src/pages/integrations/persistence-provider/`.
80+
Scanners and persistence providers are referred to as integrations. Scanners, which are integrated into our [secureCodeBox-v2-alpha](https://github.com/secureCodeBox/secureCodeBox-v2-alpha) repository have their own directories (located at [/scanners/](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/tree/master/scanners)) in which the main documentation must be written in a `README.md` file. Persistence provider documentation is located at `/src/pages/integrations/persistence-provider/`.
8181

8282
#### Scanner
8383

@@ -86,7 +86,7 @@ To add a scanner documentation you need to extend the `scannerRepos` Array in th
8686
```bash
8787
{
8888
name: 'scanner name',
89-
url: 'https://github.com/secureCodeBox/scanner_repository',
89+
directory: 'directoryName' # in /scanners/
9090
}
9191
```
9292

@@ -98,11 +98,11 @@ Additionally you can and (for the sake of aesthetics) should provide an icon in
9898
<pre>
9999

100100
---
101+
101102
title: "Scame"
102103
path: "scanner/Scame"
103104
category: "scanner"
104105
usecase: "general use of this scanner"
105-
release: "url to the release badge"
106106

107107
---
108108

gatsby-config.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,39 @@
77
const scannerRepos = [
88
{
99
name: 'Amass',
10-
directory: 'scanners/amass'
10+
directory: 'amass'
1111
},
1212
{
1313
name: 'kube-hunter',
14-
directory: 'scanners/kube-hunter'
14+
directory: 'kube-hunter'
1515
},
1616
{
1717
name: 'Nikto',
18-
directory: 'scanners/nikto'
18+
directory: 'nikto'
1919
},
2020
{
2121
name: 'Nmap',
22-
directory: 'scanners/nmap'
22+
directory: 'nmap'
2323
},
2424
{
2525
name: 'SSH',
26-
directory: 'scanners/ssh_scan'
26+
directory: 'ssh_scan'
2727
},
2828
{
2929
name: 'SSLyze',
30-
directory: 'scanners/sslyze'
30+
directory: 'sslyze'
3131
},
3232
{
3333
name: 'Trivy',
34-
directory: 'scanners/trivy'
34+
directory: 'trivy'
3535
},
3636
{
3737
name: 'WPScan',
38-
directory: 'scanners/wpscan'
38+
directory: 'wpscan'
3939
},
4040
{
4141
name: 'ZAP',
42-
directory: 'scanners/zap'
42+
directory: 'zap'
4343
}
4444
];
4545

@@ -140,7 +140,7 @@ module.exports = {
140140
name: name,
141141
remote: `https://github.com/secureCodeBox/secureCodeBox-v2-alpha`,
142142
branch: `master`,
143-
patterns: `${directory}/README.md`,
143+
patterns: `scanners/${directory}/README.md`,
144144
},
145145
};
146146
}),

src/scss/pages/_home.scss

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
background-image: url('../images/macbook_kibana_klein.png');
44
background-repeat: no-repeat;
55
background-size: 115%;
6-
background-position: 49px -40px;
6+
background-position: 49px 40px;
77
@include media-breakpoint-up(sm) {
88
background-size: 50%;
9-
background-position: 300px 50px;
9+
background-position: 300px 130px;
1010
}
1111
@include media-breakpoint-up(md) {
1212
background-size: 70%;
13-
background-position: 100% -100px;
13+
background-position: 100% -20px;
1414
}
1515
@include media-breakpoint-up(lg) {
1616
background-size: 55%;

0 commit comments

Comments
 (0)