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

feat: introduce a new environment variable in order to disable Scarf analytics #11179

Merged

Conversation

realethanhsu
Copy link
Contributor

…le Scarf analytics in the unstructured library.

Summary

This PR introduces a new environment variable that allows users to disable Scarf analytics in the unstructured library.
By setting SCARF_NO_ANALYTICS="true", users will benefit from the following:

  1. Data Protection: Disabling analytics helps safeguard user privacy and data security, as the unstructured library collect user data without explicit consent.
  2. Improved Startup Speed: The application can start up faster, particularly in poor network conditions. The unstructured library's logger module sends a request during application startup, which can lead to a poor user experience if the network is unreliable. In fact, I encountered this situation, I could not start the application at all due to this issue. Because my computer cannot access https://packages.unstructured.io .
    See github:unstructured:about analytics for more info.

Tip

Close issue syntax: Fixes #<issue number> or Resolves #<issue number>, see documentation for more details.

Screenshots

Before: After:
... ...

Checklist

Important

Please review the checklist below before submitting your pull request.

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

…le Scarf analytics in the unstructured library.
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. 📚 documentation Improvements or additions to documentation labels Nov 28, 2024
@realethanhsu realethanhsu changed the title feat: introduce a new environment variable that allows users to disab… feat: introduce a new environment variable that suppose to disable Scarf analytics Nov 28, 2024
@crazywoola
Copy link
Member

Please add this env to docker/.env.example as well.

@realethanhsu
Copy link
Contributor Author

Please add this env to docker/.env.example as well.

Done.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 28, 2024
@crazywoola crazywoola merged commit 0f11337 into langgenius:main Nov 28, 2024
7 checks passed
@realethanhsu realethanhsu changed the title feat: introduce a new environment variable that suppose to disable Scarf analytics feat: introduce a new environment variable in order to disable Scarf analytics Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants