Plum Get started

Documentation

Getting started

Install Plum and publish your first editable page.

Plum is a mountable Rails engine. During development, add it from a local path or Git source.

gem "plum", path: "../Plum"

Install the engine, Active Storage tables, and database schema:

bundle install
bin/rails generate plum:install --mount-path=/
bin/rails active_storage:install
bin/rails db:migrate

The public site is now available at /, with the control panel at /cp. The generated initializer contains the standalone defaults and examples for embedding Plum in a host application.

Choose a theme

Host themes live under app/themes. Set the site's theme handle, create a Pages content type, and publish an entry with the reserved home slug to control the homepage.