Named server docs do not include information on `name_template` configuration

[stevejpurves]

Bug description

When using named servers in conjunction with DockerSpawner (in my case in a TLJH deployment) errors occur when trying to start a second named server.

This is solved by updating the DockerSpawner.name_template in line with the discussion in this forum post https://discourse.jupyter.org/t/multiple-jupyterhub-servers-per-user-named-servers-does-not-work/2357/5

However, it seems like the PR mentioned in the post was never merged?

Expected behaviour

The docs should mention setting the name_template option on the spawner..

Actual behaviour

there is no mention in the relevant section of the docs: https://github.com/jupyterhub/jupyterhub/blob/main/docs/source/reference/config-user-env.md#named-servers

How to reproduce

n/a

Your personal set up

• Jupyterhub 1.5 via TLJH
• FirstUserAuthenticator
• DockerSpawner
• tljh-repo2docker

[welcome]

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.

You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

[minrk]

Not supporting named servers by default can be considered a bug in DockerSpawner. Migrating this issue over there, since it's not related to JupyterHub itself.

[welcome]

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.

You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉