Documentation

Every part of RKHM, written down.

50 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 Soon File Manager upload, the PHP selector and the cron UI DirectAdmin Soon Document root, PHP version and cron on DirectAdmin hosts Plesk Soon Extensions, PHP settings and scheduled tasks under Plesk GoDaddy Soon Working within the limits of GoDaddy shared hosting Ubuntu Soon A clean VPS to a running platform, from the command line Docker Soon Running it in containers, and where the media lives AWS Soon EC2, RDS and S3 — and which of them you can skip DigitalOcean Soon Droplets, Spaces and the managed database option Windows Soon A local WAMP install for testing before you go live

50 articles · 10 sections

Get started 6

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

Setup your app The pass through settings everyone makes after installing 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 Soon Pricing your platform in the currency your buyers use

Server & 3rd-party tools 5

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 Soon SMTP setup and which events send a message FFmpeg Demos, waveforms and transcoding — static build included WebP Serving smaller images without touching your originals youtube-dl Pulling audio from public sources Meilisearch Soon Pointing the search index at a Meilisearch instance

Automation 8

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 Spotify Scrapper Music Pulling artist and album data from Spotify Spotify changes Music What changed in Spotify's API and what it affects Radio Soon Automation as it applies to live stations Audiobook Soon Automation as it applies to books and chapters Podcast Soon Automation as it applies to shows and episodes 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

Content 7

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 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

Interface 0

The look and navigation of the site, beyond a single page.

Logo & brand Soon Swapping the logo, favicon and brand colours MenuBuilder Soon Building the header and footer navigation Themes Soon Installing, switching and building a theme

Users 3

Roles, moderators and what a subscription unlocks.

Roles Deciding what guests, users and creators may do Manager Handing moderators a slice of the admin panel Moderator Soon What a moderator can see and do day to day Subscription system Plans, pricing and what each tier unlocks

Monetization 0

The ways a platform built on RKHM actually makes money.

Ads Soon Banner and audio advertising for non-subscribers Gateways Soon How the 17 payment gateways are set up and priced Store Soon Running a private or community storefront

Mobile 4

The same platform as an installable and native app.

Gestures The touch vocabulary the client understands PWA Soon Installing the site as an offline-capable app Settings Soon What is configurable about the mobile experience 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

Plugins 6

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 Music Soon Albums, singles, artists and the music catalogue Podcast Soon Shows, episodes, feeds and podcaster accounts Radio Soon Live stations, streams and the always-on player Audiobook Soon Books, chapters and resuming where you left off Beat Soon Instrumentals, packs and licence tiers Lorem AI Generating art, copy and metadata in place Bulk Importer Bringing an existing library in one pass Wikipedia Scrapper Soon Filling artist and album metadata from Wikipedia Sitemap generator Keeping search engines aware of new content NFT Token-gated albums and the secondary market Extra Gateways Soon The payment gateways beyond the built-in set Affiliate Soon Paying users for the traffic they bring in User Points Soon Points and medals for being active on the platform Messenger Soon Direct messaging between members

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