Documentation · Every page explained

The complete GPlayer guide.

GPlayer is a self-hosted Node.js media gateway. It turns provider links, HLS, DASH, and direct video files into secure, shareable embeds — and ships with a full administration console to manage videos, storage accounts, load balancers, plugins, and every setting of the platform. This page walks through the public home page and each administration screen.

01 / Public surface

The home page

The home page at / is the public face of your GPlayer instance. It is a single screen where anyone (or only authorized visitors, depending on your public settings) can turn a media link into a ready-to-share player.

Header & navigation

The sticky header carries the site name and slogan (both editable in Site settings), anchor links to the page sections, a light/dark theme switcher remembered per visitor, and a link to the source repository.

Player generator

The main form of the page. Paste a main video URL — a supported host link (Google Drive, YouTube, Vimeo, Streamtape…), an HLS/DASH manifest, or a direct file. Optional fields add an alternative fallback source, a poster (URL or upload), a JSON subtitle manifest, and up to ten subtitle tracks (WebVTT, SRT, ASS… by URL or file upload).

Delivery package

After generation the output panel returns four artifacts: the embed URL of the player page, the ready-to-paste iframe code, a download URL for the source file, and a request URL that reproduces the same configuration. A live preview iframe shows the exact player your visitors will get.

Signal path

The workflow section illustrates what happens server-side: the input link is identified, normalized, and wrapped into an encrypted, authenticated player query — provider credentials and real file locations never reach the browser.

Supported hosts

The host wall lists a sample of the 69 registered adapters: cloud drives, video platforms, file hosts, plus generic HLS, MPEG-DASH, and direct video handling.

Footer, sharing & PWA

The footer repeats the navigation and an optional contact link. A share rail posts the page to social networks, and the site installs as a progressive web app with offline fallback when served over HTTPS.

02 / Delivery

Player & embeds

Every generated link resolves to the player page, served under the configurable player path.

Embed page

/{player}/?data=…

The responsive player itself. It reads the encrypted query, resolves the source through the matching host adapter, and plays HLS, DASH, or MP4 with poster, fallback source, and subtitle tracks. Appearance and behavior follow the Player settings.

Saved video slugs

/{player}/{slug}/

Videos saved in the administration get a permanent, human-readable slug so their URL survives source changes — edit the source in the admin and every embed keeps working.

Download & shortlinks

Each package includes a proxied download route, and the optional shortlink service produces compact share URLs when enabled in settings.

03 / Control plane

Administration access

The administration console lives under /administrator/ (the directory name is configurable). Every page below requires an authenticated session.

Login

/administrator/login/

The hardened sign-in boundary. Legacy-compatible bcrypt password checks, session cookies, and brute-force protection guard the whole console.

Registration

/administrator/register/

Self-service account creation, only when enabled in Public settings. New accounts confirm their email; register/resend/ re-sends the confirmation message.

Password reset

/administrator/reset-password/

Email-based password recovery using the SMTP server configured in settings.

04 / Daily operations

Dashboard & core tools

The pages you use every day to monitor the instance and manage who can access it.

Dashboard

/administrator/dashboard/

The landing screen after login: system overview, server status, and shortcuts to the most-used sections, plus quick maintenance actions such as clearing the video cache.

Profile

/administrator/profile/

Edit your own account: display name, email address, and password.

System logs

/administrator/log/

Browse system and request logs: filter by level or source, inspect individual entries, and purge old records.

DMCA

/administrator/dmca/

Handle takedown requests: review reported media and block offending sources from being served again.

Users

/administrator/users/

The administrator account list. users/new/ creates an account, users/edit/ changes role, status, or credentials of an existing one.

Sessions

/administrator/users/sessions/

Every active admin session with device and last-activity details — revoke any session remotely.

05 / Configuration

Settings

Eleven dedicated pages configure the entire platform. All of them live under /administrator/settings/.

General

settings/general/

Core application settings: public URL, timezone, and cache behavior.

Public

settings/public/

Toggles for the public surface: open or restrict the home-page generator, allow self-registration, enable comments, and other visitor-facing features.

Site

settings/site/

Branding of the public pages: site name, slogan, description, colors, and contact link — reflected live on the home page.

Player

settings/player/

Appearance and behavior of the video player: theme, logo, controls, autoplay, and default options applied to every embed.

Hosting

settings/hosting/

Per-provider configuration for the media host adapters: credentials, API keys, and provider-specific options.

SMTP

settings/smtp/

Outgoing email server used for account confirmation and password-reset messages.

Shortlink

settings/shortlink/

Configuration of the URL shortener used for compact share links.

Custom headers

settings/custom-headers/

Extra HTTP headers attached to proxied upstream requests — useful behind CDNs or picky providers.

Misc

settings/misc/

Everything else: domain blacklist, content filters, and default resolution preferences.

Ads

settings/ads/

Monetization: banner slots and VAST tags injected into the player pages.

Reset & maintenance

settings/reset/

Maintenance tools: clear caches, reset settings groups, and database housekeeping operations.

06 / Library

Videos

The saved-video library gives permanent slugs and central management to your media.

Video list

/administrator/videos/list/

Search, sort, and manage every saved video: open its player, edit it, or delete it.

Add a video

/administrator/videos/new/

Save a video with the same options as the public generator — source, fallback, poster, subtitles — plus a custom slug.

Edit a video

/administrator/videos/edit/?id=…

Change any property of a saved video. Existing embeds keep working because the slug stays stable.

Import

/administrator/videos/import/

Bulk-create videos from a CSV file — ideal for migrating an existing catalog.

Export

/administrator/videos/export/

Generate and download a CSV export of the whole library for backup or migration.

Subtitles

/administrator/videos/subtitles/

Manage uploaded subtitle files: list, preview, and delete tracks stored on the server.

07 / Storage

Google Drive

Connect Google Drive accounts to serve files directly and back up media automatically.

Accounts

/administrator/gdrive/

All connected Drive accounts with their status and quota. gdrive/new/ connects an account through OAuth; gdrive/edit/ updates its credentials and options.

File browser

/administrator/gdrive/files/

Browse the files of a connected account and generate players straight from Drive content.

Backups

/administrator/gdrive/backup-files/

The list of media already backed up to Drive, with gdrive/backup-queue/ showing pending and running backup jobs processed by the background worker.

08 / Scale

Load balancers

Distribute streaming traffic across several GPlayer nodes.

Balancer list

/administrator/load-balancers/list/

Every registered node with its health and weight; clear a node's cache remotely from here.

Add a balancer

/administrator/load-balancers/new/

Register a new node by URL and secret so the selector can route playback traffic to it.

Edit a balancer

/administrator/load-balancers/edit/?id=…

Update a node's endpoint, weight, or status, or remove it from rotation.

09 / Extensibility

Plugins

Extend GPlayer with installable plugins.

Installed plugins

/administrator/plugins/list/

Enable, disable, configure, or remove installed plugins. Installation happens from this page's install action.

Plugin configuration

/administrator/plugins/config/?plugin=…

The settings screen a plugin exposes — each plugin registers its own options here.

Sync

/administrator/plugins/sync/

Synchronize with the plugin repository to fetch updates and newly available plugins.

Want to build your own plugin? Read the plugin development guide — manifest, pages, hooks, widgets, and a full example.

← Back to the home page