You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "dpgaspar (via GitHub)" <gi...@apache.org> on 2024/04/05 10:46:53 UTC
[PR] docs: add more warnings for default secrets and docker-compose [superset]
dpgaspar opened a new pull request, #27921:
URL: https://github.com/apache/superset/pull/27921
### 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
<!--- Skip this if not applicable -->
### TESTING INSTRUCTIONS
<!--- Required! What steps can be taken to manually verify the changes? -->
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: add more warnings for default secrets and docker-compose [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on code in PR #27921:
URL: https://github.com/apache/superset/pull/27921#discussion_r1581621183
##########
docs/docs/installation/configuring-superset.mdx:
##########
@@ -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.
Review Comment:
Thanks @csummers! I have a PR open now to fix this.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: add more warnings for default secrets and docker-compose [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #27921:
URL: https://github.com/apache/superset/pull/27921#issuecomment-2040193259
One thing I was thinking about recently around `ENVIRONMENT_TAG_CONFIG` and `SUPERSET_ENV` is we could either force a very visible tag or refuse to start when use a bad combination of things (default `SECRET_KEY` and "SUPERSET_ENV=production").
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"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: add more warnings for default secrets and docker-compose [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on code in PR #27921:
URL: https://github.com/apache/superset/pull/27921#discussion_r1553601854
##########
docs/docs/installation/configuring-superset.mdx:
##########
@@ -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
Review Comment:
```suggestion
:::caution Your secret key will be used for securely signing session cookies
```
##########
docs/docs/installation/configuring-superset.mdx:
##########
@@ -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
Review Comment:
```suggestion
and encrypting sensitive information stored in Superset's application metadata database.
```
##########
docs/docs/installation/configuring-superset.mdx:
##########
@@ -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.
Review Comment:
```suggestion
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. :::
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: add more warnings for default secrets and docker-compose [superset]
Posted by "csummers (via GitHub)" <gi...@apache.org>.
csummers commented on code in PR #27921:
URL: https://github.com/apache/superset/pull/27921#discussion_r1574985142
##########
docs/docs/installation/configuring-superset.mdx:
##########
@@ -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.
Review Comment:
This `:::caution` block as merged is not closed with a `:::`, so this page renders everything after like so:
The suggestion did have a closing `:::`, though.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: add more warnings for default secrets and docker-compose [superset]
Posted by "rusackas (via GitHub)" <gi...@apache.org>.
rusackas merged PR #27921:
URL: https://github.com/apache/superset/pull/27921
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org