Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

panel/1.0/troubleshooting: Add note about cert expiration #596

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

suutari
Copy link

@suutari suutari commented Aug 1, 2024

Expired certificate can create an error that looks like a general communication error, since websocket or XHR requests just fail in very similar way like the service was not responding at all.

This could be a quite common case, especially if the certificate renewal (e.g. for Let's Encrypt) is not properly set up.

Expired certificate can create an error that looks like a general communication error, since websocket or XHR requests just fail in very similar way like the service was not responding at all.

This could be a quite common case, especially if the certificate renewal (e.g. for Let's Encrypt) is not properly set up.
@danny6167
Copy link
Member

Not sure how much this is really going to help.
Two of the existing steps would have already exposed the fact the certificate was expired.

@suutari
Copy link
Author

suutari commented Aug 1, 2024

You're right that the expired cert would be exposed with e.g. the curl command, but I just thought that maybe explicitly listing this potential issue could still help, since you know what to look for. And possibly could just have an "aha moment" while reading the troubleshooting list even without checking those previous steps.

@suutari
Copy link
Author

suutari commented Aug 1, 2024

Also, is issuing the curl command from the server the correct way to check the connectivity? At least in my case the issue was when the browser wasn't able to connect to the 8080 port via websocket, because of expired cert. But I don't really know anything about Pterodactyl to touch the existing bullet points in that list.

@suutari
Copy link
Author

suutari commented Aug 6, 2024

If you think this note is worthless feel free to close the PR.

@danny6167
Copy link
Member

I didn't say it's worthless, I just want to have real and open discussions about how much of an effect it's really going to have.

We'll be taking a look into these smaller PRs after the major docs update PR is merged.

@suutari
Copy link
Author

suutari commented Aug 7, 2024

Sorry, didn't mean to be dramatic. And thanks for letting me know about the plan!

The truth is that I found the expired cert with the help of the previous bullet points. My thoughts at the time were that this kind of common issue could be mentioned explicitly still to speed up the debugging process, but that's only speculation of course.

Another thing that probably could have helped even more would have been a copy-paste from the error message that is shown in the UI: We're having some trouble connecting to your server, please wait... or the one that is shown in the browser's console: Firefox can’t establish a connection to the server at wss://...:8080/api/servers/.... I think users start debugging by searching the web with those error messages.

Let me know if you want me to improve the troubleshooting steps even more with those. I can update this PR or create another.

@rowansc1 rowansc1 added the enhancement New feature or request label Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants