EnxDev commented on code in PR #43805:
URL: https://github.com/apache/superset/pull/43805#discussion_r3990775245
##########
docs/docs/using-superset/exporting-dashboard-data.mdx:
##########
@@ -47,17 +49,34 @@ Notes on the generated workbook:
This feature is **disabled by default**. It requires:
-1. **The `boto3` dependency.** It is not installed by default; install it with
- `pip install apache-superset[excel-export]`. Without it, exports fail and
the
- user receives a failure email.
-2. **An S3 bucket.** Set `EXCEL_EXPORT_S3_BUCKET`. Until it is set, the export
- endpoint returns `501` and the menu action surfaces a "not configured"
- message.
+1. **A storage bucket and backend.** Configure `EXPORT_STORAGE` with both
+ a `bucket` and a `backend` matching the bucket's provider — there is no
+ implicit default:
+
+ ```python
+ from superset.utils.s3 import S3ExportStorage # AWS S3
+ # from superset.utils.gcs import GCSExportStorage # Google Cloud Storage
+
+ EXPORT_STORAGE = {
+ "bucket": "my-export-bucket",
+ "backend": S3ExportStorage(),
+ }
+ ```
+
+ Until both are set, the export endpoint returns `501` and the menu action
+ surfaces a "not configured" message.
+2. **The backend's SDK dependency, on both the web and worker tiers** (the
+ worker uploads, the web server streams downloads). Not installed by
+ default; install
+ `pip install apache-superset[excel-export]` (boto3) for `S3ExportStorage`,
+ or `pip install apache-superset[excel-export-gcs]` (google-cloud-storage)
+ for `GCSExportStorage`. Without it, exports fail.
3. **A running Celery worker.** The export runs as a Celery task. If no worker
is running, the request is accepted but nothing is produced.
-4. **A configured SMTP transport.** The download link is delivered by email
- using the same settings as alerts & reports (`SMTP_*`,
- `EMAIL_REPORTS_SUBJECT_PREFIX`).
+4. **A configured SMTP transport, for email delivery only.** When set (same
+ settings as alerts & reports: `SMTP_*`, `EMAIL_REPORTS_SUBJECT_PREFIX`),
+ logged-in users with an email address also receive the download link by
+ email. The polling auto-download works without it.
Review Comment:
Could we include `WEBDRIVER_BASEURL_USER_FRIENDLY` in this email-only
prerequisite? `build_download_url()` uses it for the emailed URL, and its
default inherits `http://0.0.0.0:8080/`. Following this setup with storage and
SMTP alone therefore gives remote users an unusable email link even though the
polling download succeeds. A one-line example using the public Superset origin
would make the email setup complete.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
