From 7bb91128e569d8316e6b4f4cf1ecc1c68f48de30 Mon Sep 17 00:00:00 2001 From: Bryan Roessler Date: Fri, 22 Oct 2021 17:00:30 -0400 Subject: [PATCH] Fix installer --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d2295e10..bee959cd 100644 --- a/README.md +++ b/README.md @@ -215,20 +215,23 @@ Once configured, the user will no longer need to enter their password to access ## For administrators +- Type `scripts-` and use `tab` completion in the CLI to access the following customized helper programs. +- Run them with administrator privileges using `sudo`. + ### Adding a user -- `sudo script-user-add` `username` *`password`* +- `script-user-add` `username` *`password`* - Optionally pass a second argument *`password`* to create a user's password for them. If omitted, the default password is equal to the *`username`*. - `username` can be anything, but ideally a unique string of small capital letters. ### Resetting a user password -- `sudo script-user-reset-password` `username` *`password`* +- `script-user-reset-password` `username` *`password`* - If a user forgets their password this will reset it to *`password`*, or if *`password`* is omitted, to the `username`. In either case the user will be prompted to enter a new password at next login. The Samba password cannot be changed by users, only admins. ### Removing a user -- `sudo script-user-remove` *`username`* +- `script-user-remove` *`username`* - This will allow you to optionally backup user files to the array before user deletion. ### Reset a buggy or corrupt X2Go user session @@ -253,8 +256,8 @@ Once configured, the user will no longer need to enter their password to access - Start: `sudo systemctl start smb.service` - Stop: `sudo systemctl stop smb.service` -- Start at boot: `sudo systemctl enable smb.service` -- Do not start at boot: `sudo systemctl disable smb.service` +- Enable at boot: `sudo systemctl enable smb.service` +- Disable at boot: `sudo systemctl disable smb.service` - Restart service: `sudo systemctl restart smb.service` - Reload services: `sudo systemctl daemon-reload` - Read service: `sudo systemctl cat smb.service` @@ -295,20 +298,20 @@ Once configured, the user will no longer need to enter their password to access ### Updating all software -- `sudo script-system-update` +- `script-system-update` - The server regularly installs security updates unattended - If the kernel, java, systemd, or other major components are updated, the system should be restarted. ### Scheduling a restart -- `sudo script-system-scheduled-restart` *`OnCalendar`* +- `script-system-scheduled-restart` *`OnCalendar`* - If a valid `OnCalendar` is not passed, assumes `*-*-* 01:30:00` (1:30 AM). - See [Calendar Events](https://www.freedesktop.org/software/systemd/man/systemd.time.html) for proper time format. - This will alert users via `notify-send` in X2Go, `wall` in ssh, and add a reminder to the `motd` about the scheduled restart. ### Adding a drive -- ~~`sudo scripts-drive-add` `/dev/sdX`~~ (Under construction) +- ~~`scripts-drive-add` `/dev/sdX`~~ (Under construction) - To determine the correct drive, use `lsblk -f`. ### Logging