Documentation
System Requirements
You just need a web server with PHP support.
- Webserver (Apache)
- PHP v7 or higher.
- PHP module mbstring for full UTF-8 support.
- PHP ZipArchive OR unzip before send files (more than 2 files).
Note: If you have a problem with your server path, edit the header.php and install.php file, and change PATH_ROOT constant.if (!defined('PATH_ROOT')) define('PATH_ROOT', __DIR__.DS); or if (!defined('PATH_ROOT')) define('PATH_ROOT', './');
Installing Flatboard
- Download the latest version from flatboard.org
- Extract the archive.
- Upload
flatboard.zipandindex.phpto your server/hosting. - Visit your domain http://domain.com/flatboard
- Follow the Flatboard Unpack & the Installer to configure your website.
Why did you send the archived file?
Just to save time, is to be sure to have all the files present on the server, with good write access to folders and files.
And maybe it's cooler like this 😃.
Update guide
- Backup your
data/folder manually or with the Backup plugin. - Replace all files with your favorite FTP Client.
- Delete all files stocked in
data/pluginfolder and go to your plugins page to activate your plugins again.. - Delete the
theme/YourTheme/cache/folder. - Go to the configuration page to set and save the new settings brought by the update.
- Visit your domain http://domain.com/flatboard
- That all!
Post format
Since Flatboard v1.0, it is now possible to choose between the BBcode or Markdown format, so the editor changes according to the choice. Be careful however, this choice will be made at the beginning of installation, it will not be possible to change there after without having traces in the discussions because the syntax is different.
Post preview
To preview your message, simply click on the send button without inserting the response captcha code.
Add tags in title
To add tags to your titles, you must first add them from the administration menu. It is quite possible to add others in the title, without going through the dedicated field.
Add verified user label
Copy pseudo user name with his hash (ex: MyPseudo@4346f29d) and go to Tags administration menu. Check Hidden this tag and a preselection is displayed in fields. Paste username in the first field and change the name you want to display in the second instead of the word User. Save and you're done.
Anonyme user / Unique identity without register !
With Flatboard it is possible to send messages anonymously, to do this simply leave the field blank username and Flatboard generate a user hash.
You must insert your username followed by a @ and your password is encrypted and truncated.
Example: Username@MyPassword
Become: Username@a52d7896
Wrong: Username123456
Custom Avatar
To add a custom avatar, simply replace the @ in the case of a unique identity by a _ and not have a space in the name of your .png image. Example: My Pseudo@MyPassword
Become: MyPseudo_a52d7.png
And upload your picture in uploads/avatars folder.
Install a plugin or theme
Download a plugin or theme from our download page or in the resources forum. Uncompress the file and send the plugin or theme folder in the respective files plugin or theme of your server at the root of the installation of your Flatboard.
Hooks list
With hooks you can intercept all kinds of Flatboard events to inject your own code.
Here is a list of available hooks:
| Hooks | Execute in | Note |
|---|---|---|
| Plugin::hook('profile') | theme | Avatar or for pseudo |
| Plugin::hook('footer') | theme | Bottom page |
| Plugin::hook('footerJS') | theme | Load javascript |
| Plugin::hook('beforeMain') | theme | Before body site |
| Plugin::hook('afterMain') | theme | After body site |
| Plugin::hook('menu') | theme | Sidebar |
| Plugin::hook('stats') | theme | Sidebar stats |
| Plugin::hook('core_menu') | theme | Add plugin menu |
| Plugin::hook('css') | theme | Add css |
| Plugin::hook('head') | theme | Add other metas |
| Plugin::hook('topTopic') | theme | Before topic |
| Plugin::hook('afterTopic') | theme | After topic |
| Plugin::hook('buttonTopic') | theme | Action buttons topic |
| Plugin::hook('bottomTopic') | theme | Before replies |
| Plugin::hook('afterReply') | theme | After replies |
| Plugin::hook('buttonReply') | theme | Action buttons reply |
| Plugin::hook('afterForum') | theme | Bottom forum list |
| Plugin::hook('titleTopic') | theme | Title topic |
| Plugin::hook('install') | core | Install a plugin |
| Plugin::hook('init') | core | Execute code before site loaded |
| Plugin::hook('editor') | core | Textarea content |
| Plugin::hook('manageTopic') | core | Manage Topic |
| Plugin::hook('manageReply') | core | Manage Reply |
| Plugin::hook('manageForum') | core | Manage Forum |
| Plugin::hook('managePlugin') | core | Manage Plugin |
| Plugin::hook('userBan') | core | Manage User |
| Plugin::hook('manageWorker') | core | Manage Moderator |
╰☆╮Flatboard╰☆╮ is a open source and community contributions are essential to project success!
Update: July 15, '24