Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up docs #1529

Merged
merged 1 commit into from
Nov 6, 2023
Merged
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
2 changes: 1 addition & 1 deletion docs/docs/getting_started/remediations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 70

# Automatic Remediation with Minder

In [Enabling Secret Scanning](./first_profile.md), we wrote a rule to open a
In [Creating your first profile](./first_profile.md), we wrote a rule to open a
security advisory when repo configuration drifted from the configured profile
in Minder. In this tutorial, we will show how Minder can automatically
resolve the misconfiguration and ensure that enrolled repos have secret
Expand Down
22 changes: 8 additions & 14 deletions docs/docs/run_minder_server/run_the_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,34 +149,28 @@ following command:
make KC_GITHUB_CLIENT_ID=<client_id> KC_GITHUB_CLIENT_SECRET=<client_secret> github-login
```

## Create encryption keys
## Create token key passphrase

Create a token key passphrase that is used when storing the provider's token in the database.

The default configuration expects these keys to be in a directory named `.ssh`, relative to where you run the `minder-server` binary.
Start by creating the `.ssh` directory.

```bash
mkdir .ssh && cd .ssh
mkdir .ssh
```

You can create the encryption keys using the `openssl` CLI tool.
You can create the passphrase using the `openssl` CLI tool.

```bash
# First generate an RSA key pair
ssh-keygen -t rsa -b 2048 -m PEM -f access_token_rsa
ssh-keygen -t rsa -b 2048 -m PEM -f refresh_token_rsa
# For passwordless keys, run the following:
openssl rsa -in access_token_rsa -pubout -outform PEM -out access_token_rsa.pub
openssl rsa -in access_token_rsa -pubout -outform PEM -out access_token_rsa.pub
openssl rand -base64 32 > .ssh/token_key_passphrase
```

If your keys live in a directory other than `.ssh`, you can specify the location of the keys in the `config.yaml` file.
If your key lives in a directory other than `.ssh`, you can specify the location of the key in the `config.yaml` file.

```yaml
auth:
access_token_private_key: "./.ssh/access_token_rsa"
access_token_public_key: "./.ssh/access_token_rsa.pub"
refresh_token_private_key: "./.ssh/refresh_token_rsa"
refresh_token_public_key: "./.ssh/refresh_token_rsa.pub"
token_key: "./.ssh/token_key_passphrase"
```

## Run the application
Expand Down
8 changes: 0 additions & 8 deletions docs/docs/understand/security.md

This file was deleted.

Loading