bryan/hartman-server
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Tighten up docs

Browse Source
This commit is contained in:
Bryan Roessler
2025-07-23 21:34:29 -04:00
parent 756b1c7086
commit f424bda9c5
2 changed files with 29 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -3,12 +3,11 @@
## First-time login ## First-time login
1. Ensure an admin has enabled your user account and provided a username. 1. Ensure an admin has enabled your user account and provided a username.
2. Login via [`ssh`](#clients): `ssh username@hartmanlab.genetics.uab.edu` (the default password is your username) 2. Login via [`ssh`](#ssh): `ssh username@hartmanlab.genetics.uab.edu` (default password is your *username*)
3. You will be prompted to create a new password and automatically logged out 3. You will be prompted to create a new password and then logged out
4. Login again using new password: `ssh username@hartmanlab.genetics.uab.edu` 4. Login again using your new password: `ssh username@hartmanlab.genetics.uab.edu`
5. Change `samba` password (default password is also your *username*): `smbpasswd` 5. Change the default `samba` password (default password is also your *username*): `smbpasswd`
6. To change your password again in the future: `passwd` 6. *Optional*: Generate a public-private keypair on your client and copy it to the server for faster and more secure logins.
7. *Optional*: Generate a public-private keypair on your client and copy it to the server for faster and more secure logins.
```bash ```bash
ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa_4096 ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa_4096
@@ -111,11 +110,18 @@ In an X2Go session, go to *Applications>Internet>Remote Viewer>Connection>New* a
## Data backup ## Data backup
[`rsync`](https://linux.die.net/man/1/rsync) is recommended for users that would just like to periodically backup their $HOME directory to a local machine. [`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`: `rsync -azH --delete username@hartmanlab.genetics.uab.edu:/home/username/ home-backup/` * Copy a user's `$HOME`' directory locally to `/home-backup`: `rsync -azH --delete username@hartmanlab.genetics.uab.edu:/home/username/ home-backup/`
* Copy a shared directory locally `rsync -azh username@hartmanlab.genetics.uab.edu:/mnt/data/scans/20250723_roessler_project .` * Copy a shared directory locally `rsync -azh username@hartmanlab.genetics.uab.edu:/mnt/data/scans/20250723_roessler_project .`
## Troubleshooting
* Reset your X2Go sessions: `script-user-reset-x2go`
* Reset your X2Go desktop: `script-user-reset-desktop`
* Change your user login password: `passwd`
* Change your samba password: `smbpasswd`
## Resources ## Resources
* [RHEL documentation](https://access.redhat.com/documentation/en/red-hat-enterprise-linux/) * [RHEL documentation](https://access.redhat.com/documentation/en/red-hat-enterprise-linux/)
@@ -126,12 +132,12 @@ In an X2Go session, go to *Applications>Internet>Remote Viewer>Connection>New* a
## Platform ## Platform
* AlmaLinux 9.6 w/ Linux 6.1 LTS Hyperscale SIG kernel * AlmaLinux 9.6 w/ Linux 6.1 LTS Hyperscale SIG kernel
* Intel Xeon X99 E5-2650v4 CPU * Intel Xeon X99 E5-2650v4 12-core CPU
* 96GB RAM * 96GB DDR4 RAM
* 4TB PCIE3 NVMe SSD: `/`, `/home` * 4TB PCIe 3.0 NVMe SSD: `/`, `/home`
* 20TB btrfs raid1 array: `/mnt/data` * 20TB btrfs raid1 array: `/mnt/data`
* 20TB btrfs raid1 backup array: `/mnt/backup` * 20TB btrfs raid1 backup array: `/mnt/backup`
## Administrators ## Administrators
See additional documentation in [`docs/README.md`](docs/README.md) See additional documentation in [`docs/README.md`](docs/README.md).

16
docs/README.md
View File

@@ -19,12 +19,15 @@ Type `sudo script-` and use tab completion to access the following helper progra
* Reset permissions on `/mnt/data` if no path is provided. * Reset permissions on `/mnt/data` if no path is provided.
* Use as a last resort to reset original permissions for shared data. * Use as a last resort to reset original permissions for shared data.
* `sudo script-system-scheduled-restart <OnCalendar>` * `sudo script-system-scheduled-restart <OnCalendar>`
* If not provided, defaults to `*-*-* 01:30:00` (1:30 AM). * If `<OnCalendar>` not provided, defaults to `*-*-* 01:30:00` (1:30 AM).
* See [Calendar Events](https://www.freedesktop.org/software/systemd/man/systemd.time.html) for formatting. * See [Calendar Events](https://www.freedesktop.org/software/systemd/man/systemd.time.html) for formatting.
* Alerts users via `notify-send` (X2Go), `wall` (SSH), and adds a reminder to the MOTD. * Alerts users via `notify-send` (X2Go), `wall` (SSH), and adds a reminder to the MOTD.
* `sudo script-user-reset-desktop <username>` * `sudo script-user-reset-desktop <username>`
* Reset a user’s desktop (MATE configuration) to default. * Reset a user’s desktop (MATE configuration) to default.
* Can also be run in user mode (without `sudo`) for personal accounts. * Can also be run in user mode (without `sudo`) for personal accounts.
* `sudo script-system-update`
* Update the server using the system package manager.
* Best to run prior to scheduled reboot.
## Cockpit Server Administration ## Cockpit Server Administration
@@ -32,9 +35,9 @@ Graphical system settings tool for monitoring and performing common tasks.
In an X2Go session, via a web browser at [`http://localhost:9090`](http://localhost:9090) In an X2Go session, via a web browser at [`http://localhost:9090`](http://localhost:9090)
## Deploying `stow` server configuration packages ## Deploying `stow` server packages
Server scripts and configs are organized using [GNU Stow](https://www.gnu.org/software/stow/manual/stow.html) packages and can be deployed directly from this directory. Server scripts and configs are organized using [GNU Stow](https://www.gnu.org/software/stow/manual/stow.html) packages and can be deployed from [the root directory](../).
* Deploy system-wide MATE layout and themes: `sudo stow --adopt -R -t / theme` * Deploy system-wide MATE layout and themes: `sudo stow --adopt -R -t / theme`
* Deploy system-wide scripts: `sudo stow --adopt -R -t / scripts` * Deploy system-wide scripts: `sudo stow --adopt -R -t / scripts`
@@ -68,7 +71,7 @@ Login via `ssh` or `cat /etc/motd` to view current service statuses.
* Add the UAB DNS servers (`138.26.5.2`, `138.26.5.66`) to the Windows network config to access UAB resources. * Add the UAB DNS servers (`138.26.5.2`, `138.26.5.66`) to the Windows network config to access UAB resources.
#### Allow Access to Samba Share (Windows Bug Workaround) #### Enable Access to Samba Share (Windows Bug Workaround)
1. Open `C:\Windows\system32\drivers\etc\hosts` and copy its contents. 1. Open `C:\Windows\system32\drivers\etc\hosts` and copy its contents.
2. Paste into a new text document and add the appropriate `blazerid` and server IP lines. 2. Paste into a new text document and add the appropriate `blazerid` and server IP lines.
@@ -87,3 +90,8 @@ Login via `ssh` or `cat /etc/motd` to view current service statuses.
* Add 20 GB to the Windows VM: `sudo qemu-img resize /var/lib/libvirt/images/win11-5900.qcow2 +20G` * Add 20 GB to the Windows VM: `sudo qemu-img resize /var/lib/libvirt/images/win11-5900.qcow2 +20G`
* Add GParted ISO as boot device and expand the working partition. * Add GParted ISO as boot device and expand the working partition.
## Fixing no local display
Periodically the GPU hardware resets and crashes the local display manager.
To fix, login via ssh and run: `sudo systemctl restart lightdm`