Skip to content

PG Folder Structure

Admin9705 edited this page Aug 25, 2024 · 12 revisions
WANT TO HELP? CLICK THE ★ (STAR LOGO) on the Front Page

1. Introduction

Understanding the PlexGuide folder structure is crucial for effectively managing and troubleshooting your Plex and Docker-based applications. This guide provides an overview of the key directories used by PlexGuide, a tool designed to simplify the deployment and management of media servers, as well as other containerized applications.


2. Data Structure for PlexGuide

PlexGuide organizes its files and configurations into a defined directory structure, which ensures a standardized deployment process. This structure helps maintain consistency across different environments and makes managing your media server infrastructure more intuitive.

A. Primary Folders

  • /pg/download - This directory is used as the central location for storing all downloaded media files. Applications configured through PlexGuide will typically save data here before it is organized or moved to final storage locations. It's important to manage the size of this directory to prevent disk space issues.

B. Functional Folders

  • /pg/scripts - This folder contains all the executable scripts that drive PlexGuide's functionalities. These scripts automate tasks such as setting up Docker containers, configuring applications, and managing system settings. Users can customize or add scripts here to extend PlexGuide's capabilities.

  • /pg/apps - This is where PlexGuide stores the Docker images and configuration files needed to deploy various applications. Each subdirectory under /pg/apps usually corresponds to a specific app or service (e.g., netdata, vaultwarden). This structure allows for easy deployment and management of multiple apps using standardized processes.

  • /pg/config - This folder holds configuration files that define system-wide settings and individual app preferences. Examples include Cloudflare settings, database credentials, and other application-specific configurations. Keeping these files organized helps ensure the system's security and integrity.

  • /pg/stage - The staging area for PlexGuide deployments. This folder temporarily holds files and scripts during the deployment or upgrade processes. It acts as a workspace where updates are prepared before being applied to the live environment, helping minimize downtime and disruptions.

  • /pg/appdata - The default storage location for application data. Each app deployed through PlexGuide will typically store its persistent data in a subdirectory under this path. For example, application logs, configuration files, and database files reside here. By default, the data is accessible and easily backed up, ensuring that user settings and states are preserved across restarts or migrations.


3. Additional Resources

For more information, guides, and community support, check out the following resources:

  • PlexGuide GitHub Wiki - Comprehensive documentation and guides.
  • Discord - Join our community on Discord for real-time support and discussions.
  • Discussions - Engage in conversations, ask questions, and share ideas with other PlexGuide users.

Installing PlexGuide

  1. PlexGuide Install Information

Preplanning & Information

  1. PG Folder Structure

Domain and Port Control

  1. CloudFlare Tunnel

Primary Applications

  1. Plex

Useful Links

  1. PG YouTube Channel
Clone this wiki locally