Update profile filename for zsh

[jon-hedgerows]

Proposed Changes

An earlier PR changed the user shell to zsh. zsh does not run .profile, it looks for .zprofile instead. Changed .profile to .zprofile so that zsh runs it on login.

Related Issues

#788
#755

Summary by CodeRabbit

• New Features

  • Improved user session initiation for non-root users by updating profile configuration for Z shell compatibility.

• Bug Fixes

  • Maintained existing logic for SSH configurations, ensuring consistent behavior in user account setup and security measures.

[coderabbitai]

Walkthrough

The pull request introduces a modification to the SSH daemon configuration script in the Home Assistant Community Add-on for Advanced SSH & Web Terminal. The change specifically alters how non-root user login shells are configured by shifting the sudo -i command from .profile to .zprofile, ensuring better compatibility with the Z shell environment. The core functionality of SSH configuration, including host key generation and user account setup, remains consistent with the previous implementation.

Changes

File	Change Summary
ssh/rootfs/etc/s6-overlay/s6-rc.d/init-ssh/run	Modified user profile configuration to write sudo -i command to .zprofile instead of .profile for non-root users

Poem

🐰 A shell script hops with grace so light,
Changing profiles to make configs bright
From .profile to .zprofile we leap
Z-shell users, no more worries to keep
SSH config dancing with rabbit might! 🔑

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74b3bb1 and ea35168.

📒 Files selected for processing (1)

• ssh/rootfs/etc/s6-overlay/s6-rc.d/init-ssh/run (1 hunks)

🔇 Additional comments (1)

ssh/rootfs/etc/s6-overlay/s6-rc.d/init-ssh/run (1)

110-110: Confirm overwriting vs. appending in .zprofile

Overwriting the .zprofile file using the > operator replaces any existing user-specific configurations for Z shell initialization. Please confirm whether this is the intended behavior. If you want to preserve any user-defined settings within .zprofile, consider appending instead (e.g. >>) or backing up the file first.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[frenck]

Thanks, @jon-hedgerows 👍

Happy New Year 🥂

../Frenck

[ViViDboarder]

Is there a reason to use zsh here when the only thing done by the shell is switch to a new user (and that users shell)?

I get this pr because it fixes the regression that I was trying to patch too, but just curious why we even want to keep zsh in place for this user.

[jon-hedgerows]

@ViViDboarder yes, you have a point.

I was thinking about this PR after I submitted it, and did wonder if it would have been better to revert the /bin/zsh to /bin/sh instead: as you say, this shell doesn't do anything.

[frenck]

I'm fine with either tbh 🤷

[PaulSD]

This change breaks users that use bash instead of zsh ... Because #755 causes both the user and root to use either zsh or bash (vs. the user using sh and root using either zsh or bash), and this change removes .profile, so bash users no longer have a .profile to switch them to root.

Either we need to revert #755 (and this change), or we need both .profile and .zprofile

I agree with the other commenters here - I don't really see any benefit to #755 (since that shell is only used to switch to root, is there any benefit to supporting zsh for it?), so my suggestion would be to revert #755.

[frenck]

This change breaks users that use bash instead of zsh ...

Good point. Let's remove the bash option from this add-on 👍

[PaulSD]

Let's remove the bash option from this add-on

I wasn't suggesting that :-P
I'm one of the dinosaurs who still lives in bash and hasn't gotten used to zsh, so I appreciate the option to use bash...
It seems to me that reverting #755 is a simple solution that shouldn't negatively impact anyone.

[sinclairpaul]

Or as it's a config option, do an if based on it?

[ViViDboarder]

Or using shadow rather than sed to change shells.

[ViViDboarder]

This is the reason I originally submitted the revert patch. Basically to go to a known stable state while coming up with a stable move forward plan. That said, I still don’t see any advantage to using anything other than the default shell for the login user if we’re switching immediately.

Might be good to revert both commits and then switch to using chsh -s from shadow to change the root shell (should be the only one that matters). That then gives flexibility for the future to change the default shell as well.

[jon-hedgerows]

This turns out to be incomplete: see #826