Skip to content

Commit

Permalink
fix: from <alert> to ::callout (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
casualmatt authored Mar 4, 2024
1 parent ec29af7 commit 7705552
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 22 deletions.
5 changes: 3 additions & 2 deletions content/2.getting-started/1.prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,10 @@ docker run -d \
* 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.
* If you are unable or unwilling to grant root access, the database user you create separately needs all permissions on databases called `postal` and `postal-*` (this prefix can be configured in the `message_db` part of your configuration).

<alert>
::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>.
</alert>
::


## RabbitMQ

Expand Down
4 changes: 2 additions & 2 deletions content/2.getting-started/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ This will generate three files in `/opt/postal/config`.

Once generated, you should open up `/opt/postal/config/postal.yml` and add all the appropriate values for your installation (database passwords etc...).

<alert>
::callout{icon="i-heroicons-information-circle"}
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>
</alert>
::

## Initializing the database

Expand Down
4 changes: 2 additions & 2 deletions content/2.getting-started/3.upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ position: 2.2
category: Installation
---

<alert>
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
If you're not currently running Postal v2, you'll need to follow the Upgrading from 1.x documentation before you can use these instructions.
</alert>
::

Once you have installed Postal, you can upgrade it by running this command. This will always upgrade you to the latest version of Postal that is available.

Expand Down
4 changes: 2 additions & 2 deletions content/2.getting-started/4.dns-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ You can configure a global SPF record for your mail server which means domains d
</tbody>
</table>

<alert>
::callout{icon="i-heroicons-information-circle"}
You may wish to replace <code>~all</code> with <code>-all</code> to make the SPF record stricter.
</alert>
::

## Return Path

Expand Down
13 changes: 7 additions & 6 deletions content/2.getting-started/5.upgrade-to-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ For the purposes of this guide, we're going to make some assumptions about your
- Your current installation is located at `/opt/postal` and your configuration is in `/opt/postal/config`.
- You use a web proxy (such as nginx, Caddy or Apache) in front of the Postal web server.

<alert>
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
Performing this upgrade will mean that your Postal services will be unavailable for a short period of time. We recommend scheduling some maintenance and performing the upgrade when traffic is low.
</alert>
::

## Preparation

Expand All @@ -39,9 +39,9 @@ There are a few extra system dependencies that you need to install.
- [Docker](https://docs.docker.com/get-docker/)
- [docker-compose](https://docs.docker.com/compose/install/)

<alert type="warning">
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
<b>Important:</b> use the latest versions of these rather than simply just installing the latest package available from your operating system vendor's repositories. Instructions are linked above.
</alert>
::

If you're running an old or unsupported version of your operating system, you may wish to use this as an opportunity to upgrade. The method for doing so is outside of the scope of this documentation.

Expand Down Expand Up @@ -81,9 +81,10 @@ smtp_server:
tls_private_key_path: /config/smtp.key
```

<alert type="warning">
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
<b>Important:</b> if you have referenced files in other parts of your operating system (such as in <code>/etc</code>), you must ensure these are now within the `/opt/postal/config` directory otherwise they won't be available within the container that Postal runs within.
</alert>
::


## Removing the old Postal helper script

Expand Down
4 changes: 2 additions & 2 deletions content/3.features/ip-pools.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ Once an IP pool has been added, you'll need to assign it any organization that s
Once allocated to an organization, you can assign the IP pool to servers from the server's **Settings** page. You can also use the IP pool to configure IP rules for the organization or server.
<alert type="warning">
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
It's <b>very important</b> to make sure that the IP addresses you add in the web interface are actually configured on your Postal servers. If the IPs don't exist on the server, message delivery may fail or messages will not be dequeued correctly.
</alert>
::
4 changes: 2 additions & 2 deletions content/3.features/spam-and-virus-checking.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ category: Features
---
Postal can integrate with SpamAssassin and ClamAV to automatically scan incoming and outgoing messages that pass through mail servers.

<alert type="warning">
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
This functionality is disabled by default.
</alert>
::

## Setting up SpamAssassin

Expand Down
4 changes: 2 additions & 2 deletions content/4.developer/1.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ The HTTP API allows you to send messages to us using JSON over HTTP. You can eit

[Full API documentation](https://apiv1.postalserver.io)

<alert>
::callout{icon="i-heroicons-information-circle"}
This API does not support managing all the functions of Postal. There are plans to introduce a new v2 API which will have more functionality and significantly better documentation. We do not have an ETA for this. Additionally, we will not be accepting any pull requests to extend the current API to have any further functionality than it currently does.
</alert>
::

## General API Instructions

Expand Down
4 changes: 2 additions & 2 deletions content/5.other/2.containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ This runs a worker which will receive jobs from the message queue. Essentially,

**There must only be one of these running.** This process monitors the queues and ensures that messages that need to be retried are re-added to the message queue at the appropriate times. Like the cron, do not run more than one of these processes.

<alert type="warning">
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
Be sure to configure your system to only allow a single <code>cron</code> and <code>requeuer</code> process to be running at the same time.
</alert>
::

## Configuration

Expand Down

0 comments on commit 7705552

Please sign in to comment.