Managing the ShadeFS Cache

Overview

ShadeFS uses a local cache system to enable smooth, efficient access to your cloud-stored media files. Understand how to configure and manage this cache to optimize your workflow performance and manage your local storage.

Cache Basics

By default, ShadeFS allocates 10GB of cache space in the .shade folder within your computer's user root directory. This cache serves as a temporary storage location for streamed media segments so your file explorer and NLE’s have instant access to your media.

Configuring Your Cache

Location Management

You can change where ShadeFS stores its cache to a folder on your machine, or an external device:

  1. Open the Settings/Preferences menu in your Shade application

  2. Navigate to the cache settings section

  3. Select your preferred cache directory

For optimal performance, we recommend using a high-speed external SSD (such as a Samsung T7) as your cache location. This config will be higher performance and also keep your system drive free for other operations.

Your external hard drive cannot be formatted with exFAT as we use sparse files for cache files. Please format your drive for APFS or NTFS

Cache Size

The cache size can be adjusted through the "Mount Configuration" panel in the left sidebar. While the default 10GB is fine for basic usage, you can increase this up to the available free space on your selected cache drive. You should consider your typical working media size and available storage when adjusting this setting. The cache size is shared between all drives. If you have multiple drives mounted at the same time, they will all share the same cache space.

Offline Access

For situations where you need guaranteed access to specific files without internet access, you can pin files offline. When you pin a file or folder, it downloads a complete copy outside your cache, making it available offline. To pin content:

  1. Navigate to the desired file or folder in the Shade application

  2. Right-click the item

  3. Select "Pin to Cache"

Performance Considerations

Your cache configuration directly impacts system performance. For the best experience:

  • Use a high-speed storage device for your cache location, for suggested hardware check out Choosing an External SSD for Shade Cache

  • Allocate sufficient cache size for your typical working set

  • Monitor available space on your cache drive

  • Consider pinning frequently-used files for consistent access

Remember that while larger cache sizes can improve performance with frequently accessed files, they also require more storage space on your local system.

Last updated