Skip to content

Commit c3bb45b

Browse files
authored
Add docs about Online vs. Offline image (#527)
1 parent 09a2e29 commit c3bb45b

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

src/content/docs/aws/enterprise/enterprise-image.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,37 @@ This offline functionality is enabled by:
2828
- After the image is pushed to the customer-specific ECR repository, the customer can pull and push it to their internal Docker registry.
2929
- Developers within the customer’s network can then pull the image from this registry.
3030
- To use the image from the command line interface (CLI), set the `IMAGE_NAME` configuration to the name of the Enterprise image, typically using the command:
31-
3231
```bash
3332
IMAGE_NAME=localstack-enterprise localstack start
34-
```
33+
```
34+
35+
## "Online" vs "Offline" image
36+
37+
This section compares the standard [LocalStack for AWS Docker image](/aws/capabilities/config/docker-images) ("online") with the customer-specific Enterprise image ("offline").
38+
39+
### Key differences
40+
41+
| Area | Standard image | Enterprise image |
42+
|---|---|---|
43+
| Internet requirement for core startup | Requires network access for normal [license activation](/aws/getting-started/auth-token). | Designed to run without internet access in air-gapped environments. |
44+
| License behavior | Activates via LocalStack licensing endpoints. If unreachable, LocalStack attempts offline activation and requires re-activation every 24 hours. | Includes an embedded keypair/decryption key so LocalStack can run without contacting the license server. |
45+
| Service dependencies | Some services may download dependencies on demand during runtime. | Service dependencies are pre-baked into the image for offline usage. |
46+
| Cloud Pods | Platform remote integration can sync state with your LocalStack account. | LocalStack Platform remotes are typically unavailable in fully air-gapped setups. Use self-managed remotes (for example S3 or ORAS) when available in your environment. |
47+
| Ephemeral instances | Available via Web App/CLI as cloud-hosted LocalStack runtimes. | Not available in air-gapped/offline deployments because they run on LocalStack Cloud infrastructure. |
48+
| Telemetry | Can send usage events for features such as [Stack Insights](/aws/capabilities/web-app/stack-insights). | Keep event reporting disabled (`DISABLE_EVENTS=1`) for strict offline setups. |
49+
50+
### What communicates with LocalStack Cloud?
51+
52+
The main integrations are:
53+
54+
- **License activation**: The standard image performs online activation using your `LOCALSTACK_AUTH_TOKEN`. See [Auth Token](/aws/getting-started/auth-token) for activation behavior and fallbacks.
55+
- **Event reporting (telemetry)**: Used for Stack Insights and related usage analytics. You can disable this via `DISABLE_EVENTS=1`.
56+
- **Cloud Pods (platform remote)**: Saving/loading pods against the default platform remote uses LocalStack-managed infrastructure. For stricter data residency, configure your own Cloud Pods [remote storage](/aws/capabilities/state-management/cloud-pods#remotes).
57+
- **Ephemeral instances**: These are managed cloud instances and therefore require connectivity to LocalStack Cloud services.
58+
59+
### Recommended setup for offline environments
60+
61+
- Use the **offline Enterprise image** when no outbound connectivity is permitted.
62+
- Keep `DISABLE_EVENTS=1` to prevent event reporting.
63+
- Prefer local persistence or self-managed Cloud Pod remotes instead of platform remotes.
64+
- Do not rely on Ephemeral Instances in fully isolated networks; run LocalStack directly in your controlled environment instead.

0 commit comments

Comments
 (0)