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

Update README

Browse Source
This commit is contained in:
Bryan Roessler
2021-10-22 19:26:57 -04:00
parent 4ec7299cba
commit 0772962b57
2 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.html
View File

@@ -1424,9 +1424,13 @@ Reason: Outside collaboration/(Other reason)
<p>Most popular SFTP programs support using public-private keys for passwordless authentication. Windows/OSX users may need to add their key pair to PuTTy/Filezilla/WinSCP manually.</p> <p>Most popular SFTP programs support using public-private keys for passwordless authentication. Windows/OSX users may need to add their key pair to PuTTy/Filezilla/WinSCP manually.</p>
<p>Once configured, the user will no longer need to enter their password to access the SFTP or X2Go server, which simplifies login and enhances security.</p> <p>Once configured, the user will no longer need to enter their password to access the SFTP or X2Go server, which simplifies login and enhances security.</p>
<h2 id="for-administrators">For administrators</h2> <h2 id="for-administrators">For administrators</h2>
<ul>
<li>Type <code>scripts-</code> and use <code>tab</code> completion in the CLI to access the following customized helper programs.</li>
<li>Run them with administrator privileges using <code>sudo</code>.</li>
</ul>
<h3 id="adding-a-user">Adding a user</h3> <h3 id="adding-a-user">Adding a user</h3>
<ul> <ul>
<li><code>sudo script-user-add</code> <code>username</code> <em><code>password</code></em> <li><code>script-user-add</code> <code>username</code> <em><code>password</code></em>
<ul> <ul>
<li>Optionally pass a second argument <em><code>password</code></em> to create a user's password for them. If omitted, the default password is equal to the <em><code>username</code></em>.</li> <li>Optionally pass a second argument <em><code>password</code></em> to create a user's password for them. If omitted, the default password is equal to the <em><code>username</code></em>.</li>
<li><code>username</code> can be anything, but ideally a unique string of small capital letters.</li> <li><code>username</code> can be anything, but ideally a unique string of small capital letters.</li>
@@ -1435,7 +1439,7 @@ Reason: Outside collaboration/(Other reason)
</ul> </ul>
<h3 id="resetting-a-user-password">Resetting a user password</h3> <h3 id="resetting-a-user-password">Resetting a user password</h3>
<ul> <ul>
<li><code>sudo script-user-reset-password</code> <code>username</code> <em><code>password</code></em> <li><code>script-user-reset-password</code> <code>username</code> <em><code>password</code></em>
<ul> <ul>
<li>If a user forgets their password this will reset it to <em><code>password</code></em>, or if <em><code>password</code></em> is omitted, to the <code>username</code>. 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.</li> <li>If a user forgets their password this will reset it to <em><code>password</code></em>, or if <em><code>password</code></em> is omitted, to the <code>username</code>. 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.</li>
</ul> </ul>
@@ -1443,7 +1447,7 @@ Reason: Outside collaboration/(Other reason)
</ul> </ul>
<h3 id="removing-a-user">Removing a user</h3> <h3 id="removing-a-user">Removing a user</h3>
<ul> <ul>
<li><code>sudo script-user-remove</code> <em><code>username</code></em> <li><code>script-user-remove</code> <em><code>username</code></em>
<ul> <ul>
<li>This will allow you to optionally backup user files to the array before user deletion.</li> <li>This will allow you to optionally backup user files to the array before user deletion.</li>
</ul> </ul>
@@ -1483,8 +1487,8 @@ Reason: Outside collaboration/(Other reason)
<ul> <ul>
<li>Start: <code>sudo systemctl start smb.service</code></li> <li>Start: <code>sudo systemctl start smb.service</code></li>
<li>Stop: <code>sudo systemctl stop smb.service</code></li> <li>Stop: <code>sudo systemctl stop smb.service</code></li>
<li>Start at boot: <code>sudo systemctl enable smb.service</code></li> <li>Enable at boot: <code>sudo systemctl enable smb.service</code></li>
<li>Do not start at boot: <code>sudo systemctl disable smb.service</code></li> <li>Disable at boot: <code>sudo systemctl disable smb.service</code></li>
<li>Restart service: <code>sudo systemctl restart smb.service</code></li> <li>Restart service: <code>sudo systemctl restart smb.service</code></li>
<li>Reload services: <code>sudo systemctl daemon-reload</code></li> <li>Reload services: <code>sudo systemctl daemon-reload</code></li>
<li>Read service: <code>sudo systemctl cat smb.service</code></li> <li>Read service: <code>sudo systemctl cat smb.service</code></li>
@@ -1529,7 +1533,7 @@ slmgr -ato
</ul> </ul>
<h3 id="updating-all-software">Updating all software</h3> <h3 id="updating-all-software">Updating all software</h3>
<ul> <ul>
<li><code>sudo script-system-update</code> <li><code>script-system-update</code>
<ul> <ul>
<li>The server regularly installs security updates unattended</li> <li>The server regularly installs security updates unattended</li>
<li>If the kernel, java, systemd, or other major components are updated, the system should be restarted.</li> <li>If the kernel, java, systemd, or other major components are updated, the system should be restarted.</li>
@@ -1538,17 +1542,17 @@ slmgr -ato
</ul> </ul>
<h3 id="scheduling-a-restart">Scheduling a restart</h3> <h3 id="scheduling-a-restart">Scheduling a restart</h3>
<ul> <ul>
<li><code>sudo script-system-scheduled-restart</code> <em><code>OnCalendar</code></em> <li><code>script-system-scheduled-restart</code> <em><code>OnCalendar</code></em>
<ul> <ul>
<li>If a valid <code>OnCalendar</code> is not passed, assumes <code>*-*-* 01:30:00</code> (1:30 AM).</li> <li>If a valid <code>OnCalendar</code> is not passed, assumes <code>*-*-* 01:30:00</code> (1:30 AM).</li>
<li>See <a href="https://www.freedesktop.org/software/systemd/man/systemd.time.html">Calendar Events</a> for proper time format.</li> <li>See <a href="https://www.freedesktop.org/software/systemd/man/systemd.time.html">Calendar Events</a> for time formatting.</li>
<li>This will alert users via <code>notify-send</code> in X2Go, <code>wall</code> in ssh, and add a reminder to the <code>motd</code> about the scheduled restart.</li> <li>This will alert users via <code>notify-send</code> in X2Go, <code>wall</code> in ssh, and add a reminder to the <code>motd</code> about the scheduled restart.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
<h3 id="adding-a-drive">Adding a drive</h3> <h3 id="adding-a-drive">Adding a drive</h3>
<ul> <ul>
<li><s><code>sudo scripts-drive-add</code> <code>/dev/sdX</code></s> (Under construction) <li><s><code>scripts-drive-add</code> <code>/dev/sdX</code></s> (Under construction)
<ul> <ul>
<li>To determine the correct drive, use <code>lsblk -f</code>.</li> <li>To determine the correct drive, use <code>lsblk -f</code>.</li>
</ul> </ul>

2
script-install-manual-scripts
View File

@@ -1,5 +1,5 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# This script will add scripts-* to the PATH and the manual to each user's Desktop # This script will add scripts-* to the PATH and the manual to each user's desktop
# Copyright 2021 Bryan C. Roessler # Copyright 2021 Bryan C. Roessler
parent="${BASH_SOURCE[0]}" parent="${BASH_SOURCE[0]}"