zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

adopt myst

Browse Source 
run rst2myst, with minimal manual formatting fixes
This commit is contained in:
Min RK
2023-03-27 09:31:02 +02:00
parent a5e72046ab
commit de36cfc116
96 changed files with 4131 additions and 4491 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/troubleshooting/providers/amazon.md Normal file
View File

@@ -0,0 +1,26 @@
# Troubleshooting issues on Amazon Web Services
This is an incomplete list of issues people have run into when running
TLJH on Amazon Web Services (AWS), and how they have fixed them!
## 'Connection Refused' error after restarting server
If you restarted your server from the EC2 Management 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 **IPv4 Public IP** dislayed in the bottom of the `EC2 Management Console`
screen for that instance 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 public IP changes by [associating a static IP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)
with your server. In the Amazon Web Services ecosystem, the public static IP
addresses are handled under `Elastic IP addresses` category of AWS; these
addresses are tied to the overall AWS account. [This guide](https://dzone.com/articles/assign-fixed-ip-aws-ec2) might be helpful. Notice
there can be a cost to this. Although [the guide](https://dzone.com/articles/assign-fixed-ip-aws-ec2) is outdated (generally
half that [price now](https://aws.amazon.com/ec2/pricing/on-demand/#Elastic_IP_Addresses)),
Amazon describes [here](https://aws.amazon.com/premiumsupport/knowledge-center/elastic-ip-charges/)
how the Elastic IP address feature is free when associated with a running
instance, but that you'll be charged by the hour for maintaining that specific
IP address when it isn't associated with a running instance.

32
docs/troubleshooting/providers/amazon.rst
View File

@@ -1,32 +0,0 @@
=============================================
Troubleshooting issues on Amazon Web Services
=============================================
This is an incomplete list of issues people have run into when running
TLJH on Amazon Web Services (AWS), and how they have fixed them!
'Connection Refused' error after restarting server
==================================================
If you restarted your server from the EC2 Management 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 **IPv4 Public IP** dislayed in the bottom of the `EC2 Management Console`
screen for that instance 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 public IP changes by `associating a static IP
<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html>`_
with your server. In the Amazon Web Services ecosystem, the public static IP
addresses are handled under `Elastic IP addresses` category of AWS; these
addresses are tied to the overall AWS account. `This guide
<https://dzone.com/articles/assign-fixed-ip-aws-ec2>`_ might be helpful. Notice
there can be a cost to this. Although `the guide
<https://dzone.com/articles/assign-fixed-ip-aws-ec2>`_ is outdated (generally
half that `price now <https://aws.amazon.com/ec2/pricing/on-demand/#Elastic_IP_Addresses>`_),
Amazon describes `here <https://aws.amazon.com/premiumsupport/knowledge-center/elastic-ip-charges/>`_
how the Elastic IP address feature is free when associated with a running
instance, but that you'll be charged by the hour for maintaining that specific
IP address when it isn't associated with a running instance.

27
docs/troubleshooting/providers/custom.rst → docs/troubleshooting/providers/custom.md
View File

@@ -1,8 +1,6 @@
.. _troubleshooting/providers/custom:
(troubleshooting-providers-custom)=
=========================================
Troubleshooting issues on your own server
=========================================
# Troubleshooting issues on your own server
This is an incomplete list of issues people have run into
when installing TLJH on their own servers, and ways they
@@ -11,23 +9,22 @@ Before trying any of them, also consider whether turning your machine on and off
and/or deleting the VM and starting over could solve the problem;
it has done so on a surprisingly high number of occasions!
Outgoing HTTP proxy required
============================
## Outgoing HTTP proxy required
If your server is behind a firewall that requires a HTTP proxy to reach
the internet, run these commands before running the installer
.. code-block:: bash
```bash
export http_proxy=<your_proxy-server>
```
export http_proxy=<your_proxy-server>
HTTPS certificate interception
==============================
## HTTPS certificate interception
If your server is behind a firewall that intercepts HTTPS requests
and re-signs them, you might have to explicitly tell TLJH which
certificates to use.
.. code::
export REQUESTS_CA_BUNDLE=</directory/with/your/ssl/certificates>
sudo npm config set cafile=</directory/with/your/ssl/certificates>
```
export REQUESTS_CA_BUNDLE=</directory/with/your/ssl/certificates>
sudo npm config set cafile=</directory/with/your/ssl/certificates>
```

17
docs/troubleshooting/providers/google.md Normal file
View File

@@ -0,0 +1,17 @@
# 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](https://console.cloud.google.com/compute/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](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address#promote_ephemeral_ip)
your server is using.

22
docs/troubleshooting/providers/google.rst
View File

@@ -1,22 +0,0 @@
======================================
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
<https://console.cloud.google.com/compute/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
<https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address#promote_ephemeral_ip>`_
your server is using.