From ecc505328275b4a2c834359c7853ad009427089e Mon Sep 17 00:00:00 2001 From: Peter Wood Date: Fri, 27 Sep 2024 08:30:52 -0400 Subject: [PATCH] documenting the shell/plex.sh script --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 8cc24c1..d898e17 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # shell + Shell commands + +# plex.sh + +This script is used to manage the Plex Media Server service on a systemd-based Linux distribution. It provides the following functionalities: + +- **start**: Starts the Plex Media Server. +- **stop**: Stops the Plex Media Server. +- **restart**: Restarts the Plex Media Server. +- **status**: Displays the current status of the Plex Media Server. + +## Usage + +Note that these commands will run as `root`. + +```shell +./shell/plex.sh {start|stop|restart|status} +```