Dovel website repository.
Author: brian (git@myr.sh)
Date: Tue Dec 26 19:19:45 2023 -0300
Parent: e574500
Updated index
diff --git a/index.html b/index.html
index 47fb3fd..64e5824 100644
--- a/index.html
+++ b/index.html
@@ -16,22 +16,15 @@ body {
padding: 20px;
font-family: sans-serif;
}
-
pre {
font-weight: bold;
background: lightgray;
padding: 8px;
border-radius: 8px;
}
-
ol li {
padding-bottom: 10px;
}
-
-tt {
- font-weight: bold;
-}
-
@media (prefers-color-scheme: dark) {
pre {
background: darkslategray;
@@ -92,7 +85,7 @@ _ __ /_ __ \_ | / / _ \_ /
</ul>
<h2>Installation</h2>
- To install <tt>dovel</tt> you need <tt>go</tt> propperly installed and
+ To install <kbd>dovel</kbd> you need <kbd>go</kbd> propperly installed and
a port available, this guide works for MacOS, Linux and BSD systems.
<ol>
<li>
@@ -101,7 +94,7 @@ _ __ /_ __ \_ | / / _ \_ /
</li>
<li>
Configure dovel by creating the configuration file, an
- example is provided below. Running <tt>server</tt>
+ example is provided below. Running <kbd>server</kbd>
is enough to start.
</li>
<li>
@@ -120,9 +113,9 @@ _ __ /_ __ \_ | / / _ \_ /
</li>
</ol>
- <h3>Example configuration</h3>
+ <h3>Configuring</h3>
The following configuration is enought to receive emails: Dovel needs
- the file <tt>~/.config/dovel/config.json</tt> is order to work
+ the file <kbd>~/.config/dovel/config.json</kbd> is order to work
correctly, otherwise it will use default settings which may not
suit you. The field <i>vaultFile</i> is optional for receiving emails.
<pre>{
@@ -131,22 +124,34 @@ _ __ /_ __ \_ | / / _ \_ /
"vaultFile": "users.json"
}</pre>
- Dovel can handle email for different domains, so you can have multiple
- inboxes. To achieve this handler files must be created in the
- <kbd>~/.config/dovel/hooks/</kbd> folder. The program will run the
- corresponding hook passing the email as standard input. For example:
- suppose your domain is <i>dovel.email</i>, emails addressed to
- <i>joe@dovel.email</i> will be handled by a hook named
- <kbd>receive-dovel.email</kbd> and emails sent by this domain are
+ Now the hook must be placed: suppose your domain is <i>dovel.email</i>,
+ emails addressed to <i>joe@dovel.email</i> will be handled by a hook
+ named <kbd>receive-dovel.email</kbd> and emails sent by this domain are
handled by <kbd>send-dovel.email</kbd> likewise.
<p>
+ So, to enable a domain, simply create the according script.
To see all options please refer to the
<a href=//pkg.go.dev/dovel.email/server> go docs</a>.
</p>
+ <h3>Hooks</h3>
+ Dovel can handle email for different domains, so you can have multiple
+ inboxes. To achieve this handler files must be created in the
+ <kbd>~/.config/dovel/hooks/</kbd> folder. The program will run the
+ corresponding hook passing the email as standard input.
+
+ <p>
+ Dovel has some usefull hooks in the
+ <a href=hooks/index.html>hooks</a> repository:
+ </p>
+ <ul>
+ <li>receive-example.domain</li>
+ </ul>
+
+
<h2>Using</h2>
- Using <tt>dovel</tt> email server is meant to be super easy: the server
+ Using <kbd>dovel</kbd> email server is meant to be super easy: the server
uses the configuration above, you can add the vault file in order to
authenticate users that want to send emails. After creating the config
file, simply run <kbd>server</kbd> to start the server.