Shinobi

Running Shinobi in Windows Docker Desktop

A step-by-step tutorial on how to install and run Shinobi using Docker on Windows. By following these instructions, you’ll have Shinobi up and running in a container, accessible through your web browser.

Below is a step-by-step tutorial on how to install and run Shinobi using Docker on Windows. By following these instructions, you’ll have Shinobi up and running in a container, accessible through your web browser.

Also Thanks to warbleeder in the Community Chat for putting the information together for this document to be written!


  1. Download Docker:

  2. Install Docker:

    • Run the Docker Desktop Installer you just downloaded.
    • During the installation wizard, ensure that WSL (Windows Subsystem for Linux) is checked.
    • After the installation completes, reboot your system when prompted.

  1. Open Docker Desktop:

    • After rebooting, launch Docker Desktop .
    • It may prompt you for an email address. You can skip this step.
    • Proceed through the next couple of setup screens until Docker finishes its initial configuration.
  2. Enable Host Networking:

    • Once Docker is running, click the Settings icon (gear icon at the top-right of the Docker Desktop window).
    • Go to Resources Network .
    • Check the box for Enable host networking .
    • Click Apply & Restart .
    • Wait for Docker to restart; if a prompt appears to cancel or continue, click Cancel to return to the main screen.

  1. Open the Built-in Terminal:

    • In Docker Desktop, look to the bottom-right corner and click the Terminal icon.
    • Click Enable to activate the integrated terminal.
  2. Pull the Shinobi Image:

    • In the terminal, copy and paste or type:
docker pull registry.gitlab.com/shinobi-systems/shinobi:dev
  • Press Enter . Docker will download the Shinobi image, which may take a few minutes depending on your connection.

  1. Copy the Image ID:

    • Once the pull is complete, click on the Images tab in Docker Desktop.
    • Locate the Shinobi image you just downloaded.
    • Next to the image, click the copy button to copy the image’s ID (it will be in the form of a long sha256 hash).
  2. Start the Container:

    • Return to the Terminal in Docker Desktop.
    • Type the following command, replacing <Image_ID> with the ID you copied:
docker run -d -p 8080:8080 <Image_ID>
  • For example (with a sample ID):
docker run -d -p 8080:8080 sha256:f3f6ed55e741e260c0b975f8d89f1358018b53ab28b9887ae00e363fd2e3423c
  • Press Enter to launch the Shinobi container.

3. Confirm the Container is Running:

  • Click on Containers in Docker Desktop.
  • You should see your new container listed and its status should be green, indicating it’s running successfully.

  1. Open Shinobi Superuser Interface:

    • Launch your web browser and navigate to:
http://localhost:8080/super

2. Log In with Default Credentials:

3. Explore Shinobi:

Once logged in, you can manage and customize your Shinobi installation as needed.


  • If you encounter any issues:
    • Make sure Docker Desktop is running.
    • Ensure you’ve enabled WSL integration and host networking.
    • Confirm that your container is active and not stopped.
    • Double-check you’re using the correct port (8080).
  • For further help, you can reach out on Discord , user warbleeder has been gracious to volunteer in helping users with questions or issues in relation to using Docker Desktop on Windows.

That’s it!

You have successfully installed and launched Shinobi on Windows using Docker. You can now explore camera setup, motion detection, video recording, and all the other powerful features Shinobi has to offer. Enjoy!

ShinobiDocs

All content is property of their respective owners.