Go to file
Teck Meng 4e0672c84d Update server_name in flarum.conf 2024-03-04 09:01:30 +08:00
nginx Update server_name in flarum.conf 2024-03-04 09:01:30 +08:00
public chore: mark resource protection rule blocks 2024-01-02 16:03:33 +01:00
storage Add directory for storing session data 2018-03-18 15:57:18 +01:00
.editorconfig ready up for b12, updated authors, changelog 2020-03-04 10:41:48 +01:00
.env.example Update project base and file paths 2024-03-03 09:52:52 +08:00
.gitattributes Prevent Git from auto-merging Composer's lockfile 2018-06-02 15:06:48 +02:00
.gitignore Update .gitignore and docker-compose.yml 2024-03-01 22:23:59 +08:00
.nginx.conf chore: mark resource protection rule blocks 2024-01-02 16:03:33 +01:00
CHANGELOG.md chore: Release v1.8.0 2023-05-20 19:23:43 +01:00
LICENSE docs: update copyright year (#85) 2022-07-25 09:05:22 +01:00
README.md Add initial setup instructions for the DB 2024-03-01 23:12:56 +08:00
composer.json chore: Release v1.8.0 2023-05-20 19:23:43 +01:00
docker-compose.yml Update service names in docker-compose.yml 2024-03-03 09:59:34 +08:00
extend.php Consistent spacing 2020-01-17 16:43:50 +01:00
flarum Extract duplicated site setup to shared file (#63) 2020-01-31 14:03:32 +01:00
flarum-fpm.dockerfile Update Docker images and dependencies 2024-03-01 21:56:56 +08:00
site.php Extract duplicated site setup to shared file (#63) 2020-01-31 14:03:32 +01:00

README.md

Total Downloads Latest Stable Version License

About Flarum

Flarum is a delightfully simple discussion platform for your website. It's fast and easy to use, with all the features you need to run a successful community. It is designed to be:

  • Fast and simple. No clutter, no bloat, no complex dependencies. Flarum is built with PHP so its quick and easy to deploy. The interface is powered by Mithril, a performant JavaScript framework with a tiny footprint.

  • Beautiful and responsive. This is forum software for humans. Flarum is carefully designed to be consistent and intuitive across platforms, out-of-the-box.

  • Powerful and extensible. Customize, extend, and integrate Flarum to suit your community. Flarums architecture is amazingly flexible, with a powerful Extension API.

screenshot

Installation

Read the Installation guide to get started. For support, refer to the documentation, and ask questions on the community forum or Discord chat.

Docker Compose

git clone https://github.com/furyhawk/flarum.git -b docker-compose
cd flarum
# copy and edit .env file if needed
cp .env.example .env
docker run --rm -it -v $PWD:/app composer install
docker compose up -d

Initial setup

Use the following fields for the DB to work:

MySQL Host: mariadb MySQL Username: flarum MySQL Password: flarumpass

Contributing

Thank you for considering contributing to Flarum! Please read the Contributing guide to learn how you can help.

This repository only holds the Flarum skeleton application. Most development happens in flarum/core.

Security Vulnerabilities

If you discover a security vulnerability within Flarum, please follow our security policy so we can address it promptly.

License

Flarum is open-source software licensed under the MIT License.