Go to file
Toby Zerner b4a09a072f Update .htaccess rules and add .nginx.conf
- Clean up .htaccess and use best practices from h5bp/server-configs.

- Extract Nginx config from docs into a new .nginx.conf file which can
  be included in the server block. Also uses best practices from
  h5bp/server-configs.

- Remove "Allow access if Flarum is installed in a subdirectory but
  another .htaccess in a higher directory denies access" rule. I'm not
  sure why this was in here. Traced it back to

    c17588f1cd (diff-8052c42ab3b8aa06a3f5f788a4ddccc2)

  but there's no real rationale behind why such an edge case should be
  included in the default .htaccess?
2018-11-21 17:26:02 +10:30
public Update .htaccess rules and add .nginx.conf 2018-11-21 17:26:02 +10:30
storage Add directory for storing session data 2018-03-18 15:57:18 +01:00
.editorconfig Remove redundant options 2015-08-31 22:55:17 +03:00
.gitattributes Prevent Git from auto-merging Composer's lockfile 2018-06-02 15:06:48 +02:00
.gitignore Ignore composer lock file for now 2015-10-19 15:02:02 +02:00
.nginx.conf Update .htaccess rules and add .nginx.conf 2018-11-21 17:26:02 +10:30
CODE_OF_CONDUCT.md Add code of conduct 2018-11-14 15:59:32 +10:30
CONTRIBUTING.md Update urls with their current canonical versions (#54) 2018-08-02 17:35:25 +02:00
LICENSE Update license year (#47) 2017-12-31 20:46:40 +01:00
composer.json Rename packages 2018-10-17 13:46:49 +10:30
extend.php Add a root-level extend.php for per-forum customizations 2018-09-01 16:14:23 +02:00
flarum Configure all paths explicitly 2018-10-28 23:12:45 +01:00
readme.md Update urls with their current canonical versions (#54) 2018-08-02 17:35:25 +02:00

readme.md

Flarum

Flarum is free, open-source forum software built with PHP and Mithril.js. It is:

  • Simple, with a responsive UI that is optimized for touch devices
  • Fast, with a total JS payload size of ~130 KB gzipped
  • Extensible, so you can tailor it to your use-case

screenshot

Installation

Flarum is currently in beta and should not be used in production. It is being developed openly on GitHub. Check out the Roadmap to follow along with our progress.

You must have SSH access to a server with PHP 5.5+ and MySQL 5.5+, and install Composer.

composer create-project flarum/flarum . --stability=beta

Read the Installation Guide for more information.

Development

This repository holds the Flarum skeleton application. Its dependencies, such as flarum/core (where most development happens), have to be installed using Composer.

Support

Refer to the FAQ, Documentation, and ask questions on the Community Forum or Discord Chat.

Contributing

Flarum is open-source and we would love your help building it! Please read the Contributing Guide to learn how you can help.

License

Copyright (c) 2015 Toby Zerner. Code released under the MIT License.