Skip to content
Get packs

Guide · Open source

How to use Flarum: install, set up and run a forum

Updated · written with AI from the project's own documentation and checked against our catalogue data

Flarum is open-source forum software that you install on your own website to host discussions for a community. This guide explains what it is, what you need before you start, how to get the code, and where the official installation steps live. By the end, you will know whether Flarum fits your site and how to begin setting it up.

Flarumflarum/flarum · ★ 16.4k · MIT

Quick start

  1. 1Confirm your server supports PHP. Check that you have a PHP server environment ready. The README does not give a version, so confirm requirements in the official guide.
  2. 2Read the installation guide. Open docs.flarum.org/install and follow the steps for setting up Flarum.
  3. 3Clone the repository. Run git clone https://github.com/flarum/flarum.git to download the skeleton application.
  4. 4Set up the application. Follow the installation guide to configure the application on your server.
  5. 5Ask for help if needed. Use the documentation, the community forum at discuss.flarum.org, or the Discord chat when you get stuck.

What is Flarum and who is it for?

Flarum describes itself as a simple discussion platform for your website. The README says it is fast, easy to use, and designed to be quick to deploy. It is built with PHP, and its interface is powered by Mithril, a JavaScript framework.

The project suits site owners who want a self-hosted discussion board, community managers who want a clean and modern forum interface, and PHP developers who want to customize a forum through its Extension API.

  • Good fit: you want a forum you control on your own website.
  • Good fit: you work with PHP and want to extend the software.
  • Poor fit: you want zero server setup, since Flarum must be installed and hosted.

What you need before you install Flarum

Flarum runs on a PHP server environment. The README does not state which PHP version is required, so check the official installation guide for current requirements before you begin.

You also need a place to host the site. Flarum is not a hosted service, so you must provide and manage the server yourself.

  • A PHP server environment (the required version is not given in the README).
  • A server or hosting account where you can install a PHP application.
  • Access to the installation guide at docs.flarum.org/install.

Get the Flarum code from GitHub

The repository can be cloned with Git. Run the command below in the directory where you want the project to live.

The README notes that this repository holds the Flarum skeleton application, and most development happens in the flarum/core repository.

git clone https://github.com/flarum/flarum.git

Install and configure Flarum

The README does not list the full installation steps. It points to the official Installation guide at docs.flarum.org/install, which is the source to follow for setup on your server.

If you get stuck, the documentation at docs.flarum.org is the main support resource. You can also ask questions on the community forum at discuss.flarum.org or on the Discord chat linked from flarum.org.

  • Installation guide: https://docs.flarum.org/install
  • Documentation: https://docs.flarum.org/
  • Community forum: https://discuss.flarum.org/

Customize Flarum with extensions

Flarum has an Extension API, and the README describes its architecture as flexible. You can use it to customize, extend, and integrate Flarum with your community.

The README does not list specific extensions or features. For the details of the API, read the documentation and the contributing guide at docs.flarum.org/contributing.

Flarum compared with other forum software

Comparable projects include Discourse, NodeBB, phpBB, and Misago. Flarum is distinct in being PHP-based with a Mithril front end. Choose it if that stack suits your team. If you need a non-PHP stack, look at the alternatives, because Flarum is built with PHP.

What people use it for

  • Running a discussion board for a community on your own website.
  • Giving members a clean, modern forum interface that works across devices.
  • Building custom features for a community through the Extension API as a PHP developer.

Frequently asked questions

Is Flarum free to use?

Flarum is open-source software licensed under the MIT License. The README describes the licence, and the license text is in the repository's LICENSE file.

What do I need to install Flarum?

You need a PHP server environment. The README does not state a PHP version, so check the installation guide at docs.flarum.org/install for current requirements.

How do I download Flarum?

Clone the repository with git clone https://github.com/flarum/flarum.git. The README notes that this repo holds the skeleton application.

Is there a hosted version of Flarum?

The README does not describe a hosted service. It says Flarum must be installed and hosted, so you need your own server or hosting account.

What are alternatives to Flarum?

Comparable projects named in the analysis are Discourse, NodeBB, phpBB, and Misago. Pick one based on your preferred stack and features.

Where can I get help with Flarum?

Use the documentation at docs.flarum.org, the community forum at discuss.flarum.org, or the Discord chat linked from flarum.org.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Flarum suits site owners who want a self-hosted, clean discussion board and PHP developers who want to extend it. It is a poor choice if you want zero server setup, a non-PHP stack, or features the README does not describe. Check the installation guide and documentation before committing.

Install options & downloads