Skip to content

Commit 4ef695d

Browse files
committed
Add section for troubleshooting Azurite container connections
1 parent 9b1dbf6 commit 4ef695d

1 file changed

Lines changed: 120 additions & 1 deletion

File tree

support/azure/azure-storage/blobs/alerts/storage-explorer-troubleshooting.md

Lines changed: 120 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ If you continue to have issues after you do a reset, try these steps:
216216
macOS Keychain can sometimes enter a state that causes issues for the Storage Explorer authentication library. To get Keychain out of this state, follow these steps:
217217

218218
1. Close Storage Explorer.
219-
1. Open Keychain by selecting <kbd>Command</kbd> + <kbd>Spacebar</kbd>, type *keychain*, and select <kbd>Enter</kbd>.
219+
1. Open Keychain by selecting <kbd>Command</kbd> + <kbd>Space</kbd>, type *keychain*, and select <kbd>Enter</kbd>.
220220
1. Select the **login** keychain.
221221
1. Select the **padlock** to lock the keychain. After the process is finished, the **padlock** appears locked. It might take a few seconds, depending on what apps you have open.
222222

@@ -692,6 +692,125 @@ For some issues, you need to provide logs of the network calls made by Storage E
692692
1. Save the trace again with a new name.
693693
1. Optional: Delete the original trace.
694694

695+
## Storage Explorer can't find Azurite Docker containers
696+
697+
If Storage Explorer can't find your Azurite Docker containers, follow these steps to troubleshoot the issue:
698+
699+
### Verify Docker is installed
700+
701+
Ensure that Docker is installed and running on your machine. You can verify this by running the following command in your terminal or command prompt:
702+
703+
```bash
704+
docker --version
705+
```
706+
707+
If Docker is not running, restart Docker services and try again.
708+
709+
For Linux users, you may need to join the `docker` group. To do this, run the following commands:
710+
711+
```bash
712+
sudo groupadd docker
713+
sudo usermod -aG docker $USER
714+
```
715+
716+
Once you've added yourself to the `docker` group, restart your machine. See [Linux post-installation steps for Docker Engine](https://docs.docker.com/engine/install/linux-postinstall/) for more information.
717+
718+
### Verify the Docker context
719+
720+
Make sure you're using the correct Docker context that is managing your containers. You can check your current context by running:
721+
722+
```bash
723+
docker context ls
724+
```
725+
To change your active context, use:
726+
727+
```bash
728+
docker context use <context_name>
729+
```
730+
731+
> [!NOTE]
732+
> For Linux snap users, Storage Explorer will only work with the `default` context. Other contexts, such as `desktop-linux`, are not visible to Storage Explorer.
733+
734+
### Check Azurite container status
735+
736+
Verify that your Azurite containers are running. You can check the status of your Docker containers by running:
737+
738+
```bash
739+
docker container list --all
740+
```
741+
742+
Ensure that your Azurite containers are listed and their status is "Up". If a container is not running, you can start it with:
743+
744+
```bash
745+
docker start <container name>
746+
```
747+
748+
### Verify Azurite ports
749+
750+
Ensure that your Azurite containers port configurations are correct. You can check the ports by running:
751+
752+
```bash
753+
docker inspect <container name>
754+
```
755+
756+
Look for the `NetworkSettings.Ports` section in the output to verify the port mappings. For example, assuming an Azurite container's blob endpoint is configured to listen on port 10000, and that container port is mapped to the host machine's port 10010, then you should see an entry like this:
757+
758+
```json
759+
"10000/tcp": [
760+
{
761+
"HostIp": "0.0.0.0",
762+
"HostPort": "10010"
763+
}
764+
]
765+
```
766+
767+
### Verify you have the latest version of Storage Explorer installed
768+
769+
Make sure you are using the [latest version of Storage Explorer](https://github.com/microsoft/AzureStorageExplorer/releases/latest). You can check for updates by going to **Help** > **Check for Updates**.
770+
771+
For Linux snap users, make sure you have made the necessary connections. To do this, run the following commands:
772+
773+
```bash
774+
snap connect storage-explorer:docker docker:docker-daemon
775+
snap connect storage-explorer:docker-executables docker:docker-executables
776+
```
777+
778+
### Verify custom accounts are valid
779+
780+
If you are using custom accounts, make sure the account names and keys are valid and correctly configured in Storage Explorer. You can verify the custom accounts in use by running:
781+
782+
```bash
783+
docker exec <container name> printenv AZURITE_ACCOUNTS
784+
```
785+
786+
### Check network settings
787+
788+
Ensure that there are no network issues preventing Storage Explorer from connecting to the Azurite container. Verify that your firewall or antivirus software is not blocking the connection.
789+
790+
### Restart Azurite container
791+
792+
If the issue persists, try restarting the Azurite container:
793+
794+
```bash
795+
docker restart <container name>
796+
```
797+
798+
### Recreate Azurite container
799+
800+
If none of the above steps resolve the issue, try recreating the Azurite container. For example:
801+
802+
```bash
803+
docker stop <container name>
804+
docker rm <container name>
805+
docker run \
806+
--name <container-name> \
807+
-e AZURITE_ACCOUNTS="<custom account name>:<custom key>" \
808+
-p <blob-host-port>:10000 \
809+
-p <queue-host-port>:10001 \
810+
-p <table-host-port>:10002 \
811+
mcr.microsoft.com/azure-storage/azurite
812+
```
813+
695814
## Next steps
696815

697816
If none of these solutions work for you, use one of the following methods:

0 commit comments

Comments
 (0)