> For the complete documentation index, see [llms.txt](https://academy.shade.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.shade.inc/help-center/security/shade-network-configuration-guide.md).

# Network configuration guide

### Overview

This document provides the network configuration requirements for deploying Shade within enterprise environments. To ensure proper functionality, your network administrators will need to whitelist the following domains and ports.

### Required Domain Whitelisting

The following domains must be whitelisted to allow Shade to function properly:

#### Shade Core Services

* `*.shade.inc` - All Shade subdomains (wildcard)\*\*, including:
  * `app.shade.inc` - Main application interface
  * `api.shade.inc` - Shade API endpoints
  * `api-auth.shade.inc` - Sign-in and authentication
  * `fs.shade.inc` - File system service (HTTPS and secure WebSocket)
  * `events.shade.inc` - Real-time updates (secure WebSocket)
  * `s3.shade.inc` - S3-compatible endpoint (used with S3 access keys)
  * `status.shade.inc` - Shade status page
* `*.wasabisys.com` - Storage for Vault drives (via Wasabi), e.g. `s3.us-east-1.wasabisys.com`. If you can't use a wildcard, allow `s3.<region>.wasabisys.com` for each region your Vault drives use.
* `*.r2.cloudflarestorage.com` - Storage for Active drives (via Cloudflare R2)

\*\*While we recommend adding the wild card route it is not strictly necessary

#### Review & Approval

* `app.shade.inc` - Main application interface
* `api.shade.inc` - Shade API endpoints
* `2f0871f542c14e6bb9ff5efbf27effa0.r2.cloudflarestorage.com` - Storage

#### Shade File System

* `*.upload.shadefs.com` - Upload servers used when uploading files from the web and desktop app

#### Third-Party Services

* `storage.googleapis.com` - Google Cloud Storage API, including desktop app downloads and updates (`storage.googleapis.com/v2-public.shade.inc`)
* `*.googleapis.com` - Google Cloud services (recommended for full compatibility)
* `shade-prod.firebaseapp.com` and `*.firebaseio.com` - Firebase (Google)
* `*.ingest.sentry.io` - Error reporting from the desktop app (Sentry)
* `do.featurebase.app` and `shade.featurebase.app` - Product updates and changelog (Featurebase)
* `*.intercom.io` and `*.intercomcdn.com` - In-app support chat (Intercom)

#### Notification Services

* `https://api.knock.app` - Knock service for Slack notifications

### Required Port Configuration

#### HTTPS and WebSocket Traffic

* **Port 443 (TCP)** - All HTTPS and secure WebSocket (WSS) traffic for the domains listed above

All Shade cloud services communicate over encrypted connections on port 443. `fs.shade.inc` and `events.shade.inc` use secure WebSockets (`wss://`), so firewalls and proxies must allow WebSocket upgrade requests to these hosts.

#### Shared Cache (local network only)

If you use a Shared Cache on your local network, also allow the following between the desktop app and the Shared Cache server:

* **Port 8003 (TCP)** by default, or the port your Shared Cache server is configured to use - The desktop app connects to the Shared Cache over plain HTTP (not HTTPS) on your local network
* **Port 5353 (UDP)** - mDNS/Bonjour, used to discover Shared Cache servers on your network automatically

### Implementation Checklist

To configure your network for Shade, complete the following steps:

1. **Firewall Configuration**
   * Add all listed domains to your firewall's allowlist
   * Ensure outbound TCP port 443 is open for these domains
   * If you use a Shared Cache, allow its TCP port and UDP 5353 (mDNS) on your local network
2. **Proxy Configuration** (if applicable)
   * Configure your proxy servers to allow traffic to the listed domains
   * Allow WebSocket upgrade requests (required for `fs.shade.inc` and `events.shade.inc`)
   * Ensure SSL/TLS inspection (if enabled) doesn't interfere with connections
3. **DNS Resolution**
   * Verify that your DNS servers can resolve all listed domains
   * Consider adding the domains to internal DNS forwarding rules if needed
4. **Testing**
   * After configuration, test connectivity to each domain
   * Verify that users can access `app.shade.inc` and perform file operations

### Security Considerations

* All communication with Shade cloud services is encrypted using industry-standard TLS
* Shared Cache traffic stays on your local network and uses HTTP rather than HTTPS
* The wildcard domain `*.shade.inc` is used to accommodate new services and features
* If your security policy doesn't permit wildcard domains, please contact Shade support for a complete list of current subdomains

### Support

If you encounter any issues during configuration or need additional information about specific domains, please contact:

**Shade Enterprise Support**\
Email: <support@shade.inc>\
Documentation: <https://docs.shade.inc>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/help-center/security/shade-network-configuration-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
