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

Revert "Specify /bin/zsh when creating a new user (#755)" #799

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

Conversation

ViViDboarder
Copy link

@ViViDboarder ViViDboarder commented Oct 2, 2024

This reverts commit 7fd5170.

Proposed Changes

This reverts #755, which introduced a bug preventing the user from switching to root after login. I can see that that PR was intended to fix #788, but there ought to be a proper fix in the way of utilizing the zsh configuration option rather than forcing the default shell to be zsh. If indeed there is a desire to change the default shell, consideration should be taken to make sure other locations expecting sh are updated.

Related Issues

Reverts #755
Fixes #788
Doesn't fix #744

Summary by CodeRabbit

  • New Features

    • Updated the user account shell from /bin/zsh to /bin/sh during user creation for enhanced compatibility.
  • Bug Fixes

    • Improved handling of SSH configurations, ensuring better security practices and logging for user accounts.
  • Chores

    • Maintained existing functionalities for SSH key setup, port configuration, and user-defined settings.

Copy link

coderabbitai bot commented Oct 2, 2024

Walkthrough

The changes in this pull request modify the SSH daemon configuration script for the Home Assistant Community Add-on for Advanced SSH & Web Terminal. The primary alteration involves changing the default shell for user accounts from /bin/zsh to /bin/sh when creating users, specifically if the username is not "root." The script retains its existing functionality for SSH key management, security practices, and configuration checks.

Changes

File Path Change Summary
ssh/rootfs/etc/s6-overlay/s6-rc.d/init-ssh/run Updated user shell from /bin/zsh to /bin/sh during user creation.

Assessment against linked issues

Objective Addressed Explanation
Shell prompt regression after latest 19.0.0 update (#788) The change does not address the prompt issue directly.
zsh not starting when connecting from WSL or another Linux machine (#744)

Possibly related PRs

  • Specify /bin/zsh when creating a new user #755: This PR is related as it involves changes to the same script (init-ssh/run) and modifies the user shell setting, specifically changing it to /bin/zsh, which is directly relevant to the changes made in the main PR that alters the shell to /bin/sh.

Suggested labels

bugfix

Poem

In the land of code where rabbits play,
We changed the shell to brighten the day.
From zsh to sh, a leap we take,
For smoother paths, we make no mistake.
Hopping along, with keys in tow,
Secure and swift, let the SSH flow! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
ssh/rootfs/etc/s6-overlay/s6-rc.d/init-ssh/run (1)

102-102: Approve: Change default shell to /bin/sh

This change from /bin/zsh to /bin/sh addresses the reported issue of users being unable to switch to the root account. Using /bin/sh as the default shell is more universal and less likely to cause compatibility issues.

Consider the following recommendations:

  1. Document this change in the add-on's changelog or documentation to inform users about the default shell change.
  2. Consider adding a configuration option that allows users to choose their preferred shell (e.g., ssh.default_shell). This would provide flexibility for users who prefer Zsh or other shells.

Example implementation for a configurable shell:

default_shell=$(bashio::config 'ssh.default_shell' "/bin/sh")
adduser -D "${username}" -s "${default_shell}" \
    || bashio::exit.nok 'Failed creating the user account'

This approach would maintain the fix while offering users more control over their environment.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 59646da and 98540bc.

📒 Files selected for processing (1)
  • ssh/rootfs/etc/s6-overlay/s6-rc.d/init-ssh/run (1 hunks)

@sinclairpaul sinclairpaul added the bugfix Inconsistencies or issues which will cause a problem for users or implementors. label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Inconsistencies or issues which will cause a problem for users or implementors.
Projects
None yet
2 participants