-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
docs: add more warnings for default secrets and docker-compose #27921
docs: add more warnings for default secrets and docker-compose #27921
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dpgaspar I left a suggestion to change from quote format to caution format (you can see an example of how that renders on the docker compose install page). And I put a note in there about keeping your key, what do you think about that? People have written in Slack about getting locked out of their Superset instance when they don't know their SECRET_KEY that they randomly generated. Maybe they store it as an env variable and then delete a file or wipe out a VM or something.
@@ -99,6 +99,10 @@ SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY' | |||
|
|||
You can generate a strong secure key with `openssl rand -base64 42`. | |||
|
|||
> Your secret key will be used for securely signing session cookies | |||
and encrypting sensitive information on the database | |||
Make sure you are changing this key for your deployment with a strong key. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure you are changing this key for your deployment with a strong key. | |
Ensure your deployment uses a strong, unique key. | |
Store this key securely. Without this key, you will be unable to access your Superset metadata database. That is, you will lose all of your Superset dashboards, charts, etc. ::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @csummers! I have a PR open now to fix this.
One thing I was thinking about recently around Also was thinking that in-your-face, "things you should know" in dev would be useful, notices like "hey we noticed you're on python 3.9 - the supported version is now 3.10, you should upgrade" |
Co-authored-by: Sam Firke <[email protected]>
Co-authored-by: Sam Firke <[email protected]>
…e#27921) Co-authored-by: Sam Firke <[email protected]>
…e#27921) Co-authored-by: Sam Firke <[email protected]>
…e#27921) Co-authored-by: Sam Firke <[email protected]>
SUMMARY
Add more warnings on our default for docker-compose and stress out the importance of having a unique random
SECRET_KEY
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION