Skip to content

Add --user/-u flag to specify custom SSH username, with interactive prompt as fallback. #81

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.

Sign up for GitHub

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

Open
lafabo wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add --user/-u flag to specify custom SSH username, with interactive prompt as fallback. #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99627ed
Add to sidekick init --user/-u flag to specify custom SSH username, w…
Dec 28, 2025
db82309
always try to use "sidekick" user as failback user at stage2Login
Dec 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions cmd/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,16 @@ func stage1LocalReqs() error {
return nil
}

func stage2Login(server string) (*ssh.Client, string, error) {
users := []string{"root", "sidekick"}
func stage2Login(server string, customUser string) (*ssh.Client, string, error) {
var users []string

if customUser != "" {
users = append(users, customUser)
} else {
users = append(users, "root")
}
users = append(users, "sidekick")

for _, user := range users {
client, err := utils.Login(server, user)
if err == nil {
Expand All @@ -70,8 +78,8 @@ func stage3UserSetup(client *ssh.Client, loggedInUser string) error {
}
}

if !hasSidekickUser && loggedInUser == "root" {
if err := utils.RunStage(client, utils.UsersetupStage); err != nil {
if !hasSidekickUser {
if err := utils.RunStage(client, utils.UsersetupStage(loggedInUser)); err != nil {
return err
}
}
Expand Down Expand Up @@ -179,6 +187,7 @@ var InitCmd = &cobra.Command{
skipPromptsFlag, _ := cmd.Flags().GetBool("yes")
server, _ := cmd.Flags().GetString("server")
certEmail, _ := cmd.Flags().GetString("email")
sshUser, _ := cmd.Flags().GetString("user")

if server == "" {
server = render.GenerateTextQuestion("Please enter the IPv4 Address of your VPS", "", "")
Expand All @@ -194,6 +203,10 @@ var InitCmd = &cobra.Command{
}
}

if sshUser == "" && !skipPromptsFlag {
sshUser = render.GenerateTextQuestion("Please enter the SSH username", "root", "default: root")
}

publicKey := viper.GetString("publicKey")
if publicKey != "" && server != viper.GetString("serverAddress") && !skipPromptsFlag {
confirm := render.GenerateTextQuestion("A server was previously setup with Sidekick. Would you like to override the settings? (y/n)", "n", "")
Expand Down Expand Up @@ -223,7 +236,7 @@ var InitCmd = &cobra.Command{
AllDone: false,
})

utils.Login(server, "root")
utils.Login(server, sshUser)

go func() {
if err := stage1LocalReqs(); err != nil {
Expand All @@ -233,7 +246,7 @@ var InitCmd = &cobra.Command{
time.Sleep(time.Millisecond * 100)
p.Send(render.NextStageMsg{})

sshClient, loggedInUser, err := stage2Login(server)
sshClient, loggedInUser, err := stage2Login(server, sshUser)
if err != nil {
p.Send(render.ErrorMsg{ErrorStr: fmt.Sprintf("Login failed: %s", err)})
return
Expand Down Expand Up @@ -318,5 +331,6 @@ func init() {

InitCmd.Flags().StringP("server", "s", "", "Set the IP address of your Server")
InitCmd.Flags().StringP("email", "e", "", "An email address to be used for SSL certs")
InitCmd.Flags().StringP("user", "u", "", "SSH username to use for initial connection")
InitCmd.Flags().BoolP("yes", "y", false, "Skip all validation prompts")
}
31 changes: 20 additions & 11 deletions utils/stages.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,26 @@ import (
"strings"
)

var UsersetupStage = CommandsStage{
SpinnerSuccessMessage: "New user created successfully",
SpinnerFailMessage: "Error creating a new user for the machine",
Commands: []string{
"sudo useradd -m -s /bin/bash -G sudo sidekick",
`echo "sidekick ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers.d/sidekick`,
"mkdir -p /home/sidekick/.ssh/",
"sudo cat /root/.ssh/authorized_keys | sudo tee -a /home/sidekick/.ssh/authorized_keys",
"sudo chown sidekick:sidekick /home/sidekick/.ssh/authorized_keys",
"sudo chmod 600 /home/sidekick/.ssh/authorized_keys",
},
func UsersetupStage(currentUser string) CommandsStage {
// Determine the source of SSH keys based on current user
sshKeysSource := "~/.ssh/authorized_keys"
if currentUser == "root" {
sshKeysSource = "/root/.ssh/authorized_keys"
}

return CommandsStage{
SpinnerSuccessMessage: "New user created successfully",
SpinnerFailMessage: "Error creating a new user for the machine",
Commands: []string{
"sudo useradd -m -s /bin/bash -G sudo sidekick || true",
`echo "sidekick ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/sidekick`,
"sudo mkdir -p /home/sidekick/.ssh/",
fmt.Sprintf("sudo cp %s /home/sidekick/.ssh/authorized_keys", sshKeysSource),
"sudo chown -R sidekick:sidekick /home/sidekick/.ssh/",
"sudo chmod 700 /home/sidekick/.ssh/",
"sudo chmod 600 /home/sidekick/.ssh/authorized_keys",
},
}
}

var SetupStage = CommandsStage{
Expand Down