Fix interactive unban

README.md

@@ -3,9 +3,9 @@
 ## First-time login
 
 1. Ensure an admin has enabled your user account and provided you a username.
-2. Login via [`ssh`](#ssh-remote-login): `ssh username@hartmanlab.genetics.uab.edu` (default password is your *username*)
+2. Login via [`ssh`](#ssh-remote-login): **`ssh username@hartmanlab.genetics.uab.edu`** (default password is your *username*)
 3. You will be prompted to create a new password and then logged out.
-4. Login again using your new password: `ssh username@hartmanlab.genetics.uab.edu`
+4. Login again using your new password: **`ssh username@hartmanlab.genetics.uab.edu`**
 5. Change the default `samba` password (default password is also your *username*): `smbpasswd`
 6. *Optional*: Generate a public-private keypair on your client and copy it to the server for faster and more secure logins.
 
@@ -16,16 +16,17 @@
 
 ## Notes
 
-* Read the `motd` helper at `ssh` login for ongoing server status
-* To change your user password: `passwd`
-* To change your samba password: `smbpasswd`
+* Read the `ssh` login message for ongoing server status updates.
+* See [Troubleshooting](#troubleshooting) and [Resources](#github-resources) for help.
+* Change your user password: `passwd`
+* Change your samba password: `smbpasswd`
 
 ## `ssh` remote login
 
 Connect to the server remotely using the command line.
 
 * Linux/OSX
-  * `ssh username@hartmanlab.genetics.uab.edu`
+  * **`ssh username@hartmanlab.genetics.uab.edu`**
 * Windows
   * [PuTTY](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
 * Android
@@ -47,9 +48,8 @@ Launch graphical programs locally on a client that execute on the server.
 
 Browse and manage files stored on the server.
 
-* Access sftp via most file managers using a `sftp://` address.
-
-  Example: `sftp://username@hartmanlab.genetics.uab.edu/home/username`
+* File manager
+  * Enter the `sftp://` address into your file manager's url bar, such as: `sftp://username@hartmanlab.genetics.uab.edu/home/username`
 
   ![sftp](docs/imgs/sftp.png)
 * [Filezilla](https://filezilla-project.org/download.php?type=client) (Linux/OSX/Windows)
@@ -67,13 +67,15 @@ The server provides two `samba` shares:
 1. Shared data array (`/mnt/data`): `\\username\\data`
 2. User home directory (`/home/username`): `\\username\\username`
 
-The default `samba` credentials are the same as your server username and password until changed with `smbpasswd`.
+The default `samba` credentials are the same as your server username and password (unless modified with `smbpasswd`).
+
+**Note:** Samba share are only available on-campus unless also using ssh tunneling: `ssh -L 1445:localhost:445 user@remote-server`
 
 ![samba](docs/imgs/samba.png)
 
 ## `x2goclient` remote desktop
 
-Launch a graphical remote desktop session using the X2Go `x2goclient` available for Linux/OSX/Windows from the [X2Go website](http://wiki.x2go.org/doku.php) or by installing the `x2goclient` package.
+Launch a persistent remote desktop session for graphical applications using [`x2goclient`](https://wiki.x2go.org/doku.php/download:start) (Linux/Windows/OSX).
 
 ![x2go_desktop](docs/imgs/x2go_desktop.png)
 
@@ -103,8 +105,6 @@ X2Go sessions can be paused or suspended from the X2Go client window. Multiple s
   * These folders will then appear on the server under `/media/disk/<share_name>`.
     ![x2go_server](docs/imgs/x2go_automount.png)
 
-**Note:** Some programs do not continue to run at full speed when an X2Go session is paused. In these cases, the program should be run via `ssh` in a [`tmux`](https://en.wikipedia.org/wiki/Tmux) or [`screen`](https://www.gnu.org/software/screen/) session.
-
 ## ~~Robot computer remote desktop access~~
 
 * *Currently unavailable* (TODO network cable unplugged?)
@@ -141,18 +141,18 @@ X2Go sessions can be paused or suspended from the X2Go client window. Multiple s
 
 ## Backing up your data
 
-`/mnt/data` is snapshotted daily to `/mnt/backup/data-backup`. In case of inadvertent data loss, users can recover lost files from a previous snapshot, organized by date.
+`/mnt/data` is snapshotted daily to `/mnt/backup/data-backup` and rolling backups are retained for six months.
 
-[`rsync`](https://linux.die.net/man/1/rsync) is also recommended for periodically backing up user files to a local client.
+[`rsync`](https://linux.die.net/man/1/rsync) is recommended for periodically backing up user files to a local client.
 
 * Copy a user's `$HOME` directory locally to `/home-backup` from a client: `rsync -azH --delete username@hartmanlab.genetics.uab.edu:/home/username/ home-backup/`
 * Copy a shared directory locally to the current directory from a client: `rsync -azh username@hartmanlab.genetics.uab.edu:/mnt/data/scans/20250723_roessler_project .`
 
-Backups can be initiated *from* the server using other pre-installed backup tools (`rsnapshot`, `borgbackup`, ...).
+Backups can also be initiated *from* the server using a variety of pre-installed backup tools (`rsnapshot`, `borgbackup`, ...).
 
 ## Troubleshooting
 
-Read the `motd` at `ssh` login for server status and updates: `cat /etc/motd`. Notify an admin of any issues.
+Read the `ssh` login message (`cat /etc/motd`) for server status and updates. [Open an issue](https://github.com/UAB-Hartman-Lab/server/issues) if there is one.
 
 * Can't login via `ssh`
   * Make sure that you are using the correct username and caps lock is off.
@@ -171,8 +171,16 @@ Read the `motd` at `ssh` login for server status and updates: `cat /etc/motd`. N
     * Permissions: `2775`
   * To change: `chown -R username:smbgrp <dir> && chmod 2775 <dir>`
   * If you do not have sufficient privileges to alter shared file permissions, ask an admin to fix or make a copy.
+* Program runs slowly in paused X2Go session
+  * Run program via `ssh` in a [`tmux`](https://en.wikipedia.org/wiki/Tmux) or [`screen`](https://www.gnu.org/software/screen/) session instead.
 
-## Resources
+## GitHub Resources
+
+* [Issues](https://github.com/UAB-Hartman-Lab/server/issues)
+* [Wiki](https://github.com/UAB-Hartman-Lab/server/wiki)
+* [Chat](https://github.com/UAB-Hartman-Lab/server/discussions)
+
+## External Resources
 
 * [RHEL documentation](https://access.redhat.com/documentation/en/red-hat-enterprise-linux/)
 * [Navigating the Linux CLI](https://www.digitalocean.com/community/tutorials/basic-linux-navigation-and-file-management)

scripts/usr/local/bin/script-user-unban

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# Unbans a fail2ban IP
+# Unban a fail2ban IP
 # Copyright 2021-2025 Bryan C. Roessler
 # Licensed under the Apache License, Version 2.0
 p="${BASH_SOURCE[0]%/*}"; [[ -r $p/script-functions ]] && . "$p"/script-functions || exit 1
@@ -11,7 +11,7 @@ is_root
 if [[ $# -eq 1 ]]; then
   ip_address="$1"
 else
-    prompt ip_address
+  ip_address=$(prompt ip_address)
 fi
 
 if fail2ban-client set sshd unbanip "$ip_address"; then