docs: update docs for v3 release

postalserver · Mar 5, 2024 · 5d5db64 · 5d5db64
1 parent 7f01199
commit 5d5db64
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 41 deletions.
diff --git a/content/2.getting-started/1.prerequisites.md b/content/2.getting-started/1.prerequisites.md
@@ -25,11 +25,11 @@ It doesn't matter what operating system you choose as long as you are able to in
 
 Postal runs entirely using containers which means to run Postal you'll need some software to run these containers. We recommend using Docker for this purpose but you can use whatever software you wish.
 
-You'll need to install Docker on your server to begin with. [Follow the instructions on the Docker website](https://docs.docker.com/get-docker/) to install Docker.
+You'll need to install Docker Engine on your server to begin with. [Follow the instructions on the Docker website](https://docs.docker.com/engine/install/) to install Docker.
 
-In addition to Docker, you'll also need `docker-compose`. This is an extra utility which [can be found on the Docker website](https://docs.docker.com/compose/install/).
+You'll also need to ensure you have the [Docker Compose plugin](https://docs.docker.com/compose/install/linux/) installed.
 
-Before continuing ensure that you can run both `docker` and `docker-compose` from your prompt.
+Before continuing ensure that you can run both `docker` and `docker compose` from your prompt.
 
 ## System utilities
 
@@ -79,22 +79,3 @@ docker run -d \
 ::callout{icon="i-heroicons-information-circle"}
 Whilst you can configure the maximum message size however you wish, you will need to verify that MariaDB is configured with <code>innodb_log_file_size</code> to at least 10 times the biggest message you wish to send (150MB for 15MB email, 250MB for 25MB email, etc).<br><br>If you have a legacy v1 database you might also want to check that raw tables in the database have the type <code>LONGBLOB</code>.
 ::
-
-
-## RabbitMQ
-
-RabbitMQ is responsible for dispatching messages between different processes - in our case, the workers. As with MariaDB, there are numerous ways for you to install this. For this guide, we're just going to run a single RabbitMQ worker.
-
-```
-docker run -d \
-   --name postal-rabbitmq \
-   -p 127.0.0.1:5672:5672 \
-   --restart always \
-   -e RABBITMQ_DEFAULT_USER=postal \
-   -e RABBITMQ_DEFAULT_PASS=postal \
-   -e RABBITMQ_DEFAULT_VHOST=postal \
-   rabbitmq:3.8
-```
-
-* This will run a single RabbitMQ instance and have it listen on port 5672.
-* Be sure to choose a secure password. You'll need to put this in your Postal configuration when you install it so be sure to make a (secure) note of it.
diff --git a/content/2.getting-started/2.installation.md b/content/2.getting-started/2.installation.md
@@ -29,10 +29,6 @@ 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.

diff --git a/content/2.getting-started/4.upgrade-to-v3.md b/content/2.getting-started/4.upgrade-to-v3.md
@@ -5,15 +5,11 @@ 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:
+Postal v3 was 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. 
@@ -22,20 +18,13 @@ Postal v3 will be released in March 2024 and introduced some changes to way that
 
 ## 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
-```
+To upgrade, you can follow the same instructions as provided on the [upgrade page](/getting-started/upgrading)
 
 ## 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). 
+Postal v3 introduces a new format for its configuration file. An example of the full, 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.
+While v3 is still compatible with configuration from earlier versions but you should change your configuration to the new format to ensure continued compatibility. Any newly added configuration options are not available in the v1 configuration format.
 
 ## RabbitMQ