[GH-ISSUE #627] Some suggestions from official documentation #6092

Closed
opened 2026-03-01 17:09:27 +03:00 by kerem · 3 comments
Owner

Originally created by @zongyanglaobiao on GitHub (Oct 16, 2024).
Original GitHub issue: https://github.com/0xJacky/nginx-ui/issues/627

Hello, please forgive me for being rude and pointing out some issues with the documentation. The installation failed according to the Getting Started docker method in the documentation. The problem was that the documentation did not briefly describe the importance of the directory structure, because the log kept throwing errors, specifically, it could not find certain files/folders that were not in the documentation, and the page could not be seen when accessing the relevant ports. So I installed it according to the script method, but found that there was no download link for the relevant script? I think there is still room for improvement in the documentation.

Originally created by @zongyanglaobiao on GitHub (Oct 16, 2024). Original GitHub issue: https://github.com/0xJacky/nginx-ui/issues/627 Hello, please forgive me for being rude and pointing out some issues with the documentation. The installation failed according to the Getting Started docker method in the documentation. The problem was that the documentation did not briefly describe the importance of the directory structure, because the log kept throwing errors, specifically, it could not find certain files/folders that were not in the documentation, and the page could not be seen when accessing the relevant ports. So I installed it according to the script method, but found that there was no download link for the relevant script? I think there is still room for improvement in the documentation.
kerem closed this issue 2026-03-01 17:09:27 +03:00
Author
Owner

@0xJacky commented on GitHub (Oct 16, 2024):

Hi, @zongyanglaobiao

Thank you for raising this issue, and I’m truly sorry for the trouble the documentation caused you.

If you could provide the installation logs and a bit more detail on your setup environment (e.g., OS, Docker version, etc.), that would be a huge help in troubleshooting and improving the documentation.

Thanks again for your feedback! We’re looking forward to resolving this for you and improving the experience for future users.

Best regards,
Jacky

<!-- gh-comment-id:2415911181 --> @0xJacky commented on GitHub (Oct 16, 2024): Hi, @zongyanglaobiao Thank you for raising this issue, and I’m truly sorry for the trouble the documentation caused you. If you could provide the installation logs and a bit more detail on your setup environment (e.g., OS, Docker version, etc.), that would be a huge help in troubleshooting and improving the documentation. Thanks again for your feedback! We’re looking forward to resolving this for you and improving the experience for future users. Best regards, Jacky
Author
Owner

@felixzhang-glitch commented on GitHub (Oct 22, 2024):

I also encountered a similar issue, with the error being a 404. After waiting for a while and retrying, it recovered. This part is likely due to the service initializing, but there was no prompt, and nothing was logged either. It completely relies on the user to guess, which is indeed not very user-friendly.

<!-- gh-comment-id:2428845944 --> @felixzhang-glitch commented on GitHub (Oct 22, 2024): I also encountered a similar issue, with the error being a 404. After waiting for a while and retrying, it recovered. This part is likely due to the service initializing, but there was no prompt, and nothing was logged either. It completely relies on the user to guess, which is indeed not very user-friendly.
Author
Owner

@0xJacky commented on GitHub (Oct 22, 2024):

I also encountered a similar issue, with the error being a 404. After waiting for a while and retrying, it recovered. This part is likely due to the service initializing, but there was no prompt, and nothing was logged either. It completely relies on the user to guess, which is indeed not very user-friendly.

Hi @felixzhang-glitch, could you please provide us more detail like logs or screenshots?

<!-- gh-comment-id:2428868639 --> @0xJacky commented on GitHub (Oct 22, 2024): > I also encountered a similar issue, with the error being a 404. After waiting for a while and retrying, it recovered. This part is likely due to the service initializing, but there was no prompt, and nothing was logged either. It completely relies on the user to guess, which is indeed not very user-friendly. Hi @felixzhang-glitch, could you please provide us more detail like logs or screenshots?
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/nginx-ui#6092
No description provided.