Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 3.88 KB

README.md

File metadata and controls

95 lines (68 loc) · 3.88 KB
Raw

Nitro Porter 🚀

The only multi-platform community migration tool. Free your forum!

Nitro Porter is based on PHP 8.2+ and runs via the command line.

Documentation

🚥 Get started

🎟️ Get involved

  • Contribute data, requests, fixes, or success stories.
  • Changelog has latest fixes & updates.
  • Roadmap contains informal goals, not ETAs.
  • History gives more context to the project.

🚀 Mission statement

Community history is vitally important, and being able to change software is important for the health of the ecosystem. However, community software often has high lock-in due to the difficulty of a data migration.

Nitro Porter exists because your community deserves to both use the best tools available and preserve its unique history.

This tool is designed for ease of extensibility to allow anyone with basic programming skills to add a source or target. Any generally available forum software (commercial or free) may be added as a source or target. It does not include bespoke or custom forum software, but is designed to allow individuals to create such support easily for their private use.

Nitro Porter uses the GNU AGPL 3.0 license to ensure it remains freely available to anyone who needs it. That means code for all new packages written for it must likewise be made freely available.

What's Supported?

📥 Targets (3)

Flarum Vanilla Waterhole

📤 Sources (37)

  • bbPress
  • Drupal
  • Flarum
  • FluxBB
  • IPBoard
  • MyBB
  • NodeBB
  • phpBB
  • Simple Machines (SMF)
  • Vanilla
  • vBulletin
  • XenForo
  • ...and MORE!

✔ What data gets migrated?

All sources & targets support migrating:

  • users & roles
  • discussions (or threads)
  • posts (or comments)
  • categories (or subforums, channels, etc.)

Beyond that, each supports different types of data depending on feature availability, extension choice, and maturity of the source/target package. These include things like badges, reactions, bookmarks, and polls.

Both the source and target must support a data type for it to transfer!

Nitro Porter never transfers permissions. It's not safe to do so automatically due to variations in how platforms implement them. You will always need to reassign permissions after a migration.

🔭 Future support

Don't see your software? Start a discussion to request it and keep an eye on our informal roadmap. We're happy to add a new Source for any software, provided it is not bespoke. For a new Target, we require support from the vendor if it is not free and open source software.

Currently, all data sources and targets are based on SQL databases (except the Vanilla target's flat file) and only natively supports MySQL-compatible connections. All other storage formats (like mbox or ASP Playground's MSSQL) requires pre-work to convert the data to a MySQL database.

In the future, we plan to natively support:

  • PostgreSQL
  • MSSQL
  • MongoDB
  • Web-based APIs

The 3.0 rewrite of Nitro Porter was done with that future in mind.1

Footnotes

  1. 🚀 Forked 27 Sep 2021 in memory of Kyle ↩