diff --git a/docs/index.rst b/docs/index.rst index a05da35..2991e22 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -59,6 +59,16 @@ guides help you find what is broken & hopefully fix it. troubleshooting/logs +Often, your issues are not related to TLJH itself but to the cloud provider +your server is running on. We have some documentation on common issues you +might run into with various providers and how to fix them. We welcome contributions +here to better support your favorite provider! + +.. toctree:: + :titlesonly: + + troubleshooting/providers/google + Contributing ============ diff --git a/docs/troubleshooting/providers/google.rst b/docs/troubleshooting/providers/google.rst new file mode 100644 index 0000000..def3572 --- /dev/null +++ b/docs/troubleshooting/providers/google.rst @@ -0,0 +1,22 @@ +====================================== +Troubleshooting issues on Google Cloud +====================================== + +This is an incomplete list of issues people have run into when running +TLJH on Google Cloud, and how they have fixed them! + +'Connection Refused' error after restarting server +================================================== + +If you restarted your server from the Google Cloud console & then try to access +your JupyterHub from a browser, you might get a **Connection Refused** error. +This is most likely because the **External IP** of your server has changed. + +Check the **External IP** in the `Google Cloud Console -> Compute Engine -> VM instances +`_ screen +matches the IP you are trying to access. If you have a domain name pointing to the +IP address, you might have to change it to point to the new correct IP. + +You can prevent External IP changes by `reserving the static IP +`_ +your server is using.