File endpoints: use query parameters for NGINX/Caddy compatibility

[bigcat88]

PR Description

When deploying ComfyUI behind NGINX, we encountered issues with file-related endpoints due to the use of path parameters for file paths. Proxy servers may modify the encoding of URLs, leading to inconsistent behavior. For example:

• The server may receive:
  http://127.0.0.1:8188/api/userdata/workflows%2Fphoto_stickers2.json?overwrite=false&full_info=true
• But proxies like NGINX may decode it to:
  http://127.0.0.1:8188/api/userdata/workflows/photo_stickers2.json?overwrite=false&full_info=true

This inconsistency caused the ComfyUI server to respond with a 405 Method Not Allowed status.

Changes Made:

• Updated the file-related endpoints (getuserdata, post_userdata, delete_userdata, and move_userdata) to use query parameters instead of path parameters for file paths. This ensures compatibility with proxy servers by avoiding reliance on URL path encoding.
• For the move_userdata endpoint, both the source and destination paths are now passed as query parameters (source and dest).

Notes:

• The FrontEnd must be updated to reflect these changes, as the file paths have been moved from path parameters to query parameters.
• Old endpoints were not touched, compatibility with old frontends will not be broken.

This PR replaces old PR #6363 which was only a workaround which we applied on server to temporary make ComfyUI work.

Resolves: #5629

Partially fixes problem from #4534

[bigcat88]

If necessary, I can theoretically write a test for this, but I'm not sure that the design of endpoint should be covered by tests.

I can describe in more detail why these changes are needed, but in the linked issues that were not created by me, everything seems clear.

[asagi4]

This PR might be easier to merge if you supported both types of endpoint, so that people who have an older or alternative frontend don't just break since the frontend can be installed separately from the backend and isn't guaranteed to be in sync.

For nginx specifically, it seems it urlencodes the path if your proxy_pass directive contains a url path component. So

proxy_pass http://127.0.0.1:8188;

works properly, but

proxy_pass http://127.0.0.1:8188/;

or anything specifying a subpath does not

[bigcat88]

Thank you very much for the correct and accurate remark, - re-pushed the commit.

After your remark:

1. All old endpoints remain in place and are not touched.
2. The same endpoints are added but with the /v1 prefix in the path - they use query parameters.
3. Tests use new endpoints.
4. Old endpoints can be removed after some time.

Is there anything else that is missing?

[lupsin]

May I ask about the approximate date when this or a similar PR that corrects this situation might be merged?

[vojtajina]

+1 for solving this problem, would be nice to be able to run caddy in front of Comfy (to get HTTPS).

[AIConquistador]

+1 to this, using Traefik for HTTPS

[bigcat88]

@comfyanonymous hello. sorry to bother you, but can you ask @huchenlei or @robinjhuang to take a look at this PR/problem when they have some free time.

Thanks in advance

[webfiltered]

Not in a position to review this properly right now, but here are some quick suggestions to make it easier to review / test the PR.

[chenFe-1]

I have updated comfyui to the latest version, why does this problem still occur? Description When deploying ComfyUI behind NGINX, we encountered issues with file-related endpoints due to the use of path parameters for file paths. Proxy servers may modify the encoding of URLs, leading to inconsistent behavior. For example: I can not store my workflow the request and response

my comfyui info by start log (comfyui) /mnt/workspace/ComfyUI> python main.py [START] Security scan [DONE] Security scan

ComfyUI-Manager: installing dependencies done.

** ComfyUI startup time: 2025-02-10 17:12:46.975 ** Platform: Linux ** Python version: 3.12.5 | packaged by Anaconda, Inc. | (main, Sep 12 2024, 18:27:27) [GCC 11.2.0] ** Python executable: /home/pai/envs/comfyui/bin/python ** ComfyUI Path: /mnt/workspace/ComfyUI ** User directory: /mnt/workspace/ComfyUI/user ** ComfyUI-Manager config path: /mnt/workspace/ComfyUI/user/default/ComfyUI-Manager/config.ini ** Log path: /mnt/workspace/ComfyUI/user/comfyui.log

Prestartup times for custom nodes: 1.5 seconds: /mnt/workspace/ComfyUI/custom_nodes/ComfyUI-Manager

Checkpoint files will always be loaded safely. Total VRAM 22516 MB, total RAM 65536 MB pytorch version: 2.5.1 Set vram state to: NORMAL_VRAM Device: cuda:0 NVIDIA A10 : cudaMallocAsync Using pytorch attention ComfyUI version: 0.3.14 [Prompt Server] web root: /mnt/workspace/ComfyUI/web

Loading: ComfyUI-Manager (V3.7.4)

ComfyUI Version: v0.3.14-12-g4027466c | Released on '2025-02-10'

[comfyui_controlnet_aux] | INFO -> Using ckpts path: /mnt/workspace/ComfyUI/custom_nodes/comfyui_controlnet_aux/ckpts [comfyui_controlnet_aux] | INFO -> Using symlinks: False [comfyui_controlnet_aux] | INFO -> Using ort providers: ['CUDAExecutionProvider', 'DirectMLExecutionProvider', 'OpenVINOExecutionProvider', 'ROCMExecutionProvider', 'CPUExecutionProvider', 'CoreMLExecutionProvider'] [ComfyUI-Manager] default cache updated: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main/model-list.json [ComfyUI-Manager] default cache updated: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main/custom-node-list.json [ComfyUI-Manager] default cache updated: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main/alter-list.json [ComfyUI-Manager] default cache updated: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main/extension-node-map.json [ComfyUI-Manager] default cache updated: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main/github-stats.json FETCH DATA from: /mnt/workspace/ComfyUI/user/default/ComfyUI-Manager/cache/2233941102_nodes_page_1_limit_1000.json [DONE] /mnt/workspace/ComfyUI/custom_nodes/comfyui_controlnet_aux/node_wrappers/dwpose.py:26: UserWarning: DWPose: Onnxruntime not found or doesn't come with acceleration providers, switch to OpenCV with CPU device. DWPose might run very slowly warnings.warn("DWPose: Onnxruntime not found or doesn't come with acceleration providers, switch to OpenCV with CPU device. DWPose might run very slowly") nightly_channel: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main/cache FETCH DATA from: /mnt/workspace/ComfyUI/user/default/ComfyUI-Manager/cache/1514988643_custom-node-list.json [DONE]

Import times for custom nodes: 0.0 seconds: /mnt/workspace/ComfyUI/custom_nodes/websocket_image_save.py 0.1 seconds: /mnt/workspace/ComfyUI/custom_nodes/ComfyUI-Custom-Scripts 0.2 seconds: /mnt/workspace/ComfyUI/custom_nodes/ComfyUI-Manager 0.7 seconds: /mnt/workspace/ComfyUI/custom_nodes/comfyui_controlnet_aux

Starting server

To see the GUI go to: http://127.0.0.1:8188

my nginx config

[bigcat88]

I have updated comfyui to the latest version

For this PR to work, you need to switch to it, and also rebuild the frontend (which is in another repository) with the linked PR.

Or just wait until someone from the Comfy organization finds time to review this PR for merge.