Skip to content

Update the docs for the stable 2.0 release #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imorland merged 2 commits into from
Oct 9, 2026
Merged

Update the docs for the stable 2.0 release #607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fe1a5f
Update the docs for the stable Flarum 2.0 release
karl-bullock Oct 3, 2026
b1b8cef
Merge branch 'main' into pr-607
imorland Oct 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/extend/update-2_0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ There have been many changes to the core frontend codebase, including renamed or

##### <span class="breaking">Breaking</span>
In `composer.json`:
* Set `flarum/core` package requirement to `^2.0.0-beta`.
* Set `flarum/core` package requirement to `^2.0`.
* Set other `flarum/*` packages to `*`.
* If you have a `php` requirement, make sure it is not below `^8.3`.
* If you have `blomstra/gdpr` as a requirement, change it to `"flarum/gdpr": "*"`.
Expand Down
8 changes: 1 addition & 7 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ Feel free to give Flarum a spin on one of our [demonstration forums](https://dis

:::

:::warning

Flarum 2.0 is in its release-candidate phase. The API is stable and many forums already run it in production — but it isn't the final stable release yet, so back up your data and test before relying on it.

:::

## Server Requirements

Before you install Flarum, it's important to check that your server meets the requirements. To run Flarum, you will need:
Expand Down Expand Up @@ -65,7 +59,7 @@ Only the latest Flarum 2.x version is detailed here, for previous versions [brow
Flarum uses [Composer](https://getcomposer.org) to manage its dependencies and extensions. If you're not familiar with it, read [our guide](composer.md) for information on what it is and how to set it up. Afterwards, run this command in an empty location that you want Flarum to be installed in:

```bash
composer create-project flarum/flarum:^2.0.0 --stability=beta .
composer create-project flarum/flarum:^2.0.0 .
```

While this command is running, you can configure your web server. You will need to make sure your webroot is set to `/path/to/your/forum/public`, and set up [URL Rewriting](#url-rewriting) as per the instructions below.
Expand Down
21 changes: 4 additions & 17 deletions docs/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:::warning

Flarum 2.0 is in its release-candidate phase. The API is stable and many forums already run it in production. It isn't the final stable release yet, so back up your database and test on a staging copy before upgrading a live forum.
Back up your database and files, and test the upgrade on a staging copy before upgrading a live forum.

:::

Expand Down Expand Up @@ -84,20 +84,7 @@ Set the version string of all extensions (including bundled ones like `flarum/ta
"flarum/mentions": "*",
```

**5. Set `minimum-stability` to `beta`.**
Until Flarum 2.0 reaches its final stable release, your `composer.json` must allow pre-stable versions:

```json
"minimum-stability": "beta"
```

:::info

Once Flarum 2.0 stable is released, you should change this back to `stable`. Leaving it as `beta` after that point can cause Composer to pull in unstable versions of packages unexpectedly.

:::

**6. Update your `config.php` if using MariaDB.**
**5. Update your `config.php` if using MariaDB.**
Flarum 2.0 distinguishes between MySQL and MariaDB. If your forum runs on MariaDB, you must change the `driver` value in `config.php` to `mariadb`. Leaving it as `mysql` will cause compatibility errors once you are on 2.0.

:::tip Not sure which one you have?
Expand Down Expand Up @@ -126,10 +113,10 @@ That forum is on MariaDB and does need this change, despite what the label says.
'port' => 3306,
```

**7. Check any local extenders.**
**6. Check any local extenders.**
If your install uses [local extenders](extenders.md), review them for compatibility with Flarum 2.0's API changes before upgrading.

**8. Disable third-party extensions.**
**7. Disable third-party extensions.**
We recommend disabling third-party extensions in the admin dashboard before running the upgrade. This isn't strictly required, but makes debugging easier if something goes wrong. Re-enable them once the upgrade has finished and the forum loads.

## Running the Upgrade
Expand Down