From 91567ba7d4fa9b03ce6779ca754f7890184f5fe2 Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Thu, 11 Mar 2021 12:25:29 +0100 Subject: [PATCH] Add upgrade.md Signed-off-by: Thomas Citharel --- CHANGELOG.md | 2 ++ UPGRADE.md | 15 +++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 UPGRADE.md diff --git a/CHANGELOG.md b/CHANGELOG.md index a57492cf1..ff54ffb32 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## 1.1.0-beta.1 - 10-03-2021 +This version introduces a new way to install and host Mobilizon : Elixir releases. This is the new default way of installing Mobilizon. If you want to migrate to a release install from a source release, you can read [more details here](./UPGRADE.md#upgrading-from-10-to-11). You may also stay on source install for now, or upgrade at any time. + ### Added - Add a group activity logbook diff --git a/UPGRADE.md b/UPGRADE.md new file mode 100644 index 000000000..a4ef651d2 --- /dev/null +++ b/UPGRADE.md @@ -0,0 +1,15 @@ +# Upgrading from 1.0 to 1.1 + +The 1.1 version of Mobilizon brings Elixir releases support. An Elixir release is a self-contained directory that contains all of Mobilizon's code (front-end and backend), it's dependencies, as well as the Erlang Virtual Machine and runtime (only the parts you need). As long as the release has been assembled on the same OS and architecture, it can be deploy and run straight away. [Read more about releases](https://elixir-lang.org/getting-started/mix-otp/config-and-releases.html#releases). + +Migrating to releases means: +* You only get a precompiled binary, so you avoid compilation times when updating +* Code/data/config location is more common (/opt, /var/lib, /etc) +* More efficient, as only what you need from the Elixir/Erlang standard libraries is included and all of the code is directly preloaded +* You can't hardcode modifications in Mobilizon's code + +Staying on source releases means: +* You need to recompile everything with each update +* You can change things in Mobilizon's code and recompile right away + +If you want to migrate to releases, [we provide a guide](https://docs.joinmobilizon.org/administration/upgrading/source_to_release/). \ No newline at end of file