Introduction to ShadeFS

Overview

ShadeFS is a cloud drive mounting solution that completely changes how you interact with cloud-stored media files. Unlike traditional cloud storage solutions that require complete file downloads before access (ahem Dropbox), ShadeFS streams the segments you need in real-time, similar to how YouTube delivers video content. This approach give you immediate access to your media while optimizing bandwidth usage.

Key Features

• ShadeFS turns your cloud drive into a network-attached-drive for your computer

• When you mount a drive, it appears in your local file system just like a physical hard drive, but with the added advantage of intelligent streaming and caching

• The system automatically synchronizes file trees across all users, ensuring everyone on your team works with the same content structure regardless of their location.

• Uploaded files are automatically pushed through our proxy generation and AI analysis pipelines

System Requirements

ShadeFS has a few requirements to get working optimally on your machine.

• For working with 4K video content, we recommend a minimum internet speed of 500Mbps down

• Users with lower bandwidth should consider working with proxy files or sub-4K resolution content

• Your device should also have sufficient storage space for the cache, with a minimum of 10GB for basic operations

Getting Started

Start with the setup process available at https://app.shade.inc/shadefs-setup/steps. Once your setup is complete, you can mount any drive by navigating to it in the left panel, clicking the "..." menu, and selecting "Mount Drive." The drive will immediately appear in your local file explorer, whether you're using Windows or macOS.

Cache Configuration

ShadeFS uses a caching system to optimize performance for your media files. By default, the system creates a cache of 10GB in the .shade folder located in your user root directory. However, you can customize both the cache location and size to better suit your needs.

Managing the ShadeFS Cache

Cache Directory

To modify your cache directory, navigate to Settings/Preferences in the application. Here you can select any folder on your computer or an external drive as your cache location. We particularly recommend using a high-speed external SSD, such as a Samsung T7, for optimal performance.

Cache Size

Cache size can be changed through the "Mount Configuration" panel. The default 10GB cache is sufficient for basic operations, but you can increase this up to the available free space on your computer or whatever your cache directory is set to. Consider your typical workflow project size and available storage when adjusting these settings.

See more details at Managing the ShadeFS Cache.

ShadeFS Usage Guidelines

Permissions

ShadeFS access and mounting capabilities is restricted to workspace members and administrators. When multiple users mount the same drive, they all see an identical file tree, which facilitates seamless collaboration across remote teams.

Uploads

For large-scale uploads exceeding 1000 assets or 100GB, we recommend using the webapp or desktop application rather than uploading through the mounted drive. We have optimized uploading through the app interface for large files. Any upload method you choose will automatically make content visible in both the webapp and desktop application, triggering our automatic proxy generation and AI processing systems.

Files can be moved between drives by first mounting multiple drives and then moving files through your computer's file explorer between the drives

Offline Access

ShadeFS provides offline access capabilities through pinning. To access specific files or folders with weak internet connection (or none at all), simply right-click on the files/folders in the app and select "Pin to Cache." This action downloads a complete copy of the selected content to your local cache, making them fully accessible even if you are offline.

See more at Pinning Files Offline.

Performance Optimization

There’s a few ways to maximize the performance for ShadeFS.

• Use an external SSD for cache storage to significantly improve access speeds and overall system responsiveness

• We recommend configuring your cache size based on your typical working set to ensure frequently accessed files remain readily available

• While ShadeFS is designed to work efficiently with available bandwidth, try to maintain a stable internet connection while you use the mount

• For users working with high-resolution content on limited bandwidth, we recommend making proxy files

Integration with Shade Ecosystem

Unlike other file streaming tools, ShadeFS is deeply integrated with the webapp and desktop app. When you upload files through a mounted drive, they are automatically indexed in the Shade system, which are immediately visible across web and desktop applications. Learn more about our asset indexing here.