aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md33
1 files changed, 23 insertions, 10 deletions
diff --git a/README.md b/README.md
index 89ef139..ad70912 100644
--- a/README.md
+++ b/README.md
@@ -15,45 +15,58 @@ Server. I run this on a Raspberry Pi 4B running Ubuntu.
## Installation
-1. Copy the files over to your server:
+### 1. Copy the files over to your server
+
```sh
scp compose.yaml <username>@<server>:/home/<username>/compose.yaml
scp setup-plex.sh <username>@<server>:/home/<username>/setup-plex.sh
```
-2. SSH into your server:
+### 2. SSH into your server
+
```sh
ssh <username>@<server>
```
-3. Set the plex claim token (get a claim token at https://www.plex.tv/claim/):
+### 3. Set the plex claim token
+
+Get a claim token at https://www.plex.tv/claim/
+
```sh
sed 's|PLEX_CLAIM=<your-plex-claim-token>|PLEX_CLAIM=your-actual-token-here|' compose.yaml > compose.yaml.tmp \
&& mv compose.yaml.tmp compose.yaml
```
-4. Additionally, the timezone is hard-coded to 'America/New_York'. If that's not
-your timezone, adjust it in the `compose.yaml` file:
+### 4. Adjust hard-coded timezone if necessary
+
+The timezone is hard-coded to 'America/New_York'. If that's not your timezone,
+adjust it in the `compose.yaml` file.
+
```sh
sed 's|TZ=America/New_York|TZ=your-timezone-here|' compose.yaml > compose.yaml.tmp \
&& mv compose.yaml.tmp compose.yaml
```
-5. Run the installation script to set up an fstab entry for a external hard drive
-and install docker:
+### 5. Run the installation script
+
+This will set up a fstab entry for a external hard drive and install docker.
```sh
chmod +x setup-plex.sh
sudo ./setup-plex.sh
```
-6. After the fstab entry is added, ensure the drive is mounted for the external
-hard drive:
+### 6. Ensure external drive is mounted
+
+After the fstab entry is added, ensure the drive is mounted for the external
+hard drive.
+
```sh
sudo mount -a
```
-7. Now, finally, we can start plex:
+### 7. Start Plex
+
```bash
docker compose up --detach
```