Skip to content

Commit

Permalink
Add --key-config-path alias (#188)
Browse files Browse the repository at this point in the history
* Add alias.

Signed-off-by: bgravenorst <[email protected]>

* Update per Consensys rebranding.

Signed-off-by: bgravenorst <[email protected]>

* Make key-config-path the preffered option.

Signed-off-by: bgravenorst <[email protected]>

---------

Signed-off-by: bgravenorst <[email protected]>
  • Loading branch information
bgravenorst authored Jul 25, 2023
1 parent 8379942 commit dab9dff
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions docs/Reference/CLI/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,32 +83,32 @@ data-path: "/Users/me/my_node/data"

Directory in which to store temporary files.

### `key-store-path`
### `key-config-path`, `key-store-path`

<!--tabs-->

# Syntax

```bash
--key-store-path=<PATH>
--key-config-path=<PATH>
```

# Example

```bash
--key-store-path=/Users/me/keys
--key-config-path=/Users/me/keys
```

# Environment variable

```bash
WEB3SIGNER_KEY_STORE_PATH=/Users/me/keys
WEB3SIGNER_KEY_CONFIG_PATH=/Users/me/keys
```

# Configuration file

```bash
key-store-path: "/Users/me/keys"
key-config-path: "/Users/me/keys"
```

<!--/tabs-->
Expand Down
4 changes: 2 additions & 2 deletions docs/Reference/security-disclosure.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
description: Web3Signer security disclosure policy statement
description: Web3signer security disclosure policy statement
sidebar_position: 4
---

# Security disclosure policy

At ConsenSys, security is a priority. But regardless of how much effort we put into system security, there may still be vulnerabilities present. If you discover a vulnerability, we want to know about it so we can take steps to address it as quickly as possible. You can help us better protect our clients and our systems.
At Consensys, security is a priority. But regardless of how much effort we put into system security, there may still be vulnerabilities present. If you discover a vulnerability, we want to know about it so we can take steps to address it as quickly as possible. You can help us better protect our clients and our systems.

Please do the following:

Expand Down
16 changes: 8 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const redocusaurus = [

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "ConsenSys Web3Signer",
title: "Consensys Web3Signer",
tagline:
"An open-source, client-agnostic, Ethereum signing service written in Java that is capable of signing on multiple platforms..",
url: "https://docs.web3signer.consensys.net",
Expand All @@ -52,7 +52,7 @@ const config = {

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "ConsenSys", // Usually your GitHub org/user name.
organizationName: "Consensys", // Usually your GitHub org/user name.
projectName: "doc.web3signer", // Usually your repo name.
deploymentBranch: "gh-pages", // Github Pages deploying branch

Expand All @@ -71,7 +71,7 @@ const config = {
docs: {
sidebarPath: require.resolve("./sidebars.js"),
// Set a base path separate from default /docs
editUrl: "https://github.com/ConsenSys/doc.web3signer/tree/main/",
editUrl: "https://github.com/Consensys/doc.web3signer/tree/main/",
path: "docs",
routeBasePath: "/",
// @ts-ignore
Expand Down Expand Up @@ -155,7 +155,7 @@ const config = {
},
items: [
{
href: "https://github.com/ConsenSys/web3signer",
href: "https://github.com/Consensys/web3signer",
className: "header-github-link",
position: "right",
},
Expand Down Expand Up @@ -215,21 +215,21 @@ const config = {
title: "Community",
items: [
{
label: "ConsenSys Discord",
label: "Consensys Discord",
href: "https://discord.com/invite/consensys",
},
{
label: "Web3Signer GitHub",
href: "https://github.com/ConsenSys/web3signer",
href: "https://github.com/Consensys/web3signer",
},
{
label: "Web3Signer documentation GitHub",
href: "https://github.com/ConsenSys/doc.web3signer",
href: "https://github.com/Consensys/doc.web3signer",
},
],
},
],
copyright: ${new Date().getFullYear()} ConsenSys, Inc.`,
copyright: ${new Date().getFullYear()} Consensys, Inc.`,
},
prism: {
theme: lightCodeTheme,
Expand Down

1 comment on commit dab9dff

@vercel
Copy link

@vercel vercel bot commented on dab9dff Jul 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.