mirror of
https://github.com/kyantech/Palmr.git
synced 2025-10-23 06:11:58 +00:00
4fb7007db2
- Removed the outdated .eslintrc.json file and replaced it with a new eslint.config.mjs file for better configuration management. - Added .prettierrc.json to enforce consistent code formatting and included a .prettierignore file to exclude specific directories from formatting. - Updated components.json to streamline alias definitions and ensure proper icon library usage. - Enhanced package.json with new linting, formatting, and validation scripts to improve development workflow. - Made various formatting adjustments across multiple files for consistency and clarity.
70 lines
3.0 KiB
Plaintext
70 lines
3.0 KiB
Plaintext
---
|
||
title: ✉️ Configuring SMTP
|
||
---
|
||
|
||
For Palmr to function with all its best features, we need to configure our email server. To make this easier, there is a built-in configuration panel inside **Settings** in Palmr. However, only users with an **ADMIN** profile can access and configure these settings.
|
||
|
||
## ❓ Why Configure SMTP?
|
||
|
||
The main functionalities that depend on SMTP configuration are:
|
||
|
||
- 🔑 **Password Reset** – Users who forget their password and cannot access the **Settings** panel need this feature.
|
||
- 📧 **Email Notifications** – Recipients will receive emails when new shares are sent to them.
|
||
|
||
Now, let's go through the step-by-step process to configure the **SMTP Server**.
|
||
|
||
---
|
||
|
||
### 🔧 Accessing SMTP Settings
|
||
|
||
To access **Settings**, an **ADMIN** user must click on the profile picture in the **header** and select **Settings** from the dropdown menu.
|
||
|
||
|
||
|
||
Once inside the **Settings** panel, click on the **Email** card to expand the SMTP configuration options.
|
||
|
||
|
||
|
||
After expanding the card, the following SMTP configuration fields will appear:
|
||
|
||
|
||
|
||
---
|
||
|
||
### ⚙️ Configuring SMTP Server
|
||
|
||
The first step is to **enable SMTP** by selecting "Yes" in the **SMTP Enabled** field.
|
||
|
||
|
||
|
||
Once SMTP is enabled, you can configure the other necessary fields:
|
||
|
||
- **Sender Name** – This will appear as the sender’s name in emails. (Example: "Palmr")
|
||
- **Sender Email** – The email address from which notifications will be sent. (Example: "noreply@palmr.app")
|
||
- **SMTP Server** – The SMTP server address. You can use any email service provider. For Gmail, use `smtp.gmail.com` (this is the recommended option and set as default).
|
||
- **SMTP Port** – The server port. For Gmail, the standard port is **587**.
|
||
- **SMTP Username** – The username for the SMTP server. For Gmail, enter your email address.
|
||
- **SMTP Password** – The SMTP password. (Generate an App Password for Gmail)
|
||
|
||
> **Important:** If using **Gmail**, you need to generate an **App Password** instead of using your standard email password.
|
||
> For other email services, consult the official documentation of the service provider you are using. We recommend using Gmail for simplicity and limits the number of emails sent.
|
||
|
||
---
|
||
|
||
### 🔐 Generating a Gmail App Password
|
||
|
||
To generate an App Password for Gmail:
|
||
|
||
1. Go to [Google My Account](https://myaccount.google.com/).
|
||
2. Select **Security**.
|
||
3. Scroll down to **App Passwords**.
|
||
4. Generate a new password specifically for Palmr.
|
||
|
||
For a complete guide, refer to: **[How to set up SMTP credentials with Gmail](https://medium.com/rails-to-rescue/how-to-set-up-smtp-credentials-with-gmail-for-your-app-send-email-cf236d11087d)**.
|
||
|
||
---
|
||
|
||
### ✅ Finalizing SMTP Configuration
|
||
|
||
After entering the correct information, save the settings. Palmr is now ready to send emails for password resets and share notifications!
|