| # Flatseek Distribution & Licensing Guide |
|
|
| Securely distribute your Flatseek search indexes with flexible encryption and access control models suited for enterprise deployments. |
|
|
| --- |
|
|
| ## Overview: Distribution Models |
|
|
| | Model | Encryption | Expiry | Access Control | Best For | |
| |-------|-----------|--------|----------------|----------| |
| | **Plain** | None | — | None | Public data, no sensitivity | |
| | **Bucket** | Per-file ChaCha20 | — | Passphrase | Internal teams, trusted users | |
| | **License Token** | Full-section ChaCha20 | ✅ Token-based | HMAC token | Subscription content, SaaS | |
| | **License + Custom Key** | Full-section ChaCha20 | ✅ Token-based | HMAC token | Tiered distribution, premium tiers | |
| | **Enclosed** | Full blob ChaCha20 | ✅ Cryptographic | Passphrase | Single-file distribution, time-limited access | |
|
|
|
|
| ### Enclosed Datasets (Expired Data Protection) |
|
|
| > **Passphrase:** `flatlens_demo_enclosed` |
|
|
| | File | Status | Expiry | |
| |------|--------|--------| |
| | `demo_enclosed_active.fsk` | Active | 2027-07-05 | |
| | `demo_enclosed_expired.fsk` | Expired | 2025-07-05 | |
|
|
| ```bash |
| # CLI usage |
| flatseek search demo_enclosed_active.fsk "*" \ |
| --passphrase "flatlens_demo_enclosed" |
| |
| flatseek serve demo_enclosed_active.fsk \ |
| --passphrase "flatlens_demo_enclosed" |
| ``` |
|
|
| ### License Dataset (Expired Key Protection) |
|
|
| > **Embedded key:** `LICENSE_EMBEDDED_KEY=opensourcelicensekey1234567890123456` |
|
|
| | File | Expiry | Status | Token | |
| |------|-------|--------|--------| |
| | `demo_license.fsk` | 2027-07-05 | Active | ZGVtby11c2VyfDE4MTQ3NDU2MDB8MHxtUkJaTkN4WUdLeWhrV2NUMGN3Wlo0MkhUc1IvelNpYXBzUGo4a2tZdVhzPQ== |
| | `demo_license.fsk` | 2025-07-05 | Expired | ZGVtby11c2VyfDE3NTE2NzM2MDB8MHxUVDFwQ05tVDVyVDlaVFIwYkxwMEVEV1oxVXRyUzVuM1BjOXVlZU9OWEIwPQ== |
|
|
| ```bash |
| # CLI usage |
| flatseek search demo_license.fsk "*" \ |
| --passphrase "ZGVtby11c2VyfDE4MTQ3NDU2MDB8MHxtUkJaTkN4WUdLeWhrV2NUMGN3Wlo0MkhUc1IvelNpYXBzUGo4a2tZdVhzPQ==" |
| ``` |
|
|
