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

Improve SSH docs around ptys and interactive shells #3795

Merged
merged 4 commits into from
Sep 8, 2024
Merged

Conversation

smlx
Copy link
Member

@smlx smlx commented Aug 21, 2024

There has been some confusion around why sometimes you don't get a shell prompt when using Lagoon SSH. This change aims to clarify what happens when you use ssh and when you need to force pty allocation.

I noticed that we advise people to specify port 22 even though that is the default. So I removed that bit.

I also took the opportunity to remove the advice to ignore host keys, since both the ssh core and ssh portal services provide static host keys these days. If you don't want to remove that yet I can push it in a separate PR.

General Checklist

  • Affected Issues have been mentioned in the Closing issues section
  • Documentation has been written/updated
  • PR title is ready for inclusion in changelog

Database Migrations

  • If your PR contains a database migation, it MUST be the latest in date order alphabetically

Closing issues

n/a

@shreddedbacon
Copy link
Member

The port needs to go back in.

The {{ defaults.sshport }} are used as a way to provide overrides for people that may not use port 22 and host their own version of the docs.

@smlx
Copy link
Member Author

smlx commented Aug 21, 2024

Ok thanks for the tip. I added a conditional around the port templating.

@shreddedbacon shreddedbacon added this to the 2.21.0 milestone Sep 3, 2024
Copy link
Member

@tobybellwood tobybellwood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@tobybellwood tobybellwood merged commit 76c822b into main Sep 8, 2024
2 checks passed
@tobybellwood tobybellwood deleted the ssh-docs-pty branch September 8, 2024 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants