Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

Merge pull request #212 from fredpena/docs/update_reference

Cristian de la Hozdf8abca11085
diff --cc README.md
index 199c1101bd,4a17fb8b98..a8e8ea5c51
--- a/README.md
+++ b/README.md
@@@ -226,19 -224,19 +226,19 @@@ Available compatibility test modules
All settings are overridable via environment variables (`FLOCI_` prefix).
-| Variable | Default | Description |
-|---|---|---|
-| `QUARKUS_HTTP_PORT` | `4566` | HTTP port |
-| `FLOCI_DEFAULT_REGION` | `us-east-1` | Default AWS region |
-| `FLOCI_DEFAULT_ACCOUNT_ID` | `000000000000` | Default AWS account ID |
-| `FLOCI_BASE_URL` | `http://localhost:4566` | Base URL used in API responses (e.g. SQS QueueUrl) |
-| `FLOCI_HOSTNAME` | *(unset)* | Override hostname in response URLs (for Docker Compose) |
-| `FLOCI_STORAGE_MODE` | `memory` | `memory` · `persistent` · `hybrid` · `wal` |
-| `FLOCI_STORAGE_PERSISTENT_PATH` | `./data` | Data directory |
-| `FLOCI_ECR_BASE_URI` | `public.ecr.aws` | AWS ECR Base URI to pull container images (e.g. Lambda) |
+| Variable | Default | Description |
+|---|---|-------------------------------------------------------------------------------------|
+| `QUARKUS_HTTP_PORT` | `4566` | Port exposed by the Floci API |
+| `FLOCI_DEFAULT_REGION` | `us-east-1` | Default AWS region |
+| `FLOCI_DEFAULT_ACCOUNT_ID` | `000000000000` | Default AWS account ID |
+| `FLOCI_BASE_URL` | `http://localhost:4566` | Base URL used when Floci returns service URLs (e.g. SQS QueueUrl) |
+| `FLOCI_HOSTNAME` | *(unset)* | Hostname to use in returned URLs when Floci runs inside Docker Compose |
+| `FLOCI_STORAGE_MODE` | `memory` | Controls how data is stored across runs: `memory` · `persistent` · `hybrid` · `wal` |
+| `FLOCI_STORAGE_PERSISTENT_PATH` | `./data` | Directory used for persisted state |
+| `FLOCI_ECR_BASE_URI` | `public.ecr.aws` | AWS ECR base URI used when pulling container images (e.g. Lambda) |
- → Full reference: [configuration docs](https://hectorvent.dev/floci/configuration/application-yml/)
- → Per-service storage overrides: [storage docs](https://hectorvent.dev/floci/configuration/storage/#per-service-storage-overrides)
+ * Full reference: [configuration docs](https://floci.io/floci/configuration/application-yml/)
+ * Per-service storage overrides: [storage docs](https://floci.io/floci/configuration/storage/#per-service-storage-overrides)
**Multi-container Docker Compose:** When your application runs in a separate container from Floci, set `FLOCI_HOSTNAME` to the Floci service name so that returned URLs (e.g. SQS QueueUrl) resolve correctly: