Skip to content

Commit

Permalink
Merge pull request #3706 from mercedes-benz/feature-3001-content-upda…
Browse files Browse the repository at this point in the history
…te-sechub-website

Feature 3001 content update sechub website #3001
  • Loading branch information
sven-dmlr authored Dec 6, 2024
2 parents e1510aa + 8355604 commit cba92d4
Show file tree
Hide file tree
Showing 9 changed files with 219 additions and 201 deletions.
41 changes: 24 additions & 17 deletions sechub-doc/src/docs/asciidoc/sechub-getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -186,34 +186,32 @@ Setup of GoSec complete:
Now you are ready to do scans!
== Scan using SecHub client
=== Install SecHub client
The SecHub client is needed to scan. In later sections of this guide, the client is used to scan an example. The command below, will download the latest version and put it in your `/usr/local/bin` folder.
== Scan using SecHub Client
=== Install SecHub Client
The SecHub Client is needed to scan. In later sections of this guide, the client is used to scan an example.
The command below, will download the latest version and put it in your `/usr/local/bin` folder.
[source, bash]
--
# Get latest version
CLIENT_VERSION=`curl -s https://mercedes-benz.github.io/sechub/latest/client-download.html | grep https://github.com/mercedes-benz/sechub/ | awk -F '-' '{print $NF}' | sed 's/.zip">//'`
# Download the zipped binary
curl -L -o sechub-cli.zip https://github.com/mercedes-benz/sechub/releases/download/v$CLIENT_VERSION-client/sechub-cli-$CLIENT_VERSION.zip
wget https://github.com/mercedes-benz/sechub/releases/download/v$CLIENT_VERSION-client/sechub-cli-$CLIENT_VERSION.zip
# Verify the binary
curl -L -o sechub-cli.zip.sha256 https://github.com/mercedes-benz/sechub/releases/download/v$CLIENT_VERSION-client/sechub-cli-$CLIENT_VERSION.zip.sha256
sha256sum --check sechub-cli.zip.sha256
wget https://github.com/mercedes-benz/sechub/releases/download/v$CLIENT_VERSION-client/sechub-cli-$CLIENT_VERSION.zip.sha256
sha256sum --check sechub-cli-$CLIENT_VERSION.zip.sha256
# Extract
unzip sechub-cli.zip
unzip sechub-cli-$CLIENT_VERSION.zip
# Depending on your architecture and OS, you will have to copy a different binary file:
# For linux x86-64
# Example for Linux x86-64
sudo cp platform/linux-amd64/sechub /usr/local/bin
# For linux arm-64
sudo cp platform/linux-arm64/sechub /usr/local/bin
# Cleanup
rm -rf sechub-cli.zip.sha256 sechub-cli.zip platform/
rm -rf sechub-cli-$CLIENT_VERSION.zip sechub-cli-$CLIENT_VERSION.zip.sha256 platform/
--
=== Scan
Expand Down Expand Up @@ -249,10 +247,19 @@ Now you can do a scan, type `sechub scan`, this will create a file which contain
If you want the report in HTML format instead, add `-reportformat html` as an option: `sechub -reportformat html scan`
== Optional
=== Install SecHub's VSCodium Plugin (OPTIONAL)
SecHub's VSCodium Plugin helps you to work faster with the SecHub report.
You can go to the exact code line and fix the problem.
=== SecHub's IDE plugins
SecHub's IDE plugins help you to work faster with the SecHub report.
You can jump to the exact code lines and fix the problem.
==== Eclipse Plugin
You can get the SecHub plugin the usual way from the https://marketplace.eclipse.org/content/sechub[Eclipse Marketplace].
==== IntelliJ Plugin
You can get the SecHub plugin the usual way from the https://plugins.jetbrains.com/plugin/23379-sechub[IntelliJ Marketplace].
==== VS-Codium / Visual Studio Code Plugin
You can get the plugin from the https://open-vsx.org/extension/mercedes-benz/sechub[OpenVSX Registry].
You can get the plugin from https://open-vsx.org/extension/mercedes-benz/sechub[here].
To install it, search for `sechub` in the Extensions manager and choose the one from "mercedes-benz".
And to install it, open VSCodium and in the `Command Palette` (Usually can be opened with `Ctrl+Shift+P`) type `install vsix`, and in the pop-up menu, choose the plugin.
For Visual Studio Code users: Download the Plugin and install it manually from file.
40 changes: 0 additions & 40 deletions sechub-website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,69 +8,29 @@ Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introdu
Make sure to install the dependencies:

```bash
# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install
```

## Development Server

Start the development server on `http://localhost:3000`:

```bash
# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev
```

## Production

Build the application for production:

```bash
# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

# bun
bun run build
```

Locally preview production build:

```bash
# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

# bun
bun run preview
```

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
2 changes: 1 addition & 1 deletion sechub-website/components/Footer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</div>
</div>

<p class="mt-6 text-sm text-gray-500">© Copyright {{ new Date().getFullYear() }}. All rights reserved.</p>
<p class="mt-6 text-sm text-gray-500">© {{ new Date().getFullYear() }} Mercedes-Benz Tech Innovation GmbH - <a href="https://www.mercedes-benz-techinnovation.com/en/imprint/">Impressum</a>.</p>
</div>
<NuxtLink
class="group relative -mx-4 flex items-center self-stretch p-4 transition-colors hover:bg-gray-100 sm:self-auto sm:rounded-2xl lg:mx-0 lg:self-auto lg:p-6"
Expand Down
24 changes: 12 additions & 12 deletions sechub-website/components/Header.vue
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,32 @@ const documentationItems = [
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-getting-started.html'
},
{
title: 'Architecture',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-architecture.html'
},
{
title: 'Technical',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-techdoc.html'
title: 'Client',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-client.html'
},
{
title: 'Rest API',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-restapi.html'
},
{
title: 'Client',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-client.html'
title: 'Product Delegation Server (PDS)',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-product-delegation-server.html'
},
{
title: 'Operations',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-operations.html'
},
{
title: 'Product Delegation Server (PDS)',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-product-delegation-server.html'
},
{
title: 'Developer - Quickstart Guide',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-developer-quickstart-guide.html'
},
{
title: 'Developer - Architecture',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-architecture.html'
},
{
title: 'Developer - Technical',
href: 'https://mercedes-benz.github.io/sechub/latest/sechub-techdoc.html'
}
];

Expand Down
7 changes: 5 additions & 2 deletions sechub-website/components/home/Download.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ const links = [
{
name: 'Product Delegation Server',
href: 'https://mercedes-benz.github.io/sechub/latest/pds-download.html'
},
{
name: 'Kubernetes Images and Charts',
href: 'https://github.com/mercedes-benz/sechub/packages'
}
];
</script>
Expand All @@ -27,8 +31,7 @@ const links = [
<div class="mx-auto max-w-md sm:text-center">
<h2 class="text-3xl font-medium tracking-tight text-gray-900 sm:text-4xl">Start Using Today!</h2>
<p class="mt-4 text-lg text-gray-700">
Download SecHub for seamless security integration. Orchestrates tools through a unified API. Scan
synchronously, break build pipelines. MIT License.
Download SecHub for seamless security integration.<br>Orchestrates security tools through an unified API.<br>MIT License.
</p>

<Menu as="div" class="relative mt-8 inline-block text-left">
Expand Down
22 changes: 11 additions & 11 deletions sechub-website/components/home/Features.vue
Original file line number Diff line number Diff line change
Expand Up @@ -13,37 +13,37 @@ const items = [
{
title: 'API Orchestration',
description:
'SecHub orchestrates tools via a unified API, simplifying integration for projects and build pipelines without the need for multiple plugins.',
'SecHub orchestrates tools via an unified API, simplifying integration for projects without the need for different vendor plugins.',
icon: ServerStackIcon
},
{
title: 'Build Pipeline Integration',
title: 'Easy to use Client',
description:
'SecHub client, in Go, scans synchronously, interrupting build pipelines if needed. Easily integrates into any build system for robust security.',
'The SecHub client is written in Go and easy to use on your system of choice.',
icon: PuzzlePieceIcon
},
{
title: 'License Flexibility',
description:
'SecHub is MIT licensed, allowing flexible usage, modification, and distribution, fostering collaboration and adoption across diverse projects.',
'SecHub is MIT licensed. This ensures freedom in use, modification and distribution, fostering collaboration and adoption across all kind of projects.',
icon: CheckBadgeIcon
},
{
title: 'Comprehensive Documentation',
description:
'Extensive Asciidoc-format documentation covers Quickstart, Architecture, RestAPI, and more. Available on our documentation.',
'Extensive documentation covers Getting Started, Architecture, Client, RestAPI, Operations and more. Available on our documentation.',
icon: BookOpenIcon
},
{
title: 'Integration with Build Systems',
title: 'Integration with Build Systems and IDEs',
description:
'Seamless integration of SecHub client with every build system simplifies developer workflows, reinforcing security measures without additional complexity.',
'Seamless integration with every build system and multiple developer IDEs adds security to your code without additional complexity.',
icon: WrenchScrewdriverIcon
},
{
title: 'Product Delegation Server (PDS)',
description:
"Explore SecHub's PDS, a vital component providing insights into architecture and functionality, enhancing understanding of the overall security infrastructure.",
"Explore SecHub's PDS, a vital component providing you the choice of many existing securtiy tools for use with SecHub. It also allows an easy integration of new securtiy tools.",
icon: CpuChipIcon
}
];
Expand All @@ -55,10 +55,10 @@ const items = [
<div class="mx-auto max-w-2xl sm:text-center">
<h2 class="text-3xl font-medium tracking-tight text-white">Your Security Guardian.</h2>
<p class="mt-2 text-lg text-white">
SecHub server orchestrates different security tools by one API layer.
SecHub orchestrates different security tools by one API layer.
<br />
Users interact with the SecHub Server, eliminating the need for projects/build pipelines to implement various
plugins.
Users interact with the SecHub Server, eliminating the need for projects to integrate
vendor plugins for each security tool.
</p>
</div>

Expand Down
19 changes: 13 additions & 6 deletions sechub-website/components/home/Hero.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,26 @@ import { PlayIcon } from '@heroicons/vue/20/solid';
<template>
<section class="overflow-hidden pt-16 lg:pb-32 xl:pb-36">
<div class="container">
<div class="lg:grid lg:grid-cols-12 lg:gap-x-8 lg:gap-y-20">
<div class="lg:grid lg:grid-cols-12 lg:gap-x-8 lg:gap-y-0">
<div class="relative z-10 mx-auto max-w-2xl lg:col-span-7 lg:max-w-none lg:pt-6 xl:col-span-6">
<h1 class="text-4xl font-medium tracking-tight text-gray-900">SecHub Tool</h1>
<h1 class="text-4xl font-medium tracking-tight text-gray-900">SecHub - One API to secure them all</h1>
<p class="mt-6 text-lg text-gray-600">
The free and open-source security platform SecHub, provides a central API to test software with different
security tools. SecHub supports many free and open-source as well as proprietary security tools.
security tools.
</p>
<div class="mt-8 flex flex-wrap gap-x-6 gap-y-4">
<NuxtLink class="button is-outlined !w-auto" to="https://www.youtube.com/">
<!-- Activate next block after Video has been updated -->
<!--div class="mt-8 flex flex-wrap gap-x-6 gap-y-4">
<NuxtLink class="button is-outlined !w-auto" to="https://www.youtube.com/watch?v=W0IRX4glrT0">
<PlayIcon class="size-4 flex-none" />
<span class="ml-2">See in action</span>
</NuxtLink>
</div>
</div-->
<p class="mt-6 text-lg text-gray-600">
SecHub supports many free and open-source as well as proprietary security tools covering
SAST (Static Application Security Testing),
DAST (Dynamic Application Security Testing),
Secret scanners, Infrastructure scanners, License scanners and more…
</p>
</div>
<div class="relative mt-10 sm:mt-20 lg:col-span-5 lg:row-span-2 lg:mt-0 xl:col-span-6">
<AbstractDoubleCircularAnimation />
Expand Down
6 changes: 3 additions & 3 deletions sechub-website/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ export default defineNuxtConfig({
},

devtools: { enabled: true },

modules: ['@nuxtjs/tailwindcss', 'nuxt-security']
});
modules: ['@nuxtjs/tailwindcss', 'nuxt-security'],
compatibilityDate: '2024-12-05'
});
Loading

0 comments on commit cba92d4

Please sign in to comment.