UNPKG

3.58 kBMarkdownView Raw
1# Featured Tags
2
3- latest
4 `docker pull mcr.microsoft.com/azure-storage/azurite`
5
6# Full Tag Listing
7
8- latest
9- [More history tags](https://mcr.microsoft.com/v2/azure-storage/azurite/tags/list)
10
11# About this Image
12
13> Please refer to Azurite official GitHub [repository](https://github.com/Azure/Azurite) for more information.
14
15Azurite 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.
16
17# How to Use this Image
18
19```bash
20docker run -p 10000:10000 -p 10001:10001 mcr.microsoft.com/azure-storage/azurite
21```
22
23`-p 10000:10000` will expose blob service's default listening port.
24`-p 10001:10001` will expose queue service's default listening port.
25
26Just run blob service:
27
28```bash
29docker run -p 10000:10000 mcr.microsoft.com/azure-storage/azurite azurite-blob --blobHost 0.0.0.0
30```
31
32**Run Azurite V3 docker image with customized persisted data location**
33
34```bash
35docker run -p 10000:10000 -p 10001:10001 -v c:/azurite:/data mcr.microsoft.com/azure-storage/azurite
36```
37
38`-v c:/azurite:/data` will use and map host path `c:/azurite` as Azurite's workspace location.
39
40**Customize Azurite V3 supported parameters for docker image**
41
42```bash
43docker run -p 8888:8888 -p 9999:9999 -v c:/azurite:/workspace mcr.microsoft.com/azure-storage/azurite azurite -l /workspace -d /workspace/debug.log --blobPort 8888 --blobHost 0.0.0.0 --queuePort 9999 --queueHost 0.0.0.0 --loose --skipApiVersionCheck
44```
45
46Above command will try to start Azurite image with configurations:
47
48`-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`
49
50`-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.
51
52`--blobPort 8888` makes Azurite blob service listen to port 8888, while `-p 8888:8888` redirects requests from host machine's port 8888 to docker instance.
53
54`--blobHost 0.0.0.0` defines blob service listening endpoint to accept requests from host machine.
55
56`--queuePort 9999` makes Azurite queue service listen to port 9999, while `-p 9999:9999` redirects requests from host machine's port 9999 to docker instance.
57
58`--queueHost 0.0.0.0` defines queue service listening endpoint to accept requests from host machine.
59
60`--loose` enables loose mode which ignore unsupported headers and parameters.
61
62`--skipApiVersionCheck` skip the request API version check.
63
64> 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.
65
66Please refer to this [document](https://github.com/Azure/Azurite/blob/master/README.md) for **More supported parameters** like HTTPS or OAuth.
67
68## Documentation
69
70Please refer to this [document](https://github.com/Azure/Azurite/blob/master/README.md).
71
72# Known Issues
73
74Please go to Azurite GitHub repository [issues](https://github.com/Azure/Azurite/issues) for known issues.
75
76# Feedback
77
78Please go to Azurite GitHub repository [issues](https://github.com/Azure/Azurite/issues) for any feedbacks.
79
80# License
81
82This project is licensed under MIT.