Skip to content

Commit

Permalink
update docs for v3
Browse files Browse the repository at this point in the history
  • Loading branch information
adamcooke committed Mar 4, 2024
1 parent 6e1578b commit bb3870d
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 1 deletion.
4 changes: 4 additions & 0 deletions content/2.getting-started/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>/opt/postal/config</code> as <code>/config</code> so any full directory paths mentioned in <code>postal.yml</code> will likely need to start with <code>/config</code> and not <code>/opt/postal/config</code>
::

::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.
Expand Down
46 changes: 46 additions & 0 deletions content/2.getting-started/4.upgrade-to-v3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Upgrading to v3
description: ""
position: 2.3
category: Installation
---

::callout{color="red" icon="i-heroicons-exclamation-triangle"}
<b>Note:</b> 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.
2 changes: 1 addition & 1 deletion content/2.getting-started/5.upgrade-to-v2.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Upgrading from 1.x
title: Upgrading to v2
description: ""
position: 2.4
category: Installation
Expand Down

0 comments on commit bb3870d

Please sign in to comment.