Documentation

Every part of RKHM, written down.

77 articles on installing, building and running it — grouped by what you are trying to do, not by when they were written.

Install it Server requirements, the installer, and the cronjob it needs to run. Design it Build every page from widgets bound to your catalogue, without code. Add Content Get audio in, processed and playing — by hand or on a schedule. Make Money Plans, roles, payouts and the six ways the platform makes money.

From a zip file to a running platform

Seven steps, in this order. The installer walks most of it; these pages cover the parts it cannot do for you.

Then the one page about your host

Panels, servers and clouds each get in the way somewhere different. These cover only that difference — the seven steps above are still the installation.

cPanel File Manager upload, the PHP selector and the cron UI DirectAdmin Document root, PHP version and cron on DirectAdmin hosts Plesk Extensions, PHP settings and scheduled tasks under Plesk GoDaddy cPanel setup, PHP, cron, and shared hosting limits Hostinger hPanel setup, PHP, files, database, and cron aaPanel Apache site, PHP extensions, MySQL, and cron CloudPanel NGINX routing, PHP site, database, SSL, and cron CyberPanel OpenLiteSpeed routing, PHP, SSL, and cron Ubuntu A clean VPS to a running platform, from the command line Docker Running it in containers, and where the media lives DigitalOcean Droplet setup, Cloudflare DNS, and optional Spaces Windows A local WAMP install for testing before you go live

77 articles · 10 sections

Get started 9

The handful of pages that answer most first-week questions.

Setup your app The full roadmap: settings, plugins, content, pages, roles, payments and monitoring, in order Demo Importer Import any official demo's theme, plugins and content in one click Statistics What the dashboard's analytics panel actually shows Customize 101 Where the look of the app is actually controlled config_user.php options Every constant in the config file and what flipping it does Updating Moving to a new release without losing your changes Caching What gets cached, where, and how to clear it Language Translating the interface, including right-to-left Currency Pricing your platform in the currency your buyers use

Server & 3rd-party tools 8

The external services and binaries RKHM talks to, and how to wire them up.

Nginx Rewrite rules for servers without .htaccess CloudFlare Settings that break streaming, and the ones that help Email SMTP setup and which events send a message FFmpeg Media conversion, FFprobe checks, and optional static builds WebP Serving smaller images without touching your originals youtube-dl Pulling audio from public sources Meilisearch Pointing the search index at a Meilisearch instance Firewall The built-in request firewall — monitoring vs. blocking mode

Automation 4

Filling a catalogue without typing it in by hand.

Overall Scheduled jobs that keep pulling content in Music Automation as it applies to albums, singles and artists Radio Automation as it applies to live stations Audiobook Automation as it applies to books and chapters Podcast Soon Automation as it applies to shows and episodes

Content 8

Getting audio in, processed, indexed and playing.

Add How records, files and cover art fit together Files What happens to a file between upload and playback Storages Keeping media off-server on FTP, S3 or Spaces File Protection Keep paid media from being downloaded or shared Search How results are built and what makes them better Multimedia files (player) Playback behaviour, queues and what listeners can do Audiowaveform Player Generating the waveform the player shows during playback Comments Letting listeners discuss the content they are on

PageBuilder 5

Compose any page out of widgets bound to your catalogue.

Page Builder Creating a page and dropping your first widgets onto it Content widgets Widgets that list and link the things in your catalogue Design widgets Call-to-actions, headers and layout blocks Other widgets Search, Editor.js and advertisement widgets Shady custom classes Theme Extra classes the default theme understands

Users 4

Roles, moderators and what a subscription unlocks.

Roles Deciding what guests, users and creators may do Manager Artist managers, permissions, and creator payouts Moderator What a moderator can see and do day to day Subscription system Plans, pricing and what each tier unlocks

Monetization 2

The ways a platform built on RKHM actually makes money.

Ads Formats, placements, role-based targeting and campaign budgets Gateways Payment integrations, currency limits, credentials and setup notes

Mobile 5

The same platform as an installable and native app.

Gestures The touch vocabulary the client understands Cordova What the native wrapper is, and whether you need it Cordova app features Cordova What the wrapper adds over the installable web app Building Cordova apps Cordova Compiling and signing your own builds Cordova V1.1.00 Cordova Apps that update themselves: what changed and what to do differently

Plugins 11

Everything that bolts onto the platform — catalogue types, importers, studios and gateways.

Managing plugins Installing, configuring and removing plugins Purchasing add-ons Buying plugins and themes, and installing what you bought Lorem AI Generating art, copy and metadata in place Bulk Importer Bringing an existing library in one pass Sitemap generator Keeping search engines aware of new content NFT Token-gated albums and the secondary market User Points Points and medals for being active on the platform P0dCr8 The AI podcast studio and what it needs from you P0dCr8 installation P0dCr8 Getting the studio running on an existing install P0dCr8 tutorial P0dCr8 Directing the studio through a full episode P0dCr8 pricing P0dCr8 Credits, subscriptions and what an episode costs

Releases & operations 5

Version history, migration notes, and the support process itself.

Shady vs Shady 2 ( beta ) Theme Ten pages, side by side Cordova V1.1.00 ( beta ) Cordova The Cordova release with over-the-air app updates V2.1.20 ( beta ) Every change in the v2.1.20 release, in detail V2.0.75 Every change in the v2.0.75 release, in detail V2.0.67 The mobile-focused v2.0.67 release

Still stuck? Support is handled by the people who wrote the code, not a ticket queue in front of them. Open a ticket Something changed? Every release of every plugin and theme, newest first — and all of them free for the life of your licence. See the changelog