diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..f72d529 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,48 @@ +name: ci + +on: + push: + branches: + - main + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + + - uses: actions/setup-python@v5 + with: + python-version: 3.x + + - name: Create replacements.yml + run: | + echo "meta:" > replacements.yml + echo " username: ${{ github.repository_owner }}" >> replacements.yml + echo " repo_name: ${{ github.event.repository.name }}" >> replacements.yml + echo " year: $(date +'%Y')" >> replacements.yml + echo " full_repo: ${{ github.repository }}" >> replacements.yml + cat replacements.yml + + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + + - uses: actions/cache@v4 + with: + key: requirements-${{ env.cache_id }} + path: .cache + restore-keys: | + requirements- + + - run: | + pip install -r requirements.txt + pip install git+https://github.com/SivagiriVisakan/mkdocs-replace-plugin.git + + - run: mkdocs gh-deploy --force diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d44afd0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 MisterCalvin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d6fd141 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Plex Guide Template + +Built with Material for MKDocs, deployed and hosted via Github Pages. TODO: Fill out README with links to useful videos, add links to MKDocs plugins, other misc things diff --git a/docs/assets/images/change-email.webp b/docs/assets/images/change-email.webp new file mode 100644 index 0000000..a2afd5b Binary files /dev/null and b/docs/assets/images/change-email.webp differ diff --git a/docs/assets/images/change-stream-quality-apple-tv.webp b/docs/assets/images/change-stream-quality-apple-tv.webp new file mode 100644 index 0000000..964cb38 Binary files /dev/null and b/docs/assets/images/change-stream-quality-apple-tv.webp differ diff --git a/docs/assets/images/change-stream-quality-ios-android.webp b/docs/assets/images/change-stream-quality-ios-android.webp new file mode 100644 index 0000000..8bb194f Binary files /dev/null and b/docs/assets/images/change-stream-quality-ios-android.webp differ diff --git a/docs/assets/images/change-stream-quality-stream-boxes.webp b/docs/assets/images/change-stream-quality-stream-boxes.webp new file mode 100644 index 0000000..a9a70de Binary files /dev/null and b/docs/assets/images/change-stream-quality-stream-boxes.webp differ diff --git a/docs/assets/images/change-stream-quality-web-browser.webp b/docs/assets/images/change-stream-quality-web-browser.webp new file mode 100644 index 0000000..721bed9 Binary files /dev/null and b/docs/assets/images/change-stream-quality-web-browser.webp differ diff --git a/docs/assets/images/custom-newsletter.webp b/docs/assets/images/custom-newsletter.webp new file mode 100644 index 0000000..bd9605f Binary files /dev/null and b/docs/assets/images/custom-newsletter.webp differ diff --git a/docs/assets/images/disable-online-media-sources.webp b/docs/assets/images/disable-online-media-sources.webp new file mode 100644 index 0000000..f7c0d64 Binary files /dev/null and b/docs/assets/images/disable-online-media-sources.webp differ diff --git a/docs/assets/images/forgot-password.webp b/docs/assets/images/forgot-password.webp new file mode 100644 index 0000000..b8ae998 Binary files /dev/null and b/docs/assets/images/forgot-password.webp differ diff --git a/docs/assets/images/guide-logo-dark.webp b/docs/assets/images/guide-logo-dark.webp new file mode 100644 index 0000000..0ea5f14 Binary files /dev/null and b/docs/assets/images/guide-logo-dark.webp differ diff --git a/docs/assets/images/guide-logo-light.webp b/docs/assets/images/guide-logo-light.webp new file mode 100644 index 0000000..1e324cc Binary files /dev/null and b/docs/assets/images/guide-logo-light.webp differ diff --git a/docs/assets/images/overseerr-release-dates.webp b/docs/assets/images/overseerr-release-dates.webp new file mode 100644 index 0000000..625dd60 Binary files /dev/null and b/docs/assets/images/overseerr-release-dates.webp differ diff --git a/docs/assets/images/pinning-libraries-1.webp b/docs/assets/images/pinning-libraries-1.webp new file mode 100644 index 0000000..5bf23fc Binary files /dev/null and b/docs/assets/images/pinning-libraries-1.webp differ diff --git a/docs/assets/images/pinning-libraries-2.webp b/docs/assets/images/pinning-libraries-2.webp new file mode 100644 index 0000000..7de3663 Binary files /dev/null and b/docs/assets/images/pinning-libraries-2.webp differ diff --git a/docs/assets/images/plex-logo.webp b/docs/assets/images/plex-logo.webp new file mode 100644 index 0000000..3c7a96f Binary files /dev/null and b/docs/assets/images/plex-logo.webp differ diff --git a/docs/assets/images/secure-connections-example.webp b/docs/assets/images/secure-connections-example.webp new file mode 100644 index 0000000..4d45d28 Binary files /dev/null and b/docs/assets/images/secure-connections-example.webp differ diff --git a/docs/assets/images/unsubscribe-from-plex-newsletter.webp b/docs/assets/images/unsubscribe-from-plex-newsletter.webp new file mode 100644 index 0000000..a49225d Binary files /dev/null and b/docs/assets/images/unsubscribe-from-plex-newsletter.webp differ diff --git a/docs/assets/images/why-bitrate-matters.webp b/docs/assets/images/why-bitrate-matters.webp new file mode 100644 index 0000000..3d835d6 Binary files /dev/null and b/docs/assets/images/why-bitrate-matters.webp differ diff --git a/docs/assets/video/dale-go-to-hell.webm b/docs/assets/video/dale-go-to-hell.webm new file mode 100644 index 0000000..46b1506 Binary files /dev/null and b/docs/assets/video/dale-go-to-hell.webm differ diff --git a/docs/assets/video/overseerr-reporting-issues.webm b/docs/assets/video/overseerr-reporting-issues.webm new file mode 100644 index 0000000..5cf4f46 Binary files /dev/null and b/docs/assets/video/overseerr-reporting-issues.webm differ diff --git a/docs/changing-stream-quality/index.md b/docs/changing-stream-quality/index.md new file mode 100644 index 0000000..69e1ca8 --- /dev/null +++ b/docs/changing-stream-quality/index.md @@ -0,0 +1,13 @@ +# Changing Plex Streaming Quality + +By default, Plex sets video quality to 720p on all new devices. While this conservative setting ensures broad compatibility, it's not optimal for several reasons: + +1. Most devices today can handle higher quality streams +2. Downscaling 1080p content to 720p reduces video quality +3. [Transcoding](../faq/what-is-transcoding.md) (converting) video from 1080p to 720p creates unnecessary load on the server + +!!! tip + For the best viewing experience, you should adjust your quality settings to "Maximum" or at least "1080p" if your internet connection can support it. The sections in the table of contents to your left will show you how to do this on different devices. + +!!! note + You'll need to change this setting once for each new Plex app you use (phone, TV, web browser, etc.). After that, the setting will be remembered for that device. diff --git a/docs/changing-stream-quality/ios-android.md b/docs/changing-stream-quality/ios-android.md new file mode 100644 index 0000000..8ed5833 --- /dev/null +++ b/docs/changing-stream-quality/ios-android.md @@ -0,0 +1,7 @@ +# Changing Plex streaming quality: iOS & Android + +!!! example "iOS & Android" + + ![Example](../assets/images/change-stream-quality-ios-android.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) diff --git a/docs/changing-stream-quality/streaming-devices.md b/docs/changing-stream-quality/streaming-devices.md new file mode 100644 index 0000000..aa4f4c1 --- /dev/null +++ b/docs/changing-stream-quality/streaming-devices.md @@ -0,0 +1,7 @@ +# Changing Plex streaming quality: Amazon Fire TV, Android TV, PlayStation 4/5, Xbox, Roku, Smart TV (LG, Samsung, VIZIO) + +!!! example "Amazon Fire TV, Android TV, PlayStation 4/5, Xbox, Roku, Smart TV (LG, Samsung, VIZIO)" + + ![Example](../assets/images/change-stream-quality-stream-boxes.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) diff --git a/docs/changing-stream-quality/tv-os.md b/docs/changing-stream-quality/tv-os.md new file mode 100644 index 0000000..f209856 --- /dev/null +++ b/docs/changing-stream-quality/tv-os.md @@ -0,0 +1,7 @@ +# Changing Plex streaming quality: tvOS (Apple TV) + +!!! example "tvOS (Apple TV)" + + ![Example](../assets/images/change-stream-quality-apple-tv.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) diff --git a/docs/changing-stream-quality/web-browser.md b/docs/changing-stream-quality/web-browser.md new file mode 100644 index 0000000..a8e8519 --- /dev/null +++ b/docs/changing-stream-quality/web-browser.md @@ -0,0 +1,7 @@ +# Changing Plex streaming quality: Web Browser + +!!! example "Web Browser" + + ![Example](../assets/images/change-stream-quality-web-browser.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) diff --git a/docs/disabling-online-media-sources.md b/docs/disabling-online-media-sources.md new file mode 100644 index 0000000..4336fea --- /dev/null +++ b/docs/disabling-online-media-sources.md @@ -0,0 +1,9 @@ +# Disabling Online Media Sources + +Plex offers additional services like Live TV, Music, and Web Shows that you may see in your sidebar. If you're only interested in accessing my Movie and TV Show libraries, you can disable or unpin these extra services to keep your interface clean and focused. This can be done through your Plex application settings and helps prevent confusion between my content and Plex's online services. + +!!! example "How-to: Disabling Online Media Sources" + + ![Example](assets/images/disable-online-media-sources.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) diff --git a/docs/faq/adding-to-universal-watchlist.md b/docs/faq/adding-to-universal-watchlist.md new file mode 100644 index 0000000..465fe41 --- /dev/null +++ b/docs/faq/adding-to-universal-watchlist.md @@ -0,0 +1,22 @@ +# How do I add items to my Plex Universal Watchlist? + +!!! quote + It’s easy to add content to your Universal Watchlist from a number of places: + + - Movies or TV shows in a Plex Media Server library (not individual seasons or episodes) + - Plex’s free Movies & Shows streaming content + - Content you find in the Discover source + - Via the player when watching trailers + + From any of those sources: + + - On Movie and TV show library or universal detail screens, you click on the Add to Watchlist button + - On mobile and TV grid views you can long press on a Movie or show poster to see the Add to Watchlist option + - In the web app click on the options menu on the bottom right of a trailer, show or movie poster/thumb + - From search results menu in the desktop/web app click the menu to the right of each result + - During trailer playback from the Discover source an Add to Watchlist button is located on near the playback controls + - If you select a non-Plex streaming service to watch a TV show from the universal details page, when you return to Plex it will ask you if you want to add that show to your Watchlist so you can quickly access the show in the future to watch more episodes. Plex can automatically remove shows and movies from the Watchlist if played within Plex Movies & Shows. Items watched on other services will need to be managed manually. + + If an item is already on your Watchlist, the option will be displayed as Remove from Watchlist. + + **Source**: [Plex: Universal Watchlist](https://support.plex.tv/articles/universal-watchlist/#:~:text=On%20Movie%20and%20TV%20show,show%20or%20movie%20poster%2Fthumb) diff --git a/docs/faq/can-i-share-your-plex.md b/docs/faq/can-i-share-your-plex.md new file mode 100644 index 0000000..0f8395f --- /dev/null +++ b/docs/faq/can-i-share-your-plex.md @@ -0,0 +1,8 @@ +# Sharing Access to the Server + +!!! important + Please do not share my Plex server or your account with others, with one exception: + + - You may share with your spouse or significant other + +If you know someone who would like access to the server, please speak with me directly. diff --git a/docs/faq/content-issues.md b/docs/faq/content-issues.md new file mode 100644 index 0000000..458d2aa --- /dev/null +++ b/docs/faq/content-issues.md @@ -0,0 +1,29 @@ +# I'm having a problem with a Movie or TV Show + +If you encounter any problems with content (such as distorted video, incorrect media, double images, or misaligned subtitles), you have two ways to report it: + +## Using Overseerr (Preferred Method) + + 1. Visit [request.mydomain.com](https://request.mydomain.com) + 2. Find the problematic Movie or TV Show + 3. Click the yellow exclamation point icon in the top right + 4. Enter the details of the issue + + While this method isn't required, it helps me track and resolve issues more effectively by creating a searchable history of reported problems. + +!!! example "Reporting issues within Overseerr" +
+ +## Why use Overseerr for reporting? + +- Creates a documented history of the issue +- Helps me track problems I can't fix immediately +- Makes it easier to identify patterns in content issues +- Provides all the necessary details in one place + +## Direct Contact + + - You can always contact me directly about any issues + - This is perfectly fine and works too! diff --git a/docs/faq/forgot-password.md b/docs/faq/forgot-password.md new file mode 100644 index 0000000..c90f5f5 --- /dev/null +++ b/docs/faq/forgot-password.md @@ -0,0 +1,16 @@ +# Help, I forgot my Plex password! + +!!! quote + If you’ve forgotten your password and need to have it reset, you can find a Forgot? link on email sign-in form. + + ![Forgot password](../assets/images/forgot-password.webp){ width="498" } + /// caption + Forgot password? + /// + + Enter your email address and submit the form. If the address matches an existing, active Plex account, an email will be sent that contains instructions on resetting the account password. + + !!! note + If there is no Plex account matching the submitted address or if you have deleted your Plex account, then no email will be sent. + + **Related Page**: [Plex: Forgot Password?](https://app.plex.tv/auth#?resetPassword) diff --git a/docs/faq/how-can-i-support-you.md b/docs/faq/how-can-i-support-you.md new file mode 100644 index 0000000..513b850 --- /dev/null +++ b/docs/faq/how-can-i-support-you.md @@ -0,0 +1,22 @@ +# Supporting the Server + +## Donations +My Plex server is and will always be completely free. No donations or payments will ever be accepted - just enjoy the content! + +## Plex Pass (Optional) +If you're enjoying Plex, you might want to consider getting a [Plex Pass](https://www.plex.tv/plex-pass/). While I don't receive any compensation, it offers several premium features: + +* Download content for offline viewing +* Auto-skip intros and credits +* Access to Live TV +* And more! + +### Plex Pass Subscription Options +- Monthly: Around $5 +- **Recommended:** Lifetime subscription + - Usually $120 + - Often discounted to $80-90 during Black Friday sales + - Best value if you plan to use Plex long-term + +!!! note + Plex Pass is completely optional - you don't need it to access and enjoy my server's content. diff --git a/docs/faq/i-dont-want-to-use-overseerr.md b/docs/faq/i-dont-want-to-use-overseerr.md new file mode 100644 index 0000000..d9c81f5 --- /dev/null +++ b/docs/faq/i-dont-want-to-use-overseerr.md @@ -0,0 +1,6 @@ +# I don't want to use this request thingy, can't I just tell you what I want? + +!!! tip +
diff --git a/docs/faq/missing-emails.md b/docs/faq/missing-emails.md new file mode 100644 index 0000000..2b55f18 --- /dev/null +++ b/docs/faq/missing-emails.md @@ -0,0 +1,29 @@ +# Missing Confirmation Emails + +## Expected Notifications +When you request content, you should receive two automated emails: + +1. Request approval confirmation +2. Content availability notification when ready to stream + +## Troubleshooting Missing Emails +If you're not receiving these notifications, it's likely because: + +- You may have signed up for Plex using an old or inactive email address +- Your email settings in Plex need to be updated + +## How to Update Your Email +To fix this, you'll need to update the email address associated with your Plex account. + +!!! quote + Once signed in to your Plex account, you can manage your account information at any time from Plex Web App. Click the top right user menu and then choose Account. Here, you’ll be able to edit and manage various aspects of your Plex account. + + ![Plex Email](../assets/images/change-email.webp){ width="800" } + /// caption + Plex account email + /// + + **Related Page**: [Plex Web App: Account Page](https://app.plex.tv/desktop#!/settings/account) + +!!! note + After updating your email, new request notifications will be sent to your updated address. diff --git a/docs/faq/missing-requests.md b/docs/faq/missing-requests.md new file mode 100644 index 0000000..1f0238f --- /dev/null +++ b/docs/faq/missing-requests.md @@ -0,0 +1,17 @@ +# I requested something an hour ago but it hasn't shown up yet. Why? + +When requesting content at [request.sbotnas.io](https://request.sbotnas.io), you'll see three important dates: + +![Overseerr Release Dates](../assets/images/overseerr-release-dates.webp){ width="320" } +/// caption +Release dates within request.sbotnas.io +/// + +1. Theatrical Release - When it hits theaters +2. Digital Release - When it's available to stream/purchase digitally +3. Physical Release - When DVDs/Blu-rays are available + +!!! important + Content typically won't be available on Plex until after its Digital Release date. When requesting new content, always check the Digital Release date in Overseerr's "Release Dates" column to know when it will be available. + +There are rare exceptions to this rule, but generally, if your requested content isn't showing up in Plex, verify that its Digital Release date has passed. diff --git a/docs/faq/responsible-content-requests.md b/docs/faq/responsible-content-requests.md new file mode 100644 index 0000000..002f514 --- /dev/null +++ b/docs/faq/responsible-content-requests.md @@ -0,0 +1,26 @@ +# Responsible Content Requesting + +## Understanding How Plex Works +Unlike streaming services like Netflix or Disney+, my Plex server runs on physical hardware at my home. Every Movie and TV Show you request is stored on hard drives that I maintain and pay for. While I'm happy to provide this service, it's important to understand that storage space isn't infinite! + +## Request Guidelines +I encourage you to request content you're genuinely interested in watching. Here are some tips for responsible requesting: + +* Try to watch content you've requested +* Consider pacing your requests with your viewing habits +* Feel free to request whatever interests you, but be mindful of requesting large amounts of content you may not get to + +## Life Happens +I completely understand that: + +* You might lose interest in something you requested +* Life gets busy and you can't watch everything +* Your viewing preferences might change + +This is all perfectly normal! These guidelines aren't strict rules - they're just to help everyone understand how the server works and to make the most of our shared resource. + +## Questions? +If you're unsure about requesting something or have questions about how much to request, feel free to reach out to me. I'm always happy to help! + +!!! note + Remember: This is a free service I provide because I enjoy sharing content with friends and family. Being mindful of your requests helps me maintain the server effectively for everyone. diff --git a/docs/faq/special-requests.md b/docs/faq/special-requests.md new file mode 100644 index 0000000..71e37d4 --- /dev/null +++ b/docs/faq/special-requests.md @@ -0,0 +1,20 @@ +# Content Quality and Language Options + +## Default Settings +By default, all content on my Plex server has: + +- 1080p resolution +- English audio track +- English subtitles (when available) + +## Special Requests +If you need any of the following, please contact me privately: + +- 4K versions +- Specific audio languages +- Additional subtitle languages +- Alternate cuts or versions +- Additional features such as DVD commentaries or extras + +!!! note + Special requests may take additional time to process and could require additional storage space. I'll do my best to accommodate your needs. diff --git a/docs/faq/what-is-transcoding.md b/docs/faq/what-is-transcoding.md new file mode 100644 index 0000000..bd9f8fc --- /dev/null +++ b/docs/faq/what-is-transcoding.md @@ -0,0 +1,12 @@ +# What is Transcoding? + +!!! quote "What is transcoding?" + Great question, Transcoding is Plex's secret sauce. It makes sure that whatever the device you are on, it will transcode the tiny bits that make up a video into a format that your client can understand and display. This is true for both video and audio formats. + + ## Why is Transcoding not preferred? + Another great question. Transcoding effects picture quality while also taking adverse effects on the server that is sending the digital bits. It has to shrink the bits and then send them to your client. Imagine if it didn't have to change the bits? It just sent them. + + ## What's in it for me? + Quicker loading times, you press play and the video will start sooner than if the server had to change all the bits. Faster video scrubbing (Fast FWD/RWD), meaning skipping ahead and rewinding will be quicker. More people can enjoy the server if the server doesn't have to work as hard and you get the highest quality picture you can. Hence this site was created to educate users on the optimal settings for Plex for the best experience. + + **Source**: [mediaclients.wiki/Plex](https://mediaclients.wiki/Plex) diff --git a/docs/faq/why-bitrate-matters.md b/docs/faq/why-bitrate-matters.md new file mode 100644 index 0000000..5458939 --- /dev/null +++ b/docs/faq/why-bitrate-matters.md @@ -0,0 +1,7 @@ +# Why Bitrate Matters + +!!! info "Technical Guide: Why Bitrate Matters" + + ![Example](../assets/images/why-bitrate-matters.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) diff --git a/docs/faq/why-do-i-to-buy-plex-app.md b/docs/faq/why-do-i-to-buy-plex-app.md new file mode 100644 index 0000000..876201d --- /dev/null +++ b/docs/faq/why-do-i-to-buy-plex-app.md @@ -0,0 +1,7 @@ +# Why do I need to buy the Plex app on my phone? + +!!! quote + + Our mobile apps (Android and iOS) can be used for free, but have limitations. Until the mobile app is unlocked (through an in-app purchase or a Plex Pass subscription), video and music streamed from a Plex Media Server has a 1 minute playback limit, and photos will be watermarked. + + **Source**: [Plex: Free vs Paid](https://support.plex.tv/articles/202526943-plex-free-vs-paid/) \ No newline at end of file diff --git a/docs/faq/wont-stop-buffering.md b/docs/faq/wont-stop-buffering.md new file mode 100644 index 0000000..6361a05 --- /dev/null +++ b/docs/faq/wont-stop-buffering.md @@ -0,0 +1,21 @@ +# My video won't stop buffering + +If you're experiencing constant buffering, there are two common solutions: + +### 1. Lower Your Streaming Quality {: .no-toc } + +Your internet connection might need a lower quality setting: + +* Your internet speed might not support maximum resolution streaming +* Try reducing the quality to 1080p or 720p +* See the [Changing Plex streaming quality](../changing-stream-quality/index.md) page for detailed instructions on changing the streaming quality for different devices + +### 2. Check Your Subtitles {: .no-toc } + +Subtitle processing can cause buffering: + +* Plex can sometimes struggle with subtitle processing +* If you have subtitles enabled, try disabling them temporarily +* This often resolves buffering issues immediately + +Still having trouble? Feel free to reach out to me privately for help troubleshooting the issue. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..4f5e55d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,11 @@ +--- +title: Preamble +--- +# + +![Logo](assets/images/guide-logo-dark.webp#only-dark) +![Logo](assets/images/guide-logo-light.webp#only-light) + +This guide details common tasks you'll need to perform when joining my Plex server for the first time. The content herein should answer 99% of your questions, though you're always welcome to ask me directly. While this guide primarily shows screenshots from a web browser, you can make these changes from any Plex app (mobile, smart TV, or game console). If you have trouble finding a particular setting, I recommend switching to a web browser to make the changes. All settings in this guide will sync across your devices and only need to be configured once, with one important exception: Plex streaming quality must be set separately the first time you log into each new Plex application. +

+While you don't need to read this guide from start to finish, new Plex users should at least review the essential sections on [Pinning Libraries](pinning-libraries.md) and [Changing Plex streaming quality](changing-stream-quality/index.md). diff --git a/docs/pinning-libraries.md b/docs/pinning-libraries.md new file mode 100644 index 0000000..8383854 --- /dev/null +++ b/docs/pinning-libraries.md @@ -0,0 +1,19 @@ +# Pinning Libraries + +After accepting your invitation to my Plex server, you'll need to pin my shared libraries to your sidebar. This is a required step - without it, you might only see Plex's default content instead of my media collection. Here's what you need to know: + +1. Look for "'s Plex" in your media sources +2. You'll see two libraries: Movies and TV Shows +3. Pin both of these libraries to your sidebar + +**Recommended**: Unpin Plex's default libraries to keep your Home screen focused on my content. This is especially important since Plex has been increasingly promoting their own content in 2025, making it harder to distinguish between their media and mine. + +!!! tip + If you see any advertisements while watching, you're viewing Plex's content, not mine. My server never shows ads. + +!!! example "How-to: Pinning Libraries" + + ![Example](assets/images/pinning-libraries-1.webp) + ![Example](assets/images/pinning-libraries-2.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) diff --git a/docs/plex-safety.md b/docs/plex-safety.md new file mode 100644 index 0000000..a0f2dc5 --- /dev/null +++ b/docs/plex-safety.md @@ -0,0 +1,7 @@ +# Is Plex safe to use? + +Yes, connecting to and using my Plex server is completely safe. Your connection is protected by the same type of security that banks use for online banking, with encryption that updates automatically every 90 days to stay secure. All of your personal information - including your username, what you watch, and your viewing history - is only visible to you and me. I also use a professional content delivery network (CDN) that both improves performance and adds an extra layer of security to protect your privacy. + +!!! example "Secure connection example" + + ![Example](assets/images/secure-connections-example.webp) diff --git a/docs/requesting-content.md b/docs/requesting-content.md new file mode 100644 index 0000000..6b240cb --- /dev/null +++ b/docs/requesting-content.md @@ -0,0 +1,18 @@ +# Requesting Content + +You can request new Movies or TV Shows in two ways: + +1. Visit [request.mydomain.com](https://request.mydomain.com) to make direct requests. These are typically approved within 10-15 minutes, and if the content has been released digitally, it will be ready to stream on Plex within 10 minutes. +2. Add content to your Plex Universal Watchlist, and it will be automatically requested for you. + +!!! important + For the auto-request feature to work with your Watchlist, you must log into request.mydomain.com at least once every 90 days. If you don't log in regularly, the system won't be able to see your Watchlist, and I won't know what content you're waiting for. + +## Additional Information +For more details about requesting content, check out these FAQ pages: + +- [Responsible Content Requesting](faq/responsible-content-requests.md) - Understanding how the server works and best practices when requesting content +- [I requested something an hour ago but it hasn't shown up yet. Why?](faq/missing-requests.md) - Release dates and availability within request.mydomain.com +- [I'm having a problem with a Movie or TV Show](faq/content-issues.md) - Reporting issues with Movies or TV Shows +- [Content Quality and Language Options](faq/special-requests.md) - Media quality defaults, language tracks, and special content requests +- [I don't want to use this request thingy, can't I just text you what I want?](faq/i-dont-want-to-use-overseerr.md) - Why we use a request system diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..ff0c46f --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,17 @@ +:root { + --md-admonition-icon--important: url('data:image/svg+xml;charset=utf-8,') + } + .md-typeset .admonition.important, + .md-typeset details.important { + border-color: rgb(220, 53, 69); + } + .md-typeset .important > .admonition-title, + .md-typeset .important > summary { + background-color: rgba(220, 53, 69, 0.1); + } + .md-typeset .important > .admonition-title::before, + .md-typeset .important > summary::before { + background-color: rgb(220, 53, 69); + -webkit-mask-image: var(--md-admonition-icon--important); + mask-image: var(--md-admonition-icon--important); + } diff --git a/docs/unsubscribe-from-plex-newsletter.md b/docs/unsubscribe-from-plex-newsletter.md new file mode 100644 index 0000000..77d6f1c --- /dev/null +++ b/docs/unsubscribe-from-plex-newsletter.md @@ -0,0 +1,23 @@ +# Managing Newsletter Subscriptions + +## Plex's Official Newsletter +New Plex accounts are automatically subscribed to Plex's company newsletter. This is managed by Plex directly and is not controlled by my server. You can unsubscribe from this through your Plex account settings. + +!!! example "How-to: Unsubscribing from Plex's Newsletter" + + ![Example](assets/images/unsubscribe-from-plex-newsletter.webp) + + **Source**: [plxplainers.xyz](https://www.plxplainers.xyz/) + +## My Weekly Newsletter +I send out a separate, personal newsletter every Friday at 5:00 PM. You can identify it by: + +- Email address sending this newsletter will be `noreply@mydomain.com` +- Links to newsletter.plex.mydomain.com +- The newsletter itself will have a logo with the name of my Plex server + +If you'd like to unsubscribe from my newsletter, please contact me privately. + +!!! example "newsletter.plex.mydomain.com" + + ![Example](assets/images/custom-newsletter.webp) diff --git a/docs/useful-links.md b/docs/useful-links.md new file mode 100644 index 0000000..0ce47db --- /dev/null +++ b/docs/useful-links.md @@ -0,0 +1,6 @@ +# Useful Links + +[plxplainers.xyz](https://www.plxplainers.xyz/)
+[mediaclients.wiki/Plex](https://mediaclients.wiki/Plex)
+[request.mydomain.com](https://request.mydomain.com/)
+[zombo.com](https://www.zombo.com/) diff --git a/docs/what-is-plex.md b/docs/what-is-plex.md new file mode 100644 index 0000000..3fabfcc --- /dev/null +++ b/docs/what-is-plex.md @@ -0,0 +1,23 @@ +# What is Plex? + +Plex is a media streaming platform that turns a computer into your personal Netflix-like service. When installed on a server, it creates a polished interface for watching Movies and TV Shows from any device, whether you're at home or away. By joining my Plex server, you get access to my media library without needing to set up or maintain your own server. + +!!! quote "What is Plex?" + + ## An Introduction + Plex gives you one place to find and access all the media that matters to you. From personal media on your own server, to free and on-demand Movies & Shows or live TV, to streaming music, you can enjoy it all in one app, on any device. + + ## And, it’s really simple to start using… + First, if you are streaming content provided by us or one of our partners (Movies & Shows, live TV, TIDAL music), then you are good to go as soon as you have an account, just install an app on your phone, Smart TV, computer, or simply open up our web app on your browser! + + If you are looking to set up your own personal media server to house your own video or music files, there are a few more (simple!) steps to get up and running. + + How it works for your own personal content: + + 1. Install and run the Plex Media Server on a computer (or compatible NAS device or NVIDIA SHIELD) where all your media is stored and managed in movie, TV show, home video, music, and photo libraries. + 2. Add media libraries by type of content and let Plex do the rest—cataloging, adding artwork and info—it’s all automatic. + 3. Install and open the Plex app on virtually any device—smartphone, tablet, smart TV, streaming device, game console, personal computer, or any browser. + 4. Wherever you are, press play, sit back, and enjoy your media as it streams from the Plex Media Server to your device. + + + **Source**: [Plex: What is Plex?](https://support.plex.tv/articles/200288286-what-is-plex/) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..2ae3082 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,111 @@ +site_name: "{{ meta.username }}.github.io" +site_url: "https://{{ meta.username }}.github.io" +theme: + name: material + logo: assets/images/plex-logo.webp + features: + #- navigation.tabs + #- navigation.sections + - navigation.instant + - navigation.instant.prefetch + - navigation.footer + - navigation.indexes + - navigation.tracking + - navigation.top + - toc.integrate + - search.suggest + - search.highlight + - content.tabs.link + - content.code.annotation + - content.code.copy + language: en + palette: + - scheme: slate + toggle: + icon: material/toggle-switch + name: Switch to light mode + primary: teal + accent: lime + - scheme: default + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + primary: teal + accent: purple + +nav: + - Preamble: index.md + - What is Plex?: what-is-plex.md + - Is Plex safe to use?: plex-safety.md + - Pinning Libraries: pinning-libraries.md + - Managing Newsletter Subscriptions: unsubscribe-from-plex-newsletter.md + - Disabling Online Media Sources: disabling-online-media-sources.md + - Requesting Content: requesting-content.md + - Changing Plex streaming quality: + - changing-stream-quality/index.md + - iOS & Android: changing-stream-quality/ios-android.md + - tvOS (Apple TV): changing-stream-quality/tv-os.md + - Amazon Fire TV, Android TV, PlayStation 4/5, Xbox, Roku, Smart TV (LG, Samsung, VIZIO): changing-stream-quality/streaming-devices.md + - Web Browser: changing-stream-quality/web-browser.md + - FAQ: + - What is transcoding?: faq/what-is-transcoding.md + - Why do I need to buy the Plex app on my phone?: faq/why-do-i-to-buy-plex-app.md + - My video won't stop buffering: faq/wont-stop-buffering.md + - Help, I forgot my Plex password!: faq/forgot-password.md + - How do I add items to my Plex Universal Watchlist?: faq/adding-to-universal-watchlist.md + - Responsible Content Requesting: faq/responsible-content-requests.md + - I requested something an hour ago but it hasn't shown up yet. Why?: faq/missing-requests.md + - I'm having a problem with a Movie or TV Show: faq/content-issues.md + - Content Quality and Language Options: faq/special-requests.md + - I don't want to use this request thingy, can't I just text you what I want?: faq/i-dont-want-to-use-overseerr.md + - Missing Confirmation Emails: faq/missing-emails.md + - Can I share your Plex server with someone else?: faq/can-i-share-your-plex.md + - Plex is awesome! Can I send you some money to support it?: faq/how-can-i-support-you.md + - Why Bitrate Matters: faq/why-bitrate-matters.md + - Useful Links: useful-links.md + +plugins: + - search + - mkdocs-video + - git-revision-date-localized + - git-committers: + repository: "{{ meta.full_repo }}" + branch: main + - replace + +markdown_extensions: + - toc: + toc_depth: 1 + - pymdownx.blocks.caption + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - admonition + - pymdownx.arithmatex: + generic: true + - footnotes + - pymdownx.details + - pymdownx.superfences + - pymdownx.mark + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + +copyright: "Copyright © {{ meta.year }} {{ meta.username }}" + +extra_css: + - stylesheets/extra.css + +extra: + social: + - icon: fontawesome/brands/github + link: "https://github.com/{{ meta.username }}" + name: "{{ meta.username }} @ Github" + - icon: fontawesome/brands/discord + link: https://discord.com + name: Discord Channel + - icon: fontawesome/solid/globe + link: "https://{{ meta.username }}.github.io" + name: Personal Website diff --git a/replacements.yml b/replacements.yml new file mode 100644 index 0000000..a11e509 --- /dev/null +++ b/replacements.yml @@ -0,0 +1,5 @@ +meta: + username: your-github-username + repo_name: mkdocs-plex-guide-template + site_name: your-site-name + year: "2025" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..968f434 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,21 @@ +# Material Theme requirements +# Requirements for core +mkdocs~=1.6 +mkdocs-material~=9.6.4 +mkdocs-material-extensions~=1.3 +mkdocs-get-deps~=0.2.0 +mkdocs-video~=1.5.0 +pygments~=2.18.0 +pymdown-extensions~=10.14.3 +jinja2~=3.0 +markdown~=3.2 + +# Requirements for plugins +babel~=2.10 +colorama~=0.4 +paginate~=0.5 +regex>=2022.4 +requests~=2.26 +mkdocs-git-revision-date-localized-plugin +mkdocs-git-committers-plugin-2~=2.5.0 +git+https://github.com/SivagiriVisakan/mkdocs-replace-plugin.git