{
    "sourceFile": "Documentation/01_User_Guide/10_Docker.md",
    "activeCommit": 0,
    "commits": [
        {
            "activePatchIndex": 0,
            "patches": [
                {
                    "date": 1745494414023,
                    "content": "Index: \n===================================================================\n--- \n+++ \n"
                }
            ],
            "date": 1745494414023,
            "name": "Commit-0",
            "content": "# User Guide: Docker\r\n\r\nThis document explains how to use the Asset Processor Tool with Docker.\r\n\r\n## Overview\r\n\r\nA `Dockerfile` and `requirements-docker.txt` are provided to allow you to build and run the Asset Processor Tool in a containerized environment. This is primarily intended for CLI or monitor usage.\r\n\r\n## Building the Docker Image\r\n\r\nFrom the project root directory, run the following command to build the Docker image:\r\n\r\n```bash\r\ndocker build -t asset-processor-tool .\r\n```\r\n\r\nThis command builds a Docker image named `asset-processor-tool` using the `Dockerfile` in the current directory.\r\n\r\n## Running the Docker Container\r\n\r\nYou can run the Docker container using standard Docker commands. You will typically need to mount volumes to make your input assets and desired output directory accessible within the container.\r\n\r\nHere is an example run command (adjust volumes as needed):\r\n\r\n```bash\r\ndocker run -v /path/to/your/inputs:/data/input -v /path/to/your/outputs:/data/output asset-processor-tool python main.py /data/input/YourAsset.zip -p YourPreset\r\n```\r\n\r\n*   `-v /path/to/your/inputs:/data/input`: This mounts your local input directory (`/path/to/your/inputs`) to the `/data/input` directory inside the container.\r\n*   `-v /path/to/your/outputs:/data/output`: This mounts your local output directory (`/path/to/your/outputs`) to the `/data/output` directory inside the container.\r\n*   `asset-processor-tool`: The name of the Docker image to run.\r\n*   `python main.py /data/input/YourAsset.zip -p YourPreset`: The command to execute inside the container. This example runs the CLI with a specific input file and preset, using the mounted input and output directories.\r\n\r\nAdjust the input file path (`/data/input/YourAsset.zip`) and preset name (`YourPreset`) as needed for your specific use case. You can also adapt the command to run the `monitor.py` script within the container."
        }
    ]
}