Typo
This commit is contained in:
parent
715536250e
commit
435910eff8
|
@ -72,7 +72,9 @@ Screenshots of login and sign up web pages:
|
||||||
After login, you will be redirected to the `Dashboard` page, please click the
|
After login, you will be redirected to the `Dashboard` page, please click the
|
||||||
`Add a mail server` button to add a new mail server.
|
`Add a mail server` button to add a new mail server.
|
||||||
|
|
||||||
Explanation of the form fields (screenshots attached below):
|
![](./images/iredmail-easy/installation/add_mailserver.png){: width="600px" }
|
||||||
|
|
||||||
|
Explanation of the form fields:
|
||||||
|
|
||||||
* `Hostname (FQDN)`: This is the server hostname you want to set for the mail server.
|
* `Hostname (FQDN)`: This is the server hostname you want to set for the mail server.
|
||||||
|
|
||||||
|
@ -113,67 +115,73 @@ Explanation of the form fields (screenshots attached below):
|
||||||
|
|
||||||
* `Comment`: Add some text to help you identify this mail server.
|
* `Comment`: Add some text to help you identify this mail server.
|
||||||
|
|
||||||
Screenshots:
|
Click the button to create mail server, after created, page will be redirected
|
||||||
|
to mail server profile page. You're free to update profile here.
|
||||||
|
|
||||||
![](./images/iredmail-easy/installation/add_mailserver.png){: width="600px" }
|
|
||||||
![](./images/iredmail-easy/installation/added_mailserver.png){: width="600px" }
|
![](./images/iredmail-easy/installation/added_mailserver.png){: width="600px" }
|
||||||
|
|
||||||
## Choose preferred backend and softwares
|
## Choose preferred backend
|
||||||
|
|
||||||
After added mail server, you will be redirected to mail server profile page.
|
Tab `Backend` on the mail server profile page.
|
||||||
There're few tabs on the page, let's go through them one by one.
|
|
||||||
Screenshots attached below.
|
|
||||||
|
|
||||||
* Tab (mail server) `Profile`.
|
A backend is a SQL or LDAP database used to store mail domains and
|
||||||
|
accounts. We suggest you choose the one you're familiar with for easier
|
||||||
We already filled all form fields while creating it, you're free to update
|
maintaince.
|
||||||
them here.
|
|
||||||
|
|
||||||
* Tab `Backend`.
|
|
||||||
|
|
||||||
A backend is a SQL or LDAP database used to store mail domains and
|
|
||||||
accounts. We suggest you choose the one you're familiar with for easier
|
|
||||||
maintaince.
|
|
||||||
|
|
||||||
* Tab `Components`.
|
|
||||||
|
|
||||||
A component is a software (or software group) used by mail service. On this
|
|
||||||
page you can choose the components you want to deploy on your mail server.
|
|
||||||
|
|
||||||
* Tab `Settings`.
|
|
||||||
|
|
||||||
Depends on the components you selected, the settings on this page may be
|
|
||||||
different. Please fill all required form fields on this page.
|
|
||||||
|
|
||||||
Fields with red asterisk are required, others are optional.
|
|
||||||
|
|
||||||
* Tab `Deployment`.
|
|
||||||
|
|
||||||
The deployment server will run Ansible to connect to your mail server via
|
|
||||||
secure ssh connection, without a password. Please download the prepared
|
|
||||||
script and upload it to the mail server, then run it with command below. it will help add ssh public key and
|
|
||||||
set correct file permission. If ssh login user is not root, it will help
|
|
||||||
setup `sudo` (on Linux) or `doas` (on OpenBSD).
|
|
||||||
|
|
||||||
```
|
|
||||||
bash init_target_server.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
After you added ssh public key, click the button `Perform Full Deployment`
|
|
||||||
to start the iRedMail deployment.
|
|
||||||
|
|
||||||
Depends on the components you selected, and network connection speed, it
|
|
||||||
may take few minutes or even longer to finish. Please be patient.
|
|
||||||
|
|
||||||
![](./images/iredmail-easy/installation/backends.png){: width="700px" }
|
![](./images/iredmail-easy/installation/backends.png){: width="700px" }
|
||||||
|
|
||||||
|
## Choose components you want to deploy
|
||||||
|
|
||||||
|
Tab `Components` on the mail server profile page.
|
||||||
|
|
||||||
|
A component is a software (or software group) used by mail service. On this
|
||||||
|
page you can choose the components you want to deploy on your mail server.
|
||||||
|
|
||||||
![](./images/iredmail-easy/installation/components.png){: width="700px" }
|
![](./images/iredmail-easy/installation/components.png){: width="700px" }
|
||||||
|
|
||||||
|
## Component settings
|
||||||
|
|
||||||
|
Tab `Settings` on the mail server profile page.
|
||||||
|
|
||||||
|
Depends on the components you selected, the settings on this page may be
|
||||||
|
different. Please fill all required form fields on this page.
|
||||||
|
|
||||||
|
Fields with red asterisk are required, others are optional.
|
||||||
|
|
||||||
![](./images/iredmail-easy/installation/settings.png){: width="700px" }
|
![](./images/iredmail-easy/installation/settings.png){: width="700px" }
|
||||||
|
|
||||||
|
## Deploy
|
||||||
|
|
||||||
|
Tab `Deployment` on the mail server profile page.
|
||||||
|
|
||||||
|
The selected deployment server will run Ansible to connect to your mail server
|
||||||
|
via secure ssh connection, without a password. Please download the prepared
|
||||||
|
script and upload it to the mail server, then run it with command below. it
|
||||||
|
will help add ssh public key and set correct file permission. If ssh login user
|
||||||
|
is not root, it will help setup `sudo` (on Linux) or `doas` (on OpenBSD) also.
|
||||||
|
|
||||||
|
```
|
||||||
|
bash init_target_server.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
If your mail server sits behind a firewall, please make sure the selected
|
||||||
|
deployment server is whitelisted in your firewall.
|
||||||
|
|
||||||
|
Now click the button `Perform Full Deployment` to start the deployment.
|
||||||
|
|
||||||
|
Depends on the components you selected, and network connection speed, it may
|
||||||
|
take few minutes or even longer to finish. Please be patient.
|
||||||
|
|
||||||
|
It will refresh the page every 5 seconds and show you the latest output of
|
||||||
|
Ansible task, you can watch and (hopefully) have some fun. :)
|
||||||
|
|
||||||
![](./images/iredmail-easy/installation/deployment.png){: width="700px" }
|
![](./images/iredmail-easy/installation/deployment.png){: width="700px" }
|
||||||
|
|
||||||
## Get techinical support through the ticket system
|
## Get techinical support through the ticket system
|
||||||
|
|
||||||
If you have any question or issue, feel free to open a new support ticket,
|
If you have any question or issue, feel free to open a new support ticket,
|
||||||
clearly explain the question or issue, support team will try to reply in time.
|
clearly explain the question or issue, support team will try to reply as soon
|
||||||
|
as possible.
|
||||||
|
|
||||||
![](./images/iredmail-easy/installation/support.png){: width="400px" }
|
![](./images/iredmail-easy/installation/support.png){: width="400px" }
|
||||||
|
|
||||||
|
|
|
@ -27,7 +27,10 @@
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#sign-up-and-login">Sign up and login</a></li>
|
<li><a href="#sign-up-and-login">Sign up and login</a></li>
|
||||||
<li><a href="#add-a-new-mail-server">Add a new mail server</a></li>
|
<li><a href="#add-a-new-mail-server">Add a new mail server</a></li>
|
||||||
<li><a href="#choose-preferred-backend-and-softwares">Choose preferred backend and softwares</a></li>
|
<li><a href="#choose-preferred-backend">Choose preferred backend</a></li>
|
||||||
|
<li><a href="#choose-components-you-want-to-deploy">Choose components you want to deploy</a></li>
|
||||||
|
<li><a href="#component-settings">Component settings</a></li>
|
||||||
|
<li><a href="#deploy">Deploy</a></li>
|
||||||
<li><a href="#get-techinical-support-through-the-ticket-system">Get techinical support through the ticket system</a></li>
|
<li><a href="#get-techinical-support-through-the-ticket-system">Get techinical support through the ticket system</a></li>
|
||||||
<li><a href="#update-account-profile">Update account profile</a></li>
|
<li><a href="#update-account-profile">Update account profile</a></li>
|
||||||
<li><a href="#see-also">See Also</a></li>
|
<li><a href="#see-also">See Also</a></li>
|
||||||
|
@ -115,7 +118,8 @@ platform, if you don't like or need it, feel free to remove your own account in
|
||||||
<h2 id="add-a-new-mail-server">Add a new mail server</h2>
|
<h2 id="add-a-new-mail-server">Add a new mail server</h2>
|
||||||
<p>After login, you will be redirected to the <code>Dashboard</code> page, please click the
|
<p>After login, you will be redirected to the <code>Dashboard</code> page, please click the
|
||||||
<code>Add a mail server</code> button to add a new mail server.</p>
|
<code>Add a mail server</code> button to add a new mail server.</p>
|
||||||
<p>Explanation of the form fields (screenshots attached below):</p>
|
<p><img alt="" src="./images/iredmail-easy/installation/add_mailserver.png" width="600px" /></p>
|
||||||
|
<p>Explanation of the form fields:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>
|
<li>
|
||||||
<p><code>Hostname (FQDN)</code>: This is the server hostname you want to set for the mail server.</p>
|
<p><code>Hostname (FQDN)</code>: This is the server hostname you want to set for the mail server.</p>
|
||||||
|
@ -163,57 +167,48 @@ of selected deployment server.</p>
|
||||||
<p><code>Comment</code>: Add some text to help you identify this mail server.</p>
|
<p><code>Comment</code>: Add some text to help you identify this mail server.</p>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>Screenshots:</p>
|
<p>Click the button to create mail server, after created, page will be redirected
|
||||||
<p><img alt="" src="./images/iredmail-easy/installation/add_mailserver.png" width="600px" />
|
to mail server profile page. You're free to update profile here.</p>
|
||||||
<img alt="" src="./images/iredmail-easy/installation/added_mailserver.png" width="600px" /></p>
|
<p><img alt="" src="./images/iredmail-easy/installation/added_mailserver.png" width="600px" /></p>
|
||||||
<h2 id="choose-preferred-backend-and-softwares">Choose preferred backend and softwares</h2>
|
<h2 id="choose-preferred-backend">Choose preferred backend</h2>
|
||||||
<p>After added mail server, you will be redirected to mail server profile page.
|
<p>Tab <code>Backend</code> on the mail server profile page.</p>
|
||||||
There're few tabs on the page, let's go through them one by one.
|
|
||||||
Screenshots attached below.</p>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p>Tab (mail server) <code>Profile</code>.</p>
|
|
||||||
<p>We already filled all form fields while creating it, you're free to update
|
|
||||||
them here.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Tab <code>Backend</code>.</p>
|
|
||||||
<p>A backend is a SQL or LDAP database used to store mail domains and
|
<p>A backend is a SQL or LDAP database used to store mail domains and
|
||||||
accounts. We suggest you choose the one you're familiar with for easier
|
accounts. We suggest you choose the one you're familiar with for easier
|
||||||
maintaince.</p>
|
maintaince.</p>
|
||||||
</li>
|
<p><img alt="" src="./images/iredmail-easy/installation/backends.png" width="700px" /></p>
|
||||||
<li>
|
<h2 id="choose-components-you-want-to-deploy">Choose components you want to deploy</h2>
|
||||||
<p>Tab <code>Components</code>.</p>
|
<p>Tab <code>Components</code> on the mail server profile page.</p>
|
||||||
<p>A component is a software (or software group) used by mail service. On this
|
<p>A component is a software (or software group) used by mail service. On this
|
||||||
page you can choose the components you want to deploy on your mail server.</p>
|
page you can choose the components you want to deploy on your mail server.</p>
|
||||||
</li>
|
<p><img alt="" src="./images/iredmail-easy/installation/components.png" width="700px" /></p>
|
||||||
<li>
|
<h2 id="component-settings">Component settings</h2>
|
||||||
<p>Tab <code>Settings</code>.</p>
|
<p>Tab <code>Settings</code> on the mail server profile page.</p>
|
||||||
<p>Depends on the components you selected, the settings on this page may be
|
<p>Depends on the components you selected, the settings on this page may be
|
||||||
different. Please fill all required form fields on this page.</p>
|
different. Please fill all required form fields on this page.</p>
|
||||||
<p>Fields with red asterisk are required, others are optional.</p>
|
<p>Fields with red asterisk are required, others are optional.</p>
|
||||||
</li>
|
<p><img alt="" src="./images/iredmail-easy/installation/settings.png" width="700px" /></p>
|
||||||
<li>
|
<h2 id="deploy">Deploy</h2>
|
||||||
<p>Tab <code>Deployment</code>.</p>
|
<p>Tab <code>Deployment</code> on the mail server profile page.</p>
|
||||||
<p>The deployment server will run Ansible to connect to your mail server via
|
<p>The selected deployment server will run Ansible to connect to your mail server
|
||||||
secure ssh connection, without a password. Please download the prepared
|
via secure ssh connection, without a password. Please download the prepared
|
||||||
script and upload it to the mail server, then run it with command below. it will help add ssh public key and
|
script and upload it to the mail server, then run it with command below. it
|
||||||
set correct file permission. If ssh login user is not root, it will help
|
will help add ssh public key and set correct file permission. If ssh login user
|
||||||
setup <code>sudo</code> (on Linux) or <code>doas</code> (on OpenBSD).</p>
|
is not root, it will help setup <code>sudo</code> (on Linux) or <code>doas</code> (on OpenBSD) also.</p>
|
||||||
<p><code>bash init_target_server.sh</code></p>
|
<pre><code>bash init_target_server.sh
|
||||||
<p>After you added ssh public key, click the button <code>Perform Full Deployment</code>
|
</code></pre>
|
||||||
to start the iRedMail deployment.</p>
|
|
||||||
<p>Depends on the components you selected, and network connection speed, it
|
<p>If your mail server sits behind a firewall, please make sure the selected
|
||||||
may take few minutes or even longer to finish. Please be patient.</p>
|
deployment server is whitelisted in your firewall.</p>
|
||||||
</li>
|
<p>Now click the button <code>Perform Full Deployment</code> to start the deployment.</p>
|
||||||
</ul>
|
<p>Depends on the components you selected, and network connection speed, it may
|
||||||
<p><img alt="" src="./images/iredmail-easy/installation/backends.png" width="700px" />
|
take few minutes or even longer to finish. Please be patient.</p>
|
||||||
<img alt="" src="./images/iredmail-easy/installation/components.png" width="700px" />
|
<p>It will refresh the page every 5 seconds and show you the latest output of
|
||||||
<img alt="" src="./images/iredmail-easy/installation/settings.png" width="700px" />
|
Ansible task, you can watch and (hopefully) have some fun. :)</p>
|
||||||
<img alt="" src="./images/iredmail-easy/installation/deployment.png" width="700px" /></p>
|
<p><img alt="" src="./images/iredmail-easy/installation/deployment.png" width="700px" /></p>
|
||||||
<h2 id="get-techinical-support-through-the-ticket-system">Get techinical support through the ticket system</h2>
|
<h2 id="get-techinical-support-through-the-ticket-system">Get techinical support through the ticket system</h2>
|
||||||
<p>If you have any question or issue, feel free to open a new support ticket,
|
<p>If you have any question or issue, feel free to open a new support ticket,
|
||||||
clearly explain the question or issue, support team will try to reply in time.</p>
|
clearly explain the question or issue, support team will try to reply as soon
|
||||||
|
as possible.</p>
|
||||||
<p><img alt="" src="./images/iredmail-easy/installation/support.png" width="400px" /></p>
|
<p><img alt="" src="./images/iredmail-easy/installation/support.png" width="400px" /></p>
|
||||||
<h2 id="update-account-profile">Update account profile</h2>
|
<h2 id="update-account-profile">Update account profile</h2>
|
||||||
<p>You can update your name, time zone, password on the <code>Profile</code> page. If you
|
<p>You can update your name, time zone, password on the <code>Profile</code> page. If you
|
||||||
|
|
Loading…
Reference in New Issue