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

Add user-fix script to allow changing usernames #791

Merged
merged 1 commit into from
Aug 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
53 changes: 53 additions & 0 deletions src/modules/octopi/filesystem/home/root/bin/user-fix
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
#!/usr/bin/env bash
# Written by Gina Häußge originally at https://github.com/OctoPrint/OctoPi-UpToDate/blob/e70ccdaf0cd4ef4adfaa3f9b6b288fb6bfda116a/scripts/files/user-fix

set -e

USERID=1000
FIRSTUSER=`getent passwd $USERID | cut -d: -f1`
FIRSTUSERHOME=`getent passwd $USERID | cut -d: -f6`

CURRENT=`grep User= /etc/systemd/system/octoprint.service | cut -d= -f2`

if [ "$CURRENT" = "pi" -a "$FIRSTUSER" != "pi" ]; then
# if we get here it means that the first user was renamed but we haven't yet
# updated all of OctoPi's files that depend on that name, so let's do that now

# first we need to figure out if we can use the new user name in systemd files
# directly or if we need to use the UID - we do that by checking if the
# escaped name differes from the plain name, if so something is non ASCII
# and the UID is the safer bet
FIRSTUSERESC=`systemd-escape "$FIRSTUSER"`
if [ "$FIRSTUSER" != "$FIRSTUSERESC" ]; then
SERVICEUSER=$USERID
else
SERVICEUSER=$FIRSTUSER
fi

# fix OctoPrint service file
echo "Fixing service file"
sed -i "s!User=pi!User=$SERVICEUSER!g" /etc/systemd/system/octoprint.service
sed -i "s!ExecStart=/home/pi/!ExecStart=$FIRSTUSERHOME/!g" /etc/systemd/system/octoprint.service
systemctl daemon-reload

# fix sudoers files
echo "Fixing sudoers"
sed -i "s!^pi!$FIRSTUSER!g" /etc/sudoers.d/octoprint-service
sed -i "s!^pi!$FIRSTUSER!g" /etc/sudoers.d/octoprint-shutdown

# fix scripts
echo "Fixing scripts"
sed -i "s!/home/pi/!$FIRSTUSERHOME/!g" $FIRSTUSERHOME/scripts/add-octoprint-checkout
sed -i "s!/home/pi/!$FIRSTUSERHOME/!g" $FIRSTUSERHOME/scripts/welcome
sed -i "s!/home/pi/!$FIRSTUSERHOME/!g" $FIRSTUSERHOME/.bashrc
sed -i "s!/home/pi/!$FIRSTUSERHOME/!g" /root/bin/webcamd

# fix virtualenv
echo "Fixing paths in virtual environment"
cd $FIRSTUSERHOME/oprint
sudo -u $FIRSTUSER $FIRSTUSERHOME/.local/bin/virtualenv-tools --update-path $FIRSTUSERHOME/oprint

# finally, reboot for all of this to actually take affect
echo "Adjusted scripts to new user, restarting services..."
systemctl reboot
fi
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Written by Gina Häußge originally at https://github.com/OctoPrint/OctoPi-UpToDate/blob/e70ccdaf0cd4ef4adfaa3f9b6b288fb6bfda116a/scripts/files/user-fix.service
[Unit]
Description=Ensure that user name changes are applied as needed

DefaultDependencies=no

Before=network-pre.target
Wants=network-pre.target

After=local-fs.target
Wants=local-fs.target

[Service]
Type=oneshot
ExecStart=/root/bin/user-fix

[Install]
WantedBy=multi-user.target
9 changes: 9 additions & 0 deletions src/modules/octopi/start_chroot_script
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,15 @@ systemctl_if_exists enable networkcheck.timer
echo "--- Installing avrdude"
apt-get -y install avrdude

### User-fixing
# Users can change their username easily via the Raspberry Pi imager, which breaks some of OctoPi's scripts
# we need to install virtualenv-tools3, so let's get pip and that
apt install -y python3-pip
sudo -u pi pip3 install --user virtualenv-tools3

systemctl_if_exists enable user-fix.service


#cleanup
apt-get clean
apt-get autoremove -y
Expand Down