diff --git a/README.md b/README.md index 5f02ed9..f735f02 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ To run the Azure Storage Emulator in a Docker container, follow these steps: 3. Run the emulator container: ```bash - ./run.sh + ./start-azurite ``` ## Native Installation @@ -137,10 +137,20 @@ Accepted flags: - `--latest`: Uses the latest released version of Azurite from GitHub as the base for the container image. This flag cannot be used together with `--version`. - `--registry`: Specifies the container registry to which the built image will be pushed. If not provided, the image will only be built locally and not tagged with registry prefix. -### `run.sh` +### `start-azurite` The script runs the Azure Storage Emulator using a supported container runtime (Docker or Apple `container` command). It accepts the same flag as `run-server.sh` to enable OAuth simulation (`--oauth` or `-o`). It also assumes `AZURITE_DIR` is either set in the environment or empty (not set), in which case it will default to the `./storage` subdirectory of the current directory. The script mounts the specified storage directory into the container, allowing you to persist data and access the generated SSL certificates on the host machine. +The default image name is `azurite:latest`, but it can be overridden by setting the `AZURITE_IMAGE` environment variable before running the script. For example: + +```bash +AZURITE_IMAGE=myregistry/azurite:latest ./start-azurite +``` + +Both `AZURITE_DIR` and `AZURITE_IMAGE` should be set in the shell profile if you are running the emulator as a local Azure Storage replacement for development purposes. + +> **Remember**: Make backups of the storage directory when the container is not running. + You have to use the same procedure as for `run-server.sh` to install the generated CA certificate as a trusted root certificate in your system to avoid SSL errors when connecting to the emulator. ## Reference