Skip to content

Commit ad997d2

Browse files
tbaka-devMagda Sulik
andauthored
[Update] Plex OCA (#7208)
* plex distro and deployment updates * editorial review * Update index.md remove version listing from options, add to include software --------- Co-authored-by: Magda Sulik <you@example.com>
1 parent 432bfbe commit ad997d2

File tree

1 file changed

+33
-65
lines changed
  • docs/marketplace-docs/guides/plex

1 file changed

+33
-65
lines changed

docs/marketplace-docs/guides/plex/index.md

Lines changed: 33 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Deploy Plex Media Server through the Linode Marketplace"
33
description: "Stream your personal media collection to nearly any device with your own Plex Media Server using Linode Marketplace Apps."
44
published: 2020-09-28
5-
modified: 2024-06-06
5+
modified: 2025-02-19
66
keywords: ['streaming','plex','video','media server']
77
tags: ["debian","docker","marketplace", "web applications","linode platform", "cloud manager"]
88
image: Deploy_Plex_oneclickapps.png
@@ -20,7 +20,7 @@ marketplace_app_name: "Plex Media Server"
2020

2121
## Why Use Plex Media Server
2222

23-
Owning a Plex Media Server enables you to maintain a personal media library in addition to accessing [Plex's own content](https://mediaverse.plex.tv/), all available to stream to nearly [any device](https://www.plex.tv/apps-devices/). The ability to stream your own media is a unique advantage over other streaming services like [Netflix](https://www.netflix.com/), and comes only at the cost of your Linode services. Additional features, including local downloading, bandwidth limiting, and hardware transcoding are also available through the paid [Plex Pass](https://www.plex.tv/plex-pass/) service.
23+
Owning a Plex Media Server enables you to maintain a personal media library in addition to accessing [Plex's own content](https://mediaverse.plex.tv/), all available to stream to nearly [any device](https://www.plex.tv/apps-devices/). The ability to stream your own media is a unique advantage over other streaming services like [Netflix](https://www.netflix.com/), and comes only at the cost of your Akamai cloud computing services. Additional features, including local downloading, bandwidth limiting, and hardware transcoding are also available through the paid [Plex Pass](https://www.plex.tv/plex-pass/) service.
2424

2525
## Deploying a Marketplace App
2626

@@ -34,109 +34,75 @@ Owning a Plex Media Server enables you to maintain a personal media library in a
3434

3535
## Configuration Options
3636

37-
- **Supported distributions:** Debian 10
38-
- **Recommended minimum plan:** 4GB Dedicated CPU or Shared Compute Instance
37+
- **Supported distributions:** Ubuntu 24.04 LTS
38+
- **Suggested minimum plan:** 4GB Dedicated CPU or Shared Compute Instance
3939

4040
### Plex Options
41+
{{% content "marketplace-required-limited-user-fields-shortguide" %}}
42+
- **SOA Email Address:** *(required)*: Enter an email address you want to use for generating the SSL certificates and configuring the server and DNS records.
4143

42-
The following configuration options create a secure [Limited User](/docs/products/compute/compute-instances/guides/set-up-and-secure/#add-a-limited-user-account) to run your Plex Media Server.
43-
44-
{{< note >}}
45-
- As a security measure, [root login over SSH](/docs/products/compute/compute-instances/guides/set-up-and-secure/#ssh-daemon-options) is disabled for this App. Use your Limited User credentials to access your Linode via SSH instead.
46-
- The Limited User configurations below are for your Linode's [Linux user](/docs/guides/linux-users-and-groups/), which is distinct from your [Plex account user](https://www.plex.tv/sign-up/).
47-
{{< /note >}}
48-
49-
- **Limited User Name** *(required)*: Enter your preferred username for the limited user. If the username `root` is specified, a limited user is not created and extra security features are not configured.
50-
- **Limited User Password** *(required)*: Enter a *strong* password for the new user.
51-
- **Limited User SSH Key:** If you wish to log in as the limited user through public key authentication (without entering a password), enter your public key here. See [Creating an SSH Key Pair and Configuring Public Key Authentication on a Server](/docs/guides/use-public-key-authentication-with-ssh/) for instructions on generating a key pair.
44+
{{% content "marketplace-custom-domain-fields-shortguide" %}}
5245

5346
{{% content "marketplace-special-character-limitations-shortguide" %}}
5447

5548
## Getting Started After Deployment
5649

5750
After your Plex Server has been deployed, you can upload media and configure access to your Plex Server from Plex clients for your media devices.
5851

59-
Before you begin, ensure that you have signed up for a [Plex account](https://www.plex.tv/sign-up/).
52+
Before you begin, ensure that you signed up to [Plex](https://www.plex.tv/sign-up/).
6053

6154
### Initial Setup
6255

63-
Administration of your Plex Server is performed from its web interface. Before you can connect to the web interface from your workstation, you first need to create an SSH tunnel to your Linode.
64-
65-
{{< note >}}
66-
This guide occasionally directs you to substitute variables beginning with `$` in certain commands.
67-
68-
An easy way to make these substitutions is to set the variables in your shell, then simply copy the commands as they are provided in this guide — your shell automatically substitutes the `$` variables in those commands with the values you have set.
69-
70-
For example, you can set configure a substitution for `$IP_ADDRESS` like so:
71-
72-
IP_ADDRESS=192.0.2.0
73-
74-
Your shell then interprets `$IP_ADDRESS` as the value you have provided in following commands, for example:
75-
76-
echo $IP_ADDRESS
77-
78-
```output
79-
192.0.2.0
80-
```
81-
{{< /note >}}
82-
83-
1. From your workstation [terminal](/docs/guides/using-the-terminal/), enter the following the command, substituting `$USERNAME` with your Linux [Limited User Name](#plex-marketplace-app-options), and `$IP_ADDRESS` with the [IP address](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) of your Plex Server Linode:
84-
85-
ssh $USERNAME@$IP_ADDRESS -L 8888:localhost:32400
86-
87-
You now have an established SSH connection to your Plex Server Linode in your terminal, and can also access the Plex web interface from your workstation browser.
88-
89-
1. Enter `http://localhost:8888/web` into your workstation browser to access the Plex Server setup web interface. Enter your Plex account username and password to proceed with the setup.
90-
56+
Administration of your Plex Server is performed from its web interface. Open a web browser and go to the custom domain provided during deployment, or the instance's default rDNS.
9157
![Plex Login Screen](plex-login.png "Plex login screen.")
9258

93-
1. Give your Plex Server a name. Be sure to leave the **Allow me to access my media outside my home** box **checked**, and select **NEXT**.
59+
1. Enter a name for your Plex server and select the **Allow me to access my media outside my home** checkbox. Click **NEXT**.
9460

9561
![Plex Server Setup - Name](initial-setup-set-hostname.png "Plex Server Setup - Name.")
9662

97-
1. Skip Media Library setup by selecting **NEXT** for now. You will [Upload Media](#upload-media) and [Add Media Libraries](#add-media-libraries) in the sections below.
63+
1. Skip Media Library setup by clicking **NEXT**. You will [Upload Media](#uploading-media) and [Add Media Libraries](#adding-media-libraries) in the sections below.
9864

9965
![Plex Server Setup - Skip Add Media Library](initial-setup-skip-media-library.png "Plex Server Setup - Skip Add Media Library.")
10066

101-
1. Finish initial setup and reach the Plex home screen by selecting **DONE**.
67+
1. To finish the initial setup, click **DONE**.
10268

10369
![Plex Server Setup - Finish](initial-setup-finish.png "Plex Server Setup - Finish.")
10470

105-
1. Click on the **Settings** icon in top-right corner of the Plex web interface.
71+
1. Click the **Settings** icon in top-right corner of the Plex web interface.
10672

10773
![Plex Settings Icon](initial-setup-settings-icon.png "Plex Settings Icon.")
10874

109-
1. On the left side bar, ensure that your new Plex Server is selected and select **Remote Access** under the **Settings** section.
75+
1. On the left side bar, ensure that your new Plex Server is selected and in the **Settings** section, select **Remote Access**.
11076

11177
![Plex Server Remote Access Settings](initial-setup-remote-access.png "Plex Remote Access Settings.")
11278

113-
1. Click the check box next to **Manually specify public port**, keep the default value of `32400`, and select **RETRY** or **APPLY**. You may need to select **SHOW ADVANCED** to see these settings.
79+
1. Select the **Manually specify public port** checkbox and keep the default value of `32400`. Click **Retry** or **Apply**. You may need to select **Show advanced** to see these settings.
11480

11581
![Enable Plex Server Remote Access](initial-setup-enable-remote-access.png "Enable Plex Server Remote Access.")
11682

117-
1. Wait until you see a message stating that your Plex Server is **Fully accessible outside your network**.
83+
1. Wait until you see a message stating that your Plex Server is *Fully accessible outside your network*.
11884

11985
![Plex Server Remote Access Successful](initial-setup-remote-access-success.png "Plex Server Remote Access Successful.")
12086

121-
You can now access [uploaded media](#upload-media) and manage your Plex Server from any Plex Client, such as the [Plex Web App](https://app.plex.tv). If you are unable to reach your Plex Server remotely, you can repeat the steps in this section to re-establish a direct connection for administrative purposes.
87+
You can now access [uploaded media](#uploading-media) and manage your Plex Server from any Plex Client, such as the [Plex Web App](https://app.plex.tv). If you are unable to reach your Plex Server remotely, you can repeat the steps in this section to re-establish a direct connection for administrative purposes.
12288

123-
### (Optional) Connect a Linode Block Storage Volume
89+
### (Optional) Connecting a Linode Block Storage Volume
12490

12591
If your media collection is larger than the space available from your Linode plan, [Block Storage](/docs/products/storage/block-storage/) is a convenient solution. This section outlines the steps for creating and connecting a Block Storage Volume for use with your Plex Server.
12692

12793
{{< note >}}
12894
For future reference, you can find examples of the instructions provided in this section in Cloud Manager by navigating to [**Volumes**](https://cloud.linode.com/volumes), then selecting **Show Configuration** from the option menu for your Volume.
12995
{{< /note >}}
13096

131-
1. [View, Create, and Delete Block Storage Volumes](/docs/products/storage/block-storage/guides/manage-volumes/) if you do not already have one prepared.
97+
1. [View, Create, and Delete Block Storage Volumes](/docs/products/storage/block-storage/guides/manage-volumes/) if you don't have one already prepared.
13298

13399
1. Establish an SSH connection to your Plex Server Linode as your [Limited User](#plex-marketplace-app-options).
134100

135101
1. On your Plex Server Linode, create a directory to your Volume's mountpoint:
136102

137103
mkdir ~/plex/media/linode-volume
138104

139-
1. Mount your Volume path to the mountpoint you have created, substituting `$FILE_SYSTEM_PATH` with your Volume's file system path (which is viewable from Cloud Manager's [**Volumes**](https://cloud.linode.com/volumes) dashboard):
105+
1. Mount your Volume path to the mountpoint you have created, substituting `$FILE_SYSTEM_PATH` with your Volume's file system path (which you can get in the Cloud Manager's [**Volumes**](https://cloud.linode.com/volumes) dashboard):
140106

141107
sudo mount $FILE_SYSTEM_PATH ~/plex/media/linode-volume
142108

@@ -167,9 +133,9 @@ For future reference, you can find examples of the instructions provided in this
167133
168134
docker restart plex
169135
170-
Media on your Volume is now accessible through the Plex web interface at the mounted directory on your Linode. Next, follow the instructions below on how to [Upload Media](#upload-media) to your Volume (use your Volume's mountpoint instead of creating a new subdirectory), and [Add Media Libraries](#add-media-libraries) to enable streaming media stored on your Volume.
136+
Media on your Volume is now accessible through the Plex web interface at the mounted directory on your Linode. Next, follow the instructions below on how to [Upload Media](#uploading-media) to your Volume (use your Volume's mountpoint instead of creating a new subdirectory), and [Add Media Libraries](#adding-media-libraries) to enable streaming media stored on your Volume.
171137
172-
### Upload Media
138+
### Uploading Media
173139
174140
Your Plex Server is set up to access media files in the `~/plex/media` directory. You have many options for uploading or downloading media to your Plex Server. This section shows you how to organize and upload files to your Plex Server using the `scp` command.
175141
@@ -185,31 +151,31 @@ This section directs you to run commands either on your Plex Server Linode throu
185151
186152
scp example_video.mp4 $USERNAME@$IP_ADDRESS:~/plex/media/movies
187153
188-
Depending on the file size(s), this may take a few minutes.
154+
Depending on the files' size, this may take a few minutes.
189155
190156
{{< note >}}
191157
There are other ways to upload files to your Plex Server Linode. See our section in [Linux System Administration Basics](/docs/guides/linux-system-administration-basics/#upload-files-to-a-remote-server) for more information.
192158
{{< /note >}}
193159
194-
### Add Media Libraries
160+
### Adding Media Libraries
195161
196-
1. Log into a Plex Client, such as the [Plex Web App](https://app.plex.tv), then select the **MORE >** link on the Plex side bar.
162+
1. Log into a Plex Client, such as the [Plex Web App](https://app.plex.tv), and on the side bar, click **More**.
197163
198164
![Plex Home Side Bar — More](media-library-side-bar.png "Plex Home Side Bar — More.")
199165
200-
1. Hover over your Plex Server's name in the Plex side bar, then select the **+** icon.
166+
1. Hover over your Plex Server's name in the Plex side bar and click **+**.
201167
202168
![Add Media Library — Start](media-library-add.png "Add Media Library — Start.")
203169
204-
1. Select your library type, set the name for your media library, select your language, then select the **NEXT** button.
170+
1. Select your library type, set a name and language for your media library. Click **Next**.
205171
206172
![Set Media Library Type, Name, and Language](media-library-type-name-language.png "Set Media Library Type, Name, and Language.")
207173
208-
1. Click **BROWSE FOR MEDIA FOLDER**, navigate to the directory within `/media` where your files are stored, then select the **ADD** button.
174+
1. Click **Browse for media folder**. Go to the directory within `/media` where your files are stored and click **Add**.
209175
210176
![Select Media Library Directory](media-library-select-directory.png "Select Media Library Directory.")
211177
212-
1. Once you are satisfied with your selection, select the **ADD LIBRARY** button.
178+
1. Once you are satisfied with your selection, click **Add library**.
213179
214180
![Add Media Library — Finish](media-library-finish.png "Add Media Library — Finish.")
215181
@@ -227,7 +193,9 @@ The Plex Marketplace App installs the following required software on your Linode
227193
228194
| **Software** | **Description** |
229195
|:--------------|:------------|
230-
| [**Docker Engine**](https://docs.docker.com/engine/) | Docker Engine is an open source containerization technology for building and containerizing your applications. This Marketplace App deploys Plex Media Server as a Docker container. |
231-
| [**Plex Media Server**](https://hub.docker.com/r/plexinc/pms-docker/) | The Plex Media Server transmits locally-stored media files, enabling you to stream your personal media collection to any device that can support a [Plex Client](https://www.plex.tv/apps-devices/). |
196+
| [**NGINX**](https://www.nginx.com/) | Open Source webserver and reverse proxy. See our guide on [Getting Started with NGINX](/docs/guides/getting-started-with-nginx-part-1-installation-and-basic-setup/) for more information. |
197+
| [**UFW**](https://wiki.ubuntu.com/UncomplicatedFirewall) | Firewall utility. Ports 22/tcp, 80/tcp, and 443/tcp for IPv4 and IPv6 are enabled with installation of this app. Additional ports must be opened to send email from your Linode for use with this app. To learn more, see [How to Configure a Firewall with UFW](/docs/guides/configure-firewall-with-ufw/). |
198+
| [**Plex Media Server**](https://hub.docker.com/r/plexinc/pms-docker/) | The Plex Media Server transmits locally-stored media files, enabling you to stream your personal media collection to any device that can support a [Plex Client](https://www.plex.tv/apps-devices/). The Latest release in Plex's Public Main branch is installed by this deployment. |
199+
232200
233201
{{% content "marketplace-update-note-shortguide" %}}

0 commit comments

Comments
 (0)