Laravel Forum 5 Documentation

General - Installation

Installation

Versions

Laravel version Package version PHP version
10 ^5.5 ^8.1
9 ^5.3 ^8.0
6 - 8 ^5.0 ^7.4

Step 1: Install the package

Install the package via composer:

composer require riari/laravel-forum:~5.0

Package Discovery should take care of registering the service provider automatically, but if you need to do so manually, add the service provider to your config/app.php:

TeamTeaTime\Forum\ForumServiceProvider::class,

Step 2: Publish the package files

Run the vendor:publish command to publish the package config, translations and migrations to your app’s directories:

php artisan vendor:publish

Step 3: Update your database

Run your migrations:

php artisan migrate

Step 4: Install a UI preset

As of 5.6.0, a forum:install command is available for installing UI presets. The available preset options are bootstrap (for a Bootstrap 5 UI) and tailwind (for a Tailwind CSS UI). You must install one of these to publish the corresponding views to your application. For example:

php artisan forum:install tailwind

After completing this step, you can define your forum categories in the forum_categories table, or authenticate with a user that has the createCategories ability (granted to all users by default) and use the ‘Create category’ button displayed on the forum index (/forum).

Additional steps

Configuration

Several configuration files are published to your application’s config directory, each prefixed with forum.. Refer to these for a variety of options for changing the behaviour of the forum and how it integrates with key parts of your application code.

Note

You may need to modify the forum.integration.user_model config option according to the location of your user model. By default, it matches the default namespace for the user model in Laravel 8. Additionally, you may need to modify the forum.integration.user_name option; this specifies which attribute on the user model should be used as a display name in the forum views.

Policies

You will likely wish to modify the default policies to integrate them with whatever permission system you may be using; see Policies for further details.

Translations

Laravel Forum 5 currently supports 13 languages: German, English, Spanish, French, Italian, Dutch, Romanian, Russian, Thai, Turkish, Serbian, Portuguese (Brazil) and Swedish. The translation files are published to resources/lang/vendor/forum/{locale}. Some new language strings have been introduced in 5.0 but not yet translated; PRs to translate these would be greatly appreciated.