Skip to content

hdoro/sanity-plugin-external-files

Repository files navigation

sanity-plugin-external-files

Series of plugins for working with media files hosted elsewhere inside of Sanity.

Screenshot of the plugin

Existing implementations

List of vendors currently supported:

Use one of the existing implementations or write your own!

Creating your own implementation

I'm yet to properly document how to create your own implementation, so please reach out if you're looking into doing it! You can get a hold of me at opensource@hdoro.dev.

While that documentation gets sorted out, be sure to take a look at the configuration for the Firebase plugin and for the S3 plugin. The core plugin does the heavy lifting: the full implementation of the DigitalOcean plugin is 330 lines of code, including types and documentation ✨

Roadmap

From my own standpoint and use cases, this plugin is feature complete.

That said, I'm willing to develop it further given the interest and resources. Here's a list of features and improvements we could pursue:

  • Synchronizing files uploaded to vendors outside of Sanity
    • ✨ Solves: this would make it possible to have multiple entries to your storage buckets and using Sanity as the single source of truth. A significantly better experience than opening AWS S3's console and managing files there, for example.
    • This actually doesn't involve much code on the plugin side. It'd be more about providing a blessed path for implementing webhooks in a simpler way by developers.
    • If you already have this demand, just take a look at your used plugin's schema and try to build a handler for new files in your vendor that creates documents in Sanity following that schema.
  • Previews for PDFs and other file types
  • New vendors

Contributing

I'm a newbie with collaborating on open-source, so no strict rules here other than being respectful and considerate.

Acknowledgments

Immense gratitude to Akash Reddy and the folks at Playy.co for sponsoring the initial work for this plugin and helping shape it. You gave me the first opportunity to do paid open-source work and this won't be forgotten 💚

Also shout-out to Daniel, José and the great folks at Bürocratik for sponsoring the Sanity V3 upgrade of this plugin.

About

Work w/ media hosted in external vendors from inside a Sanity.io studio

Topics

Resources

Stars

Watchers

Forks