Weave Code
Oc Cumuluscore Plugin Laravel Package
initbiz/oc-cumuluscore-plugin
CumulusCore is the foundation plugin for building SaaS applications on October CMS, providing shared models, services, and backend components for multi-tenant setups, plans, subscriptions, and related core functionality. It is designed to be extended by Cumulus-based plugins and custom projects.
OctoberCMS plugin helping developers with creating SaaS applications
Frequently asked questions about Oc Cumuluscore Plugin
- What is initbiz/oc-cumuluscore-plugin used for?
- It is an October CMS plugin that provides the foundation layer for building SaaS applications: a Company (tenant) model, company-user membership pivots with roles, invitations, and hooks for plans and subscriptions. It also ships backend controllers and list/form configuration so you get admin UI for these entities out of the box. It is designed to be extended by Cumulus-based plugins and your own project code rather than used standalone.
- Can I use this package in a plain Laravel application?
- No, it is an October CMS plugin rather than a general-purpose Laravel package. It relies on October's PluginBase registration class, plugin lifecycle, backend controllers, and AJAX handlers, none of which exist in vanilla Laravel. The code is MIT-licensed, so you can read the migrations and models and reuse the domain design in a plain Laravel project, but you cannot install it there as a Composer dependency.
- Which October CMS and Laravel versions does it support?
- The plugin's active era is October CMS v1.x and v2.x on PHP 7.x through 8.1, which maps to Laravel 5.5 through 9. Support for October v3 and Laravel 10+ is not established, so verify composer.json and version.yaml before committing. Because the repository has low activity, do not assume new October releases are tracked.
- How do I install initbiz/oc-cumuluscore-plugin?
- Install it through the October CMS marketplace or with Composer, then run the plugin migrations, which create namespaced tables prefixed initbiz_cumuluscore_. You also need to install and configure RainLab.User, since the plugin depends on it for user records and authentication. Backend navigation and controllers register automatically once the plugin is enabled.
- Does CumulusCore require RainLab.User?
- Yes, RainLab.User is the authentication and user source of truth this plugin builds on. That means you must pin a compatible RainLab.User version, because that plugin is maintained independently and has shipped breaking model and API changes. If you already have a separate identity provider such as SSO or OIDC, you will need to bridge or replace this dependency.
- Is multi-tenancy enforced at the database level?
- No, tenant isolation is applied at the model and application layer, which means your code must scope every query by company. Any query, queued job, console command, or endpoint that forgets the scope can leak data across tenants. For a production SaaS this is the biggest technical risk, so add global scopes, middleware, and explicit cross-tenant tests before going live.
- How does the invitation flow work and is email queued?
- The plugin provides invitation records that link an email address to a company with a role, along with token generation and expiry handling. Review the token generation, expiry, resend behaviour, and email dispatch yourself, because low-activity plugins often send mail synchronously. Move sends onto a queue and confirm tokens are single-use and expire.
- Do I need the oc-cumulus-plugin for billing?
- CumulusCore is designed to pair with the companion initbiz/oc-cumulus-plugin, which handles subscriptions and billing. If you use Stripe or your own subscription service instead, the plan-assignment hooks in CumulusCore become dead weight and must be replaced. Decide this early, because it affects the schema and the backend UI you keep.
- Is this plugin production ready and actively maintained?
- Treat it as low-activity, single-maintainer software with a very small user base, so assume you own the code the day you adopt it. There is no commercial support path and few users to surface bugs. Budget for writing characterization tests and for forking the plugin so October's update mechanism cannot overwrite your patches.
- What are the alternatives if I do not want to depend on it?
- If your stack is October CMS, the realistic alternative is building the company, membership, role, and invitation models yourself, which typically takes several weeks. If your stack is plain Laravel, use a dedicated tenancy package or read this plugin's MIT-licensed migrations as a reference design. Either way, evaluate whether you actually want October CMS in the stack or were only adopting it to get this plugin.
Weaver
How can I help you explore Laravel packages today?