Skip to content

Commit a398cf6

Browse files
committed
Delete temporary docs and refer to official docs site
1 parent 23780e3 commit a398cf6

File tree

1 file changed

+12
-120
lines changed

1 file changed

+12
-120
lines changed

README.md

Lines changed: 12 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# secureCodeBox – v2
1+
# OWASP secureCodeBox
22

33
<p align="center">
44
<img alt="secureCodeBox Logo" src="./docs/resources/securecodebox-logo.svg" width="500px">
@@ -27,29 +27,15 @@ _The major release of SCB version 2.0 will be available in the next weeks._ The
2727

2828
<!-- toc -->
2929

30-
- [secureCodeBox – v2](#securecodebox--v2)
31-
- [Overview](#overview)
32-
- [Purpose of this Project](#purpose-of-this-project)
33-
- [Quickstart](#quickstart)
34-
- [Prerequisites](#prerequisites)
35-
- [Deployment (based on Helm)](#deployment-based-on-helm)
36-
- [Examples](#examples)
37-
- [Local Scan Examples](#local-scan-examples)
38-
- [Public Scan Examples](#public-scan-examples)
39-
- [Then get the current State of the Scan by running:](#then-get-the-current-state-of-the-scan-by-running)
40-
- [To delete a scan, use `kubectl delete`, e.g. for localhost nmap scan:](#to-delete-a-scan-use-kubectl-delete-eg-for-localhost-nmap-scan)
41-
- [Access Services](#access-services)
42-
- [How does it work?](#how-does-it-work)
43-
- [Architecture](#architecture)
44-
- [License](#license)
45-
- [Community](#community)
46-
- [Contributing](#contributing)
47-
- [Author Information](#author-information)
48-
49-
For additional documentation aspects please have a look at our:
50-
51-
- [User Guide](docs/user-guide/README.md)
52-
- [Developer Guide](docs/developer-guide/README.md)
30+
- [Purpose of this Project](#purpose-of-this-project)
31+
- [Quickstart](#quickstart)
32+
- [Architecture Overview](#architecture-overview)
33+
- [License](#license)
34+
- [Community](#community)
35+
- [Contributing](#contributing)
36+
- [Author Information](#author-information)
37+
38+
For additional documentation aspects please have a look at our [documentation website](https://docs.securecodebox.io):
5339

5440
<!-- tocstop -->
5541

@@ -72,103 +58,9 @@ There is a German article about [Security DevOps – Angreifern (immer) einen Sc
7258

7359
## Quickstart
7460

75-
### Prerequisites
76-
77-
- kubernetes (last 4 major releases supported: `1.16`, `1.17`, `1.18` & `1.19`)
78-
79-
### Deployment (based on Helm)
80-
81-
> The install instructions require you to have the repository cloned and to have your terminal located in the folder of repository.
82-
> There are shorthand scripts to un-/install everything in the `bin` directory.
83-
84-
Deploy the secureCodeBox operator first:
85-
86-
```bash
87-
kubectl create namespace securecodebox-system
88-
helm -n securecodebox-system upgrade --install securecodebox-operator ./operator/
89-
```
90-
91-
Optionally deploy SCB scanner charts for each security scanner you want to use. They should not be installed into the `securecodebox-system` like the operator so that different teams can use different kinds of scanners.
92-
93-
```bash
94-
helm upgrade --install amass ./scanners/amass/
95-
helm upgrade --install kube-hunter ./scanners/kube-hunter/
96-
helm upgrade --install nikto ./scanners/nikto
97-
helm upgrade --install nmap ./scanners/nmap/
98-
helm upgrade --install ssh-scan ./scanners/ssh_scan/
99-
helm upgrade --install sslyze ./scanners/sslyze/
100-
helm upgrade --install trivy ./scanners/trivy/
101-
helm upgrade --install zap ./scanners/zap/
102-
helm upgrade --install wpscan ./scanners/wpscan/
103-
```
104-
105-
Optional deploy some demo apps for scanning:
106-
107-
```bash
108-
helm upgrade --install dummy-ssh ./demo-apps/dummy-ssh/
109-
helm upgrade --install bodgeit ./demo-apps/bodgeit/
110-
helm upgrade --install juice-shop ./demo-apps/juice-shop/
111-
helm upgrade --install old-wordpress ./demo-apps/old-wordpress/
112-
helm upgrade --install swagger-petstore ./demo-apps/swagger-petstore/
113-
```
114-
115-
Deploy secureCodeBox Hooks:
116-
117-
```bash
118-
helm upgrade --install ufh ./hooks/update-field/
119-
helm upgrade --install gwh ./hooks/generic-webhook/
120-
helm upgrade --install dssh ./hooks/declarative-subsequent-scans/
121-
```
122-
123-
Persistence provider Elasticsearch:
124-
125-
```bash
126-
helm upgrade --install elkh ./hooks/persistence-elastic/
127-
```
128-
129-
### Examples
130-
131-
Now everything is installed. You can try deploying scans from the `scanners/*/examples` directories.
132-
133-
#### Local Scan Examples
134-
135-
E.g. localhost nmap scan:
136-
137-
```bash
138-
kubectl apply -f scanners/nmap/examples/localhost/scan.yaml
139-
```
140-
141-
#### Public Scan Examples
142-
143-
```bash
144-
kubectl apply -f scanners/nmap/examples/scan.nmap.org/scan.yaml
145-
```
146-
147-
#### Then get the current State of the Scan by running:
148-
149-
```bash
150-
kubectl get scans
151-
```
152-
153-
#### To delete a scan, use `kubectl delete`, e.g. for localhost nmap scan:
154-
155-
```
156-
kubectl delete -f scanners/nmap/examples/localhost/scan.yaml
157-
```
158-
159-
### Access Services
160-
161-
- Minio UI:
162-
- Port Forward Minio UI: `kubectl port-forward -n securecodebox-system service/securecodebox-operator-minio 9000:9000`
163-
- AccessKey: `kubectl get secret securecodebox-operator-minio -n securecodebox-system -o=jsonpath='{.data.accesskey}' | base64 --decode; echo`
164-
- SecretKey: `kubectl get secret securecodebox-operator-minio -n securecodebox-system -o=jsonpath='{.data.secretkey}' | base64 --decode; echo`
165-
- Elastic / Kibana UI:
166-
- Port Forward Kibana: `kubectl port-forward -n default service/elkh-kibana 5601:5601`
167-
- Port Forward Elasticsearch: `kubectl port-forward -n default service/elasticsearch-master 9200:9200`
168-
169-
## How does it work?
61+
You can find resources to help you get started on our [documentation website](https://docs.securecodebox.io) including instruction on how to [install the secureCodeBox](https://docs.securecodebox.io/docs/getting-started/installation) and guides to help you [run your first scans](https://docs.securecodebox.io/docs/getting-started/first-scans) with it.
17062

171-
## Architecture
63+
## Architecture Overview
17264

17365
![secureCodeBox Architecture](./docs/resources/scb-architecture.svg)
17466

0 commit comments

Comments
 (0)