fix screenshots and add disclaimer to self-hosted

This commit is contained in:
Vincent (Wen Yu) Ge
2024-02-25 21:00:32 -05:00
parent cd97b4fbc1
commit 5d350e93b7
5 changed files with 20 additions and 8 deletions

View File

@@ -10,6 +10,12 @@ Because email deliverability can be both tricky and hard, it is often easier to
In this document, you will learn how to connect a 3rd party SMTP provider like MailGun or SendGrid with Appwrite to help you get better email deliverability. In this document, you will learn how to connect a 3rd party SMTP provider like MailGun or SendGrid with Appwrite to help you get better email deliverability.
{% info title="Setting up Appwrite Messaging?" %}
This page describes how to setup messaging for your self-hosted Appwrite instance to send email verifications and magic URLs during login.
If you are looking to send custom emails for promotions, news letters, and other purposes, view the [documentation for Appwrite Messaging](/docs/products/messaging) documentation.
{% /info %}
# Environment variables {% #environment-variables %} # Environment variables {% #environment-variables %}
At this stage, we assume that you have already installed Appwrite. If not, you can follow our [Self Hosting Guide](/docs/advanced/self-hosting) for the installation. Appwrite offers multiple environment variables to customize your server setup to your needs. To configure Appwrite to use your own SMTP server, you need to set the following environment variables in the hidden .env file that comes with your Appwrite installation. At this stage, we assume that you have already installed Appwrite. If not, you can follow our [Self Hosting Guide](/docs/advanced/self-hosting) for the installation. Appwrite offers multiple environment variables to customize your server setup to your needs. To configure Appwrite to use your own SMTP server, you need to set the following environment variables in the hidden .env file that comes with your Appwrite installation.

View File

@@ -6,6 +6,12 @@ description: Set up SMS services for your self-hosted Appwrite instance. Discove
Appwrite supports phone authentication, which allows users to create accounts and log in using SMS messages. Appwrite requires an SMS provider to be set up before using Phone authentication. Appwrite supports phone authentication, which allows users to create accounts and log in using SMS messages. Appwrite requires an SMS provider to be set up before using Phone authentication.
{% info title="Setting up Appwrite Messaging?" %}
This page describes how to setup messaging for your self-hosted Appwrite instance to send one-time passwords during phone login.
If you are looking to send custom messages for promotions, reminders, and other purposes, view the [documentation for Appwrite Messaging](/docs/products/messaging) documentation.
{% /info %}
# SMS providers {% #sms-providers %} # SMS providers {% #sms-providers %}
Appwrite supports a growing list of SMS providers that you can choose from. Choose one from the list below and set up an account. Appwrite supports a growing list of SMS providers that you can choose from. Choose one from the list below and set up an account.

View File

@@ -52,15 +52,15 @@ make sure you've configured [a topic](/docs/products/messaging/topics) and [a ta
{% tabsitem #console title="Console" %} {% tabsitem #console title="Console" %}
To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**. To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**.
{% only_dark %} {% only_dark %}
![Create email message](/images/docs/messaging/messages/dark/create-email-message.png) ![Create an sms message](/images/docs/messaging/messages/dark/create-sms-message.png)
{% /only_dark %} {% /only_dark %}
{% only_light %} {% only_light %}
![Create email message](/images/docs/messaging/messages/create-email-message.png) ![Create an sms message](/images/docs/messaging/messages/create-sms-message.png)
{% /only_light %} {% /only_light %}
Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**.
Verify that you can receive the message in your inbox. If not Verify that you can receive the message in your inbox. If not, check for logs in the Appwrite Console or in your provider's logs.
{% /tabsitem %} {% /tabsitem %}
{% tabsitem #server-sdk title="Server SDK" %} {% tabsitem #server-sdk title="Server SDK" %}

View File

@@ -52,10 +52,10 @@ make sure you've configured [a topic](/docs/products/messaging/topics) and [a ta
{% tabsitem #console title="Console" %} {% tabsitem #console title="Console" %}
To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**. To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**.
{% only_dark %} {% only_dark %}
![Create email message](/images/docs/messaging/messages/dark/create-email-message.png) ![Create an sms message](/images/docs/messaging/messages/dark/create-sms-message.png)
{% /only_dark %} {% /only_dark %}
{% only_light %} {% only_light %}
![Create email message](/images/docs/messaging/messages/create-email-message.png) ![Create an sms message](/images/docs/messaging/messages/create-sms-message.png)
{% /only_light %} {% /only_light %}
Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**.

View File

@@ -51,12 +51,12 @@ Before sending your first message,
make sure you've configured [a topic](/docs/products/messaging/topics) and [a target](/docs/products/messaging/targets) to send messages to. make sure you've configured [a topic](/docs/products/messaging/topics) and [a target](/docs/products/messaging/targets) to send messages to.
{% tabs %} {% tabs %}
{% tabsitem #console title="Console" %} {% tabsitem #console title="Console" %}
To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **Email**. To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**.
{% only_dark %} {% only_dark %}
![Create email message](/images/docs/messaging/messages/dark/create-email-message.png) ![Create an sms message](/images/docs/messaging/messages/dark/create-sms-message.png)
{% /only_dark %} {% /only_dark %}
{% only_light %} {% only_light %}
![Create email message](/images/docs/messaging/messages/create-email-message.png) ![Create an sms message](/images/docs/messaging/messages/create-sms-message.png)
{% /only_light %} {% /only_light %}
Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**.