docs: add VITE_API_BASE_URL documentation for remote/VPS deployment#516
Open
harshitanand wants to merge 1 commit into666ghj:mainfrom
Open
docs: add VITE_API_BASE_URL documentation for remote/VPS deployment#516harshitanand wants to merge 1 commit into666ghj:mainfrom
harshitanand wants to merge 1 commit into666ghj:mainfrom
Conversation
dosubot
bot
added
size:M
…66ghj#514) When MiroFish is deployed on a remote VPS the Vite dev proxy is not active in the browser, so axios defaults to localhost:5001 on the user's own machine causing a network error on the frontend. Document the VITE_API_BASE_URL fix in three places: - .env.example: add commented-out variable with explanation - README.md (Chinese): add VPS deployment note after Docker section - README-EN.md (English): add equivalent note in English Closes 666ghj#511 (same root cause confirmed by multiple users).
harshitanand
force-pushed
the
docs/issue-514-vite-api-base-url-vps
branch
from
803872e to
1b9cd10
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Users deploying MiroFish on a remote VPS see a "Network error" at step 1/5 because the Vite dev proxy only works locally — remotely, the browser tries to reach
localhost:5001on the user's own machine instead of the server.This PR documents the
VITE_API_BASE_URLfix that resolves it.Changes
.env.example— adds commented-outVITE_API_BASE_URLvariable with a clear explanation of when and why to set itREADME.md(Chinese) — adds aREADME-EN.md(English) — adds the equivalent section in EnglishTesting
Related
Closes #514
Also resolves the root cause reported in #511