Skip to content

Commit f7285d3

Browse files
committed
chore: improve 2.0 install/update docs
1 parent 211abed commit f7285d3

File tree

3 files changed

+35
-9
lines changed

3 files changed

+35
-9
lines changed

docs/extend/database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Database
22

3-
Flarum supports a variety of database systems, including MySQL, PostgreSQL, and SQLite. Most extensions will not have to worry about the specifics of the database system, as [Laravel's query builder](https://laravel.com/docs/11.x/queries) handles the differences between them. However, you can still run into instances where you need to write certain database operations differently depending on the database system. This section aims to document some of the common pitfalls and solutions.
3+
Flarum supports a variety of database systems, including MySQL, MariaDB, PostgreSQL, and SQLite. Most extensions will not have to worry about the specifics of the database system, as [Laravel's query builder](https://laravel.com/docs/11.x/queries) handles the differences between them. However, you can still run into instances where you need to write certain database operations differently depending on the database system. This section aims to document some of the common pitfalls and solutions.
44

55
:::warning
66

docs/install.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Feel free to give Flarum a spin on one of our [demonstration forums](https://dis
66

77
:::
88

9+
:::warning
10+
11+
Flarum 2.0 is currently in beta. It is not ready for production use.
12+
13+
:::
14+
915
## Server Requirements
1016

1117
Before you install Flarum, it's important to check that your server meets the requirements. To run Flarum, you will need:
@@ -41,7 +47,7 @@ If you don't have SSH access to your server, or you prefer not to use the comman
4147
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:
4248

4349
```bash
44-
composer create-project flarum/flarum .
50+
composer create-project flarum/flarum:^2.0.0-beta .
4551
```
4652

4753
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.

docs/update.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
# Updating
22

3+
:::warning
4+
5+
Flarum 2.0 is currently in beta. It is not ready for production use. Please wait for the stable release before updating your forum.
6+
7+
:::
8+
39
## From the Admin Dashboard
410

511
:::info
612

7-
If you have the extension manager extension installed you can simply run the update from its interface and skip this page entirely.
13+
If you have the [extension manager](./extensions#extension-manager) extension installed you can simply run the update from its interface and skip the general steps. You should still read the ["Major Version Update Guide"](#major-version-update-guides) if you are updating from v1 to v2.
814

915
:::
1016

1117
---
1218

1319
To update Flarum, you'll need to use [Composer](https://getcomposer.org). If you're not familiar with it (although you should be, because you need it to install Flarum), read [our guide](composer.md) for information on what it is and how to set it up.
1420

15-
If updating across major versions (e.g. <=0.1.0 to 1.x.x, 1.x.x to 2.x.x, ...), make sure to read the appropriate "major version update guide" before running the general upgrade steps.
21+
If updating across major versions (e.g. <=0.1.0 to 1.x.x, 1.x.x to 2.x.x, ...), make sure to read the appropriate ["Major Version Update Guide"](#major-version-update-guides) before running the general upgrade steps.
1622

1723
## General Steps
1824

@@ -40,11 +46,25 @@ php flarum cache:clear
4046

4147
### Updating from v1 (^1.0.0) to v2 (^2.0.0)
4248

43-
1. Do steps 1-5 above.
44-
2. Change the version strings of all bundled extensions (`flarum/tags`, `flarum/mentions`, `flarum/likes`, etc) in `composer.json` from `^1.0` (or `^1.8`, ...etc) to `*`.
45-
3. Change `flarum/core`'s version string in `composer.json` from `^1.0` (or `^1.8`, ...etc) to `^2.0`.
46-
4. Preferably set the `"minimum-stability": "beta",` line in your `composer.json` to `stable` unless you are still using a beta third party extension.
47-
5. Do steps 6 and 7 above.
49+
1. If you are using a MariaDB database, you should change the driver in `config.php` from `mysql` to `mariadb`:
50+
```php
51+
<?php return array (
52+
'debug' => true,
53+
'offline' => false,
54+
'database' =>
55+
array (
56+
// remove-next-line
57+
'driver' => 'mysql',
58+
// insert-next-line
59+
'driver' => 'mariadb',
60+
'host' => 'localhost',
61+
'port' => 3306,
62+
```
63+
2. Do steps 1-5 above.
64+
3. Change the version strings of all bundled extensions (`flarum/tags`, `flarum/mentions`, `flarum/likes`, etc) in `composer.json` from `^1.0` (or `^1.8`, ...etc) to `*`.
65+
4. Change `flarum/core`'s version string in `composer.json` from `^1.0` (or `^1.8`, ...etc) to `^2.0`.
66+
5. Preferably set the `"minimum-stability": "beta",` line in your `composer.json` to `stable` unless you are still using a beta third party extension.
67+
6. Do steps 6 and 7 above.
4868

4969
## Troubleshooting Issues
5070

0 commit comments

Comments
 (0)