Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/azure/azurite

A lightweight server clone of Azure Storage that simulates most of the commands supported by it with minimal dependencies
https://github.com/azure/azurite

azure-storage azurite blob-service blob-storage cross-platform docker-image storage-emulator

Last synced: 1 day ago
JSON representation

A lightweight server clone of Azure Storage that simulates most of the commands supported by it with minimal dependencies

Awesome Lists containing this project

README 

        
# Featured Tags



- latest

  `docker pull mcr.microsoft.com/azure-storage/azurite`



# Full Tag Listing



- latest

- [More history tags](https://mcr.microsoft.com/v2/azure-storage/azurite/tags/list)



# About this Image



> Please refer to Azurite official GitHub [repository](https://github.com/Azure/Azurite) for more information.



Azurite is an open source Azure Storage API compatible server (emulator). Based on Node.js, Azurite provides cross platform experiences for customers wanting to try Azure Storage easily in a local environment. Azurite simulates most of the commands supported by Azure Storage with minimal dependencies.



# How to Use this Image



```bash

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 mcr.microsoft.com/azure-storage/azurite

```



`-p 10000:10000` will expose blob service's default listening port.

`-p 10001:10001` will expose queue service's default listening port.

`-p 10002:10002` will expose table service's default listening port.



Just run blob service:



```bash

docker run -p 10000:10000 mcr.microsoft.com/azure-storage/azurite azurite-blob --blobHost 0.0.0.0

```



Run the image as a service (`-d` = daemon) named `azurite` and restart unless specifically stopped (this is useful when re-starting your development machine for example)



```bash

docker run --name azurite -d --restart unless-stopped -p 10000:10000 -p 10001:10001 -p 10002:10002 mcr.microsoft.com/azure-storage/azurite

```



**Run Azurite V3 docker image with customized persisted data location**



```bash

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 -v c:/azurite:/data mcr.microsoft.com/azure-storage/azurite

```



`-v c:/azurite:/data` will use and map host path `c:/azurite` as Azurite's workspace location.



**Customize Azurite V3 supported parameters for docker image**



```bash

docker run -p 7777:7777 -p 8888:8888 -p 9999:9999 -v c:/azurite:/workspace mcr.microsoft.com/azure-storage/azurite azurite -l /workspace -d /workspace/debug.log --blobPort 7777 --blobHost 0.0.0.0 --queuePort 8888 --queueHost 0.0.0.0 --tablePort 9999 --tableHost 0.0.0.0 --loose --skipApiVersionCheck --disableProductStyleUrl

```



Above command will try to start Azurite image with configurations:



`-l //workspace` defines folder `/workspace` as Azurite's location path inside docker instance, while `/workspace` is mapped to `c:/azurite` in host environment by `-v c:/azurite:/workspace`



`-d //workspace/debug.log` enables debug log into `/workspace/debug.log` inside docker instance. `debug.log` will also mapped to `c:/azurite/debug.log` in host machine because of docker volume mapping.



`--blobPort 7777` makes Azurite blob service listen to port 7777, while `-p 7777:7777` redirects requests from host machine's port 7777 to docker instance.



`--blobHost 0.0.0.0` defines blob service listening endpoint to accept requests from host machine.



`--queuePort 8888` makes Azurite queue service listen to port 8888, while `-p 8888:8888` redirects requests from host machine's port 8888 to docker instance.



`--queueHost 0.0.0.0` defines queue service listening endpoint to accept requests from host machine.



`--tablePort 9999` makes Azurite table service listen to port 9999, while `-p 9999:9999` redirects requests from host machine's port 9999 to docker instance.



`--tableHost 0.0.0.0` defines table service listening endpoint to accept requests from host machine.



`--loose` enables loose mode which ignore unsupported headers and parameters.



`--skipApiVersionCheck` skip the request API version check.



`--disableProductStyleUrl` force parsing storage account name from request URI path, instead of from request URI host.



> If you use customized azurite parameters for docker image, `--blobHost 0.0.0.0`, `--queueHost 0.0.0.0` are required parameters.



> In above sample, you need to use **double first forward slash** for location and debug path parameters to avoid a [known issue](https://stackoverflow.com/questions/48427366/docker-build-command-add-c-program-files-git-to-the-path-passed-as-build-argu) for Git on Windows.



Please refer to this [document](https://github.com/Azure/Azurite/blob/master/README.md) for **More supported parameters** like HTTPS or OAuth.



**Customize HTTP Keep-Alive behavior**

To avoid TCP RST related errors in tests with SDK which not properly handle KeepAlive-Timeout response header, you could increase keep alive timeout, increase values in seconds.



```bash

docker run azurite --blobHost 0.0.0.0 --blobKeepAliveTimeout 300 --queueHost 0.0.0.0 --queueKeepAliveTimeout 300  --tableHost 0.0.0.0 --tableKeepAliveTimeout 300

```



## Documentation



Please refer to this [document](https://github.com/Azure/Azurite/blob/master/README.md).



# Known Issues



Please go to Azurite GitHub repository [issues](https://github.com/Azure/Azurite/issues) for known issues.



# Feedback



Please go to Azurite GitHub repository [issues](https://github.com/Azure/Azurite/issues) for any feedbacks.



# License



This project is licensed under MIT.