Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 2.75 KB

README.md

File metadata and controls

77 lines (47 loc) · 2.75 KB

MigrateToFlarum Lab, the health scanner for Flarum

Build status MIT license Donate

This is a free and online tool to check the health of your Flarum install. Visit https://lab.migratetoflarum.com/ to get started.

Screenshots

For screenshots, Spatie Browsershot is used. Follow the requirements to install Puppeteer and Chrome Headless.

Additionally on Ubuntu server install the package fonts-noto-cjk so Chrome can render websites in almost any language.

Showcase url

If you run the lab locally, the showcase will be available at /showcase.

To use a secondary domain locally or on production, set the env variable SHOWCASE_DOMAIN to the absolute url of the showcase homepage without trailing slash.

Then setup the webserver to redirect requests from that domain to the same app as the lab.

Nginx

(The lab uses nginx in production)

proxy_set_header Host lab.migratetoflarum.com;

location ~ ^/(api|css|fonts|images|js|storage) {
  proxy_pass https://127.0.0.1;
}

location / {
  proxy_pass https://127.0.0.1/showcase/;
}

Apache

(I used this locally for tests)

<LocationMatch "^/(api|css|fonts|images|js|storage)">
  ProxyPassMatch http://127.0.0.1:8000
</LocationMatch>
ProxyPass / http://127.0.0.1:8000/showcase/

External services

The lab does not call any external API, but it uses some external services through offline databases.

Public Suffix List

The list is automatically synced from https://github.com/publicsuffix/list using the update-public-suffix-list scheduled command.

IP geolocation

IP geolocation uses DB-IP Free dataset.

To use, download the latest file, extract and place at the following locations:

A MigrateToFlarum service

This is a free service by MigrateToFlarum, an online forum migration tool (launching soon). Follow us on Twitter for updates https://twitter.com/MigrateToFlarum

Need a custom Flarum extension ? Contact Clark Winkelmann !

Links