october Documentation

Self-hosted CMS platform based on the Laravel PHP Framework.

11,140 stars PHP PHP 1 file ยท ~2,364 tokens #backend#cmf#cms#cms-platform#framework#laravel#octobercms#php
RAW Doc

1. Project Overview & Quickstart (octobercms/october)

October is a Content Management System (CMS) and web platform whose sole purpose is to make your development workflow simple again. It was born out of frustration with existing systems. We feel building websites has become a convoluted and confusing process that leaves developers unsatisfied. We want to turn you around to the simpler side and get back to basics.

October's mission is to show the world that web development is not rocket science.




Please note: October CMS is open source and every new account includes a complimentary license for the first year. After that, a license is required to continue receiving updates and access the Marketplace ecosystem.

Installing October

Instructions on how to install October can be found at the installation guide.

Quick Start Installation

If you have composer installed, run this in your terminal to install October CMS from command line. This will place the files in a directory named myoctober.

text
composer create-project october/october myoctober

If you plan on using a database, run this command inside the application directory.

text
php artisan october:install

Learning October

The best place to learn October CMS is by reading the documentation or following some tutorials.

You may also watch this introductory video. Make sure to check out our official YouTube channel. There is also the excellent video series by Watch & Learn.

For code examples of building with October CMS, visit the RainLab Plugin Suite or the October Demos Repo.

Coding Standards

Please follow the following guides and code standards:

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Development Team

October CMS was founded in 2014 by Alexey Bobkov and Sam Georges. Today it is supported by a worldwide network of partners and contributors.

Foundation library

The CMS uses Laravel as a foundation PHP framework.

Contact

For announcements and updates:

To chat or hang out:

License

The October CMS platform is licensed software, see End User License Agreement (EULA) for more details.

2. Official Technical Reference & Guides (octobercms/docs)


home: true
widebar: false
pageClass: home-page
sidebar:
-
title: User Guide
icon: ph-duotone ph-book-open-text
collapsable: false
children:
- [/user-guide/quickstart/introduction/welcome, Quick Start]
- [/user-guide/blog/introduction, Creating a Blog]
- [/user-guide/forum/introduction, Creating a Forum]
- [/user-guide/helpdesk/introduction, Creating a Helpdesk]
- [/user-guide/mailing-list/introduction, Creating a Mailing List]
-
title: Documentation
icon: ph-duotone ph-code
collapsable: false
children:
- [/4.x/setup/installation, Installation]
- [/4.x/cms/themes/themes, CMS Guide]
- [/4.x/markup/templating, Markup Guide]
- [/4.x/extend/system/plugins, Extending October CMS]
- [/4.x/element/form-fields, API Handbook]
-
title: Plugins & Themes
icon: ph-duotone ph-puzzle-piece
collapsable: false
children:
- ['https://octobercms.com/plugins', Plugin Marketplace]
- ['https://octobercms.com/themes', Theme Marketplace]
-
title: Resources
icon: ph-duotone ph-link
collapsable: false
children:
- ['https://larajax.org', Larajax Framework]
- ['https://talk.octobercms.com', October Talk]
- ['https://discord.gg/jNaFhfz6FX', Discord]
- ['https://github.com/octobercms', GitHub]

-

title: Docs

collapsable: false

children:

- [/user-guide/quickstart/introduction/welcome, Quick Start]

- [/4.x/cms/themes/themes, CMS Guide]

- [/4.x/markup/templating, Markup Guide]

-

title: Building Features

collapsable: false

children:

- [/user-guide/blog/introduction, Creating a Blog]

- [/user-guide/helpdesk/introduction, Creating a Helpdesk]

- [/user-guide/mailing-list/introduction, Creating a Mailing List]

-

title: Customize

collapsable: false

children:

- [/4.x/extend/system/plugins, Extending October CMS]

- [/4.x/element/form-fields, API Handbook]

-

title: Reference

collapsable: false

children:

- [/4.x/markup/templating, Markup Guide]

- [/4.x/cms/themes/themes, CMS Guide]

-

title: Plugins & Themes

collapsable: false

children:

- ['https://octobercms.com/plugins', Plugin Marketplace]

- ['https://octobercms.com/themes', Theme Marketplace]

-

title: AJAX Framework

collapsable: false

children:

- ['https://larajax.org', Larajax Framework]


Start Here

text
Start Here
    <h2>Install October CMS</h2>
    Build your first project in minutes with our step-by-step guide.
    [Get Started](/user-guide/quickstart/introduction/welcome.html)


    
        <li> Setup your server</li>
        <li> Install October CMS</li>
        <li> Build your first website</li>
    
    Follow our [beginner tutorial](/user-guide/quickstart/introduction/welcome.html) to get up and running fast.

Build Features

text
<SectionCardLink
        icon="ph-duotone ph-paper-plane-tilt"
        title="Creating a Blog"
        description="Build a fully-featured blog with posts, categories, tags, and an RSS feed."
        href="/user-guide/blog/introduction.html" />


    <SectionCardLink
        icon="ph-duotone ph-chats-circle"
        title="Creating a Forum"
        description="Build a community forum with channels, discussion threads, and replies."
        href="/user-guide/forum/introduction.html" />


    <SectionCardLink
        icon="ph-duotone ph-envelope-simple"
        title="Creating a Helpdesk"
        description="Build a fully-featured helpdesk with tickets, categories, tags, and an RSS feed."
        href="/user-guide/helpdesk/introduction.html" />


    <SectionCardLink
        icon="ph-duotone ph-chat-circle-text"
        title="Creating a Mailing List"
        description="Build a mailing list with signup forms, subscriber management, and campaigns."
        href="/user-guide/mailing-list/introduction.html" />

Reference

text
<SectionCardLink
        icon="ph-duotone ph-brackets-curly"
        title="CMS Guide"
        description="Plugins and techniques using file structure with Twig templates."
        href="/4.x/cms/themes/themes.html" />


    <SectionCardLink
        icon="ph-duotone ph-pencil-line"
        title="Markup Guide"
        description="Reference guide for the Twig template syntax for displaying content."
        href="/4.x/markup/templating.html" />

Plugins & Themes

text
<SectionCardLink
        icon="ph-duotone ph-plugs-connected"
        title="Browse Plugins"
        description="Browse plugins both free and paid"
        href="https://octobercms.com/plugins"
        target="_blank"
        cssClass="is-simple" />


    <SectionCardLink
        icon="ph-duotone ph-paint-brush-broad"
        title="Browse Themes"
        description="Browse themes both free and paid"
        href="https://octobercms.com/themes"
        target="_blank"
        cssClass="is-simple" />

Contributing

You can find the published version by visiting the October CMS Docs website. For contributions and translations, you may submit suggestions by clicking the Edit This Page button or contact us directly for support.