From bb3870d43090c35b9241683501b59bb8c5cab09f Mon Sep 17 00:00:00 2001 From: Adam Cooke Date: Mon, 4 Mar 2024 12:00:00 +0000 Subject: [PATCH] update docs for v3 --- content/2.getting-started/2.installation.md | 4 ++ content/2.getting-started/4.upgrade-to-v3.md | 46 ++++++++++++++++++++ content/2.getting-started/5.upgrade-to-v2.md | 2 +- 3 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 content/2.getting-started/4.upgrade-to-v3.md diff --git a/content/2.getting-started/2.installation.md b/content/2.getting-started/2.installation.md index 1adc920..1a02232 100644 --- a/content/2.getting-started/2.installation.md +++ b/content/2.getting-started/2.installation.md @@ -29,6 +29,10 @@ Once generated, you should open up `/opt/postal/config/postal.yml` and add all t Note that the docker setup mounts /opt/postal/config as /config so any full directory paths mentioned in postal.yml will likely need to start with /config and not /opt/postal/config :: +::callout{icon="i-heroicons-information-circle" color="blue"} +If you want to test Postal v3 which is currently unreleased, then you can run the bootstrap with the `--version latest` argument. +:: + ## Initializing the database Once you've added your configuration, you need to initialize your database by adding all the appropriate tables. Run the following commands to create the schema and then create your first admin user. diff --git a/content/2.getting-started/4.upgrade-to-v3.md b/content/2.getting-started/4.upgrade-to-v3.md new file mode 100644 index 0000000..9cc44dd --- /dev/null +++ b/content/2.getting-started/4.upgrade-to-v3.md @@ -0,0 +1,46 @@ +--- +title: Upgrading to v3 +description: "" +position: 2.3 +category: Installation +--- + +::callout{color="red" icon="i-heroicons-exclamation-triangle"} +Note: Postal v3 is currently not released but it can be run on your servers by following these instructions. It will be released shortly. +:: + +::callout{color="orange" icon="i-heroicons-exclamation-circle"} +If you are currently running a version of Postal less than 2.0.0, you should upgrade to v2 before v3. +:: + +Postal v3 will be released in March 2024 and introduced some changes to way that Postal runs. The noteable changes between v2 and v3 are as follows: + +* No need to use RabbitMQ. +* No need to run `cron` or `requeuer` processes. +* Improved logging. +* Improve configuration management (including the ability to configure with environment variables or a config file). + +## Upgrading + + +To upgrade while in beta testing, you need to specify the `latest` version to the upgrade command. + +```bash +cd /opt/postal/install +git pull origin +postal upgrade --version latest +``` + +## Configuration + +Postal v3 introduces a new format for its configuration file. The new configuration file format [can be found in our repository](https://github.com/postalserver/postal/blob/main/doc/config/yaml.yml). + +While v3 is still compatible with configuration from earlier versions but you should change yourr commit to the new format to ensure continued compatibility. Any newly added configuration options are not available in the v1 configuration format. + +## RabbitMQ + +Once you have upgraded to v3, you can remove any RabbitMQ services you have that solely support your Postal installation. + +## Cron & Requeuer Processes + +These processes are not required in Postal v3 and should not be running. diff --git a/content/2.getting-started/5.upgrade-to-v2.md b/content/2.getting-started/5.upgrade-to-v2.md index 9279305..b959147 100644 --- a/content/2.getting-started/5.upgrade-to-v2.md +++ b/content/2.getting-started/5.upgrade-to-v2.md @@ -1,5 +1,5 @@ --- -title: Upgrading from 1.x +title: Upgrading to v2 description: "" position: 2.4 category: Installation