tommy/mobilizon
1
0
Fork 0
forked from potsda.mn/mobilizon
Code Pull requests Activity

Remove OS-specific packages from UPGRADE.md

Browse source 
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel 2022-05-06 12:42:16 +02:00
parent 8549a16ade
commit 2651f4cf40
No known key found for this signature in database
GPG key ID: A061B9DDE0CA0773
1 changed files with 46 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

95
UPGRADE.md
View file

@ -1,26 +1,5 @@
# Upgrading from 2.0 to 2.1 # Upgrading from 2.0 to 2.1
## Distro-specific packages
Elixir releases are precompiled binaries and are therefore dependent on the host they've been compiled to be compatible with your system (architecture, libc version, …) ([read more](https://hexdocs.pm/mix/Mix.Tasks.Release.html#module-requirements)). For instance, the release build on Debian Bullseye (with libc 2.31) cannot be run on Debian Buster (which only provides libc 2.28). Another example is Red Hat-relative distributions (Fedora, CentOS, …) which have an OpenSSL library version that's not compatible with the version compiled (because of [potential patent issues with Elliptic curves](https://github.com/kerl/kerl#compiling-crypto-on-red-hat-systems)).
In order to make sure the releases package we redistribute , we now build distro-version-specific packages.
The list of packages built for version 2.1.0 with the amd64 (x86_64) architecture is the following:
- Debian Buster (10)
- Debian Bullseye (11)
- Ubuntu Bionic (18.04)
- Ubuntu Focal (20.04)
- Fedora 35
- Fedora 36
- Alpine 3.14.5
- Alpine 3.15.3
As building for non-`amd64` architectures is quite difficult (because of the time and extra resources cross-compiling takes), these architectures are only built against Debian Bullseye (11) at the moment.
We want to expand this list in the future to make sure it covers most uses, so feel free to give us feedback from what you need.
Note: Docker images are also built for `amd64`/`arm`/`arm64` architectures, and of course you can always install Mobilizon from source on pretty much any unix-compatible system.
## Mailer library change ## Mailer library change
### Docker ### Docker
@ -30,10 +9,11 @@ The change is already applied. You may remove the `MOBILIZON_SMTP_HOSTNAME` envi
### Release and source mode ### Release and source mode
In your configuration file under `config :mobilizon, Mobilizon.Web.Email.Mailer`, In your configuration file under `config :mobilizon, Mobilizon.Web.Email.Mailer`,
* Change `Bamboo.SMTPAdapter` to `Swoosh.Adapters.SMTP`,
* rename the `server` key to `relay` - Change `Bamboo.SMTPAdapter` to `Swoosh.Adapters.SMTP`,
* remove the `hostname` key, - rename the `server` key to `relay`
* the default value of the username and password fields is an empty string and no longer `nil`. - remove the `hostname` key,
- the default value of the username and password fields is an empty string and no longer `nil`.
```diff ```diff
config :mobilizon, Mobilizon.Web.Email.Mailer, config :mobilizon, Mobilizon.Web.Email.Mailer,
@ -61,7 +41,9 @@ In your configuration file under `config :mobilizon, Mobilizon.Web.Email.Mailer`
# Upgrading from 1.3 to 2.0 # Upgrading from 1.3 to 2.0
Requirements dependencies depend on the way Mobilizon is installed. Requirements dependencies depend on the way Mobilizon is installed.
## New Elixir version requirement ## New Elixir version requirement
### Docker and Release install ### Docker and Release install
You are already using latest Elixir version in the release tarball and Docker images. You are already using latest Elixir version in the release tarball and Docker images.
@ -77,17 +59,19 @@ Mobilizon 2.0 uses data based on [timezone-boundary-builder](https://github.com/
### Docker install ### Docker install
The geographic timezone data is already bundled into the image, you have nothing to do. The geographic timezone data is already bundled into the image, you have nothing to do.
### Release install ### Release install
In order to keep the release tarballs light, the geographic timezone data is not bundled directly. You need to download the data : In order to keep the release tarballs light, the geographic timezone data is not bundled directly. You need to download the data :
* either raw from Github, but **requires an extra ~1Gio of memory** to process the data
- either raw from Github, but **requires an extra ~1Gio of memory** to process the data
```sh ```sh
sudo -u mobilizon mkdir /var/lib/mobilizon/timezones sudo -u mobilizon mkdir /var/lib/mobilizon/timezones
sudo -u mobilizon ./bin/mobilizon_ctl tz_world.update sudo -u mobilizon ./bin/mobilizon_ctl tz_world.update
``` ```
* either already processed from our own distribution server - either already processed from our own distribution server
```sh ```sh
sudo -u mobilizon mkdir /var/lib/mobilizon/timezones sudo -u mobilizon mkdir /var/lib/mobilizon/timezones
@ -95,6 +79,7 @@ In order to keep the release tarballs light, the geographic timezone data is not
``` ```
In both cases, ~700Mio of disk will be used. You may use the following configuration to specify where the data is expected if you decide to change it from the default location (`/var/lib/mobilizon/timezones`) : In both cases, ~700Mio of disk will be used. You may use the following configuration to specify where the data is expected if you decide to change it from the default location (`/var/lib/mobilizon/timezones`) :
```elixir ```elixir
config :tz_world, data_dir: "/some/place" config :tz_world, data_dir: "/some/place"
``` ```
@ -102,14 +87,15 @@ config :tz_world, data_dir: "/some/place"
### Source install ### Source install
You need to download the data : You need to download the data :
* either raw from Github, but **requires an extra ~1Gio of memory** to process the data
- either raw from Github, but **requires an extra ~1Gio of memory** to process the data
```sh ```sh
sudo -u mobilizon mkdir /var/lib/mobilizon/timezones sudo -u mobilizon mkdir /var/lib/mobilizon/timezones
sudo -u mobilizon mix mobilizon.tz_world.update sudo -u mobilizon mix mobilizon.tz_world.update
``` ```
* either already processed from our own distribution server - either already processed from our own distribution server
```sh ```sh
sudo -u mobilizon mkdir /var/lib/mobilizon/timezones sudo -u mobilizon mkdir /var/lib/mobilizon/timezones
@ -117,6 +103,7 @@ You need to download the data :
``` ```
In both cases, ~700Mio of disk will be used. You may use the following configuration to specify where the data is expected: In both cases, ~700Mio of disk will be used. You may use the following configuration to specify where the data is expected:
```elixir ```elixir
config :tz_world, data_dir: "/some/place" config :tz_world, data_dir: "/some/place"
``` ```
@ -135,14 +122,18 @@ Files in this folder are temporary and are cleaned once an hour.
## New optional dependencies ## New optional dependencies
These are optional, installing them will allow Mobilizon to export to PDF and ODS as well. Mobilizon 2.0 allows to export the participant list, but more is planned. These are optional, installing them will allow Mobilizon to export to PDF and ODS as well. Mobilizon 2.0 allows to export the participant list, but more is planned.
### Docker ### Docker
Everything is included in our Docker image. Everything is included in our Docker image.
### Release and source install ### Release and source install
New optional Python dependencies: New optional Python dependencies:
* `Python` >= 3.6
* `weasyprint` for PDF export (with [a few extra dependencies](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html)) - `Python` >= 3.6
* `pyexcel-ods3` for ODS export (no extra dependencies) - `weasyprint` for PDF export (with [a few extra dependencies](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html))
- `pyexcel-ods3` for ODS export (no extra dependencies)
Both can be installed through pip. You need to enable and configure exports for PDF and ODS in the configuration afterwards. Read [the dedicated docs page about this](https://docs.joinmobilizon.org/administration/configure/exports/). Both can be installed through pip. You need to enable and configure exports for PDF and ODS in the configuration afterwards. Read [the dedicated docs page about this](https://docs.joinmobilizon.org/administration/configure/exports/).
@ -151,35 +142,41 @@ Both can be installed through pip. You need to enable and configure exports for
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). 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).
## Comparison ## Comparison
Migrating to releases means: Migrating to releases means:
* You only get a precompiled binary, so you avoid compilation times when updating
* No need to have Elixir/NodeJS installed on the system - You only get a precompiled binary, so you avoid compilation times when updating
* Code/data/config location is more common (/opt, /var/lib, /etc) - No need to have Elixir/NodeJS installed on the system
* More efficient, as only what you need from the Elixir/Erlang standard libraries is included and all of the code is directly preloaded - Code/data/config location is more common (/opt, /var/lib, /etc)
* You can't hardcode modifications in Mobilizon's code - 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: Staying on source releases means:
* You need to recompile everything with each update
* Compiling frontend and backend has higher system requirements than just running Mobilizon - You need to recompile everything with each update
* You can change things in Mobilizon's code and recompile right away to test changes - Compiling frontend and backend has higher system requirements than just running Mobilizon
- You can change things in Mobilizon's code and recompile right away to test changes
## Releases ## Releases
If you want to migrate to releases, [we provide a full guide](https://docs.joinmobilizon.org/administration/upgrading/source_to_release/). You may do this at any time. If you want to migrate to releases, [we provide a full guide](https://docs.joinmobilizon.org/administration/upgrading/source_to_release/). You may do this at any time.
## Source install ## Source install
To stay on a source release, you just need to check the following things: To stay on a source release, you just need to check the following things:
* Rename your configuration file `config/prod.secret.exs` to `config/runtime.exs`.
* If your config file includes `server: true` under `Mobilizon.Web.Endpoint`, remove it. - Rename your configuration file `config/prod.secret.exs` to `config/runtime.exs`.
```diff - If your config file includes `server: true` under `Mobilizon.Web.Endpoint`, remove it.
config :mobilizon, Mobilizon.Web.Endpoint, ```diff
- server: true, config :mobilizon, Mobilizon.Web.Endpoint,
``` - server: true,
* The uploads default directory is now `/var/lib/mobilizon/uploads`. To keep it in the previous `uploads/` directory, just add the following line to `config/runtime.exs`: ```
- The uploads default directory is now `/var/lib/mobilizon/uploads`. To keep it in the previous `uploads/` directory, just add the following line to `config/runtime.exs`:
```elixir ```elixir
config :mobilizon, Mobilizon.Web.Upload.Uploader.Local, uploads: "uploads" config :mobilizon, Mobilizon.Web.Upload.Uploader.Local, uploads: "uploads"
``` ```
Or you may use any other directory where the `mobilizon` user has write permissions. Or you may use any other directory where the `mobilizon` user has write permissions.
* The GeoIP database default directory is now `/var/lib/mobilizon/geo/GeoLite2-City.mmdb`. To keep it in the previous `priv/data/GeoLite2-City.mmdb` directory, just add the following line to `config/runtime.exs`: - The GeoIP database default directory is now `/var/lib/mobilizon/geo/GeoLite2-City.mmdb`. To keep it in the previous `priv/data/GeoLite2-City.mmdb` directory, just add the following line to `config/runtime.exs`:
```elixir ```elixir
config :geolix, databases: [ config :geolix, databases: [
%{ %{
@ -189,4 +186,4 @@ To stay on a source release, you just need to check the following things:
} }
] ]
``` ```
Or you may use any other directory where the `mobilizon` user has read permissions. Or you may use any other directory where the `mobilizon` user has read permissions.