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.

Sign up for GitHub

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

Jump to bottom

Docs/node tutorial/keygen clarification #145

Merged
merged 3 commits into from
Mar 4, 2024
Merged

Docs/node tutorial/keygen clarification #145

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8c9f65
added a few lines to clarify how to generate your secret key
phoniks Mar 4, 2024
e26c033
moved line which was interrrupting existing text
phoniks Mar 4, 2024
b25d1a0
reverting formatting
phoniks Mar 4, 2024
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
13 changes: 10 additions & 3 deletions docs/node_tutorials/node_setup_identifiers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ Install `sqlite`
yarn add sqlite3 typeorm
```

Generate your secret key and save for later in a safe place

```bash
npx @veramo/cli config create-secret-key
```

Add a tsconfig.json to your project

```json
Expand All @@ -74,8 +80,9 @@ Add a tsconfig.json to your project

## Bootstrap Veramo

We bootstrap Veramo by creating a setup file and initializing the agent. Create a setup file in `src/veramo/setup.ts`
and import the following dependencies:
We bootstrap Veramo by creating a setup file and initializing the agent. Create a setup file in `src/veramo/setup.ts` and import the following dependencies:

Note: In this file we'll use that secret key that we generated in an earlier step, so have it handy.

```typescript
// Core interfaces
Expand Down Expand Up @@ -126,7 +133,7 @@ const DATABASE_FILE = 'database.sqlite'
// You will need to get a project ID from infura https://www.infura.io
const INFURA_PROJECT_ID = '<your PROJECT_ID here>'

// This will be the secret key for the KMS
// This will be the secret key for the KMS (replace this with your secret key)
const KMS_SECRET_KEY =
'< you can generate a key by running `npx @veramo/cli config create-secret-key` in a terminal>'
```
Expand Down
Loading