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

updated private key backup caution message #285

Merged
merged 1 commit into from
Nov 30, 2023

Conversation

maeliosakyne
Copy link
Contributor

Summary

Updated the private key backup caution box, so that the text is more clear on what exactly should be backed up

ticket:
#283

Copy link

netlify bot commented Nov 23, 2023

Deploy Preview for obol-docs ready!

Name Link
🔨 Latest commit 9fb87f9
🔍 Latest deploy log https://app.netlify.com/sites/obol-docs/deploys/655f6292d2b113000865ef72
😎 Deploy Preview https://deploy-preview-285--obol-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@maeliosakyne maeliosakyne linked an issue Nov 23, 2023 that may be closed by this pull request
@@ -63,7 +63,7 @@ You should expect to see a console output like
If instead of being shown your `enr` you see an error saying `permission denied` then you may need to [update docker permissions](/docs/int/faq/errors#docker-permission-denied-error) to allow the command to run successfully.

:::caution
Please make sure to create a backup of the private key at `.charon/charon-enr-private-key`. Be careful not to commit it to git! **If you lose this file you won't be able to take part in the DKG ceremony and start the DV cluster successfully.**
Ensure you create a backup of the private key stored in the '.charon' folder, specifically at '.charon/charon-enr-private-key'. This is the file used to generate your private key. Be careful not to commit it to git! **If you lose this file you won't be able to take part in the DKG ceremony and start the DV cluster successfully.**
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the file used to generate your private key

We should clarify that this file doesn't generate the DV private key, but contains the cluster identity key.

Copy link
Contributor

Choose a reason for hiding this comment

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

We should also add that they should save the private key as it is used to generate the ENR. Just saving the ENR is useless which is what some operators have been doing as it displays a warning in the CLI to save it. @gsora we should maybe also clarify the CLI?

Copy link
Contributor

Choose a reason for hiding this comment

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

We should also add that they should save the private key as it is used to generate the ENR.

💯

we should maybe also clarify the CLI?

When you create an ENR with charon create enr we already print a pretty sizable caution message.

Do you think we should change something with it?

Screenshot 2023-11-27 at 11 23 31

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes!

Copy link

sonarcloud bot commented Nov 27, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@OisinKyne OisinKyne merged commit 7ec7f1a into main Nov 30, 2023
7 checks passed
@OisinKyne OisinKyne deleted the Maeliosa/Private-Key-backup-instructions branch November 30, 2023 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Private Key backup instructions
4 participants