This is the main dovel repository, it has the Go code to run dovel SMTP server.
Author: b (git@mail.blmayer.dev)
Date: Mon Jul 17 16:07:42 2023 -0300
Parent: e1cd59f
Improved XDG config
commit cf90e66ad8e334aabf020c153c31cd2521f00d0a
Author: b <git@mail.blmayer.dev>
Date: Mon Jul 17 16:07:42 2023 -0300
Improved XDG config
diff --git a/README.md b/README.md
index 9598e6b..7d25fc1 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,8 @@ find the go code and template pages. Feel free to send us email and contribute.
Some code meta information:
-[](https://goreportcard.com/report/blmayer.dev/x/dovel)
-[](https://pkg.go.dev/blmayer.dev/x/dovel)
+[](https://goreportcard.com/report/git.derelict.garden/dovel/email)
+[](https://pkg.go.dev/git.derelict.garden/dovel/email)
Also, take a look at our landing page:
commit cf90e66ad8e334aabf020c153c31cd2521f00d0a
Author: b <git@mail.blmayer.dev>
Date: Mon Jul 17 16:07:42 2023 -0300
Improved XDG config
diff --git a/TODO.txt b/TODO.txt
index a908fd5..eb715a1 100644
--- a/TODO.txt
+++ b/TODO.txt
@@ -9,7 +9,7 @@
✓ Support DKIM if needed
☐ Improve web users
✓ Add insert attachments button
-☐ Use XDG desktop for config path
+✓ Use XDG desktop for config path
☐ Support SMTP for sending email?
☐ Add config menu
☐ Add denylist filtering
commit cf90e66ad8e334aabf020c153c31cd2521f00d0a
Author: b <git@mail.blmayer.dev>
Date: Mon Jul 17 16:07:42 2023 -0300
Improved XDG config
diff --git a/cmd/dovel/main.go b/cmd/dovel/main.go
index ac366e6..560d97f 100644
--- a/cmd/dovel/main.go
+++ b/cmd/dovel/main.go
@@ -42,7 +42,7 @@ var (
)
func main() {
- configPath := path.Join(os.UserConfigDir(), "config.json")
+ configPath := path.Join(os.UserConfigDir(), "dovel", "config.json")
configFile, err := os.Open(configPath)
if err != nil {
println("open config", err.Error(), ". Using defaults")
commit cf90e66ad8e334aabf020c153c31cd2521f00d0a
Author: b <git@mail.blmayer.dev>
Date: Mon Jul 17 16:07:42 2023 -0300
Improved XDG config
diff --git a/index.html b/index.html
index 117981c..f4e7e72 100644
--- a/index.html
+++ b/index.html
@@ -89,7 +89,7 @@ _ __ /_ __ \_ | / / _ \_ /
<li>Supports DKIM</li>
</ul>
This project is under the BSD-3-Clause license, its code can be
- found in our <a href=//blmayer.dev/x/dovel>git repository</a>.
+ found in our <a href=//git.derelict.garden/dovel/email>git repository</a>.
<h3>Roadmap</h3>
Dovel is in early stages and in active development, this means there
@@ -99,7 +99,7 @@ _ __ /_ __ \_ | / / _ \_ /
<li><s>Multiple inboxes.</s></li>
<li><s>Support moving and deleting email on web.</s></li>
<li><s>Dark theme</s></li>
- <li>PGP support.</li>
+ <li><s>PGP support.</s></li>
<li>Multiple users.</li>
<li>Implement mailing lists behaviour.</li>
</ul>
@@ -109,23 +109,21 @@ _ __ /_ __ \_ | / / _ \_ /
<h2>Installation</h2>
To install <tt>dovel</tt> you need <tt>golang</tt> propperly installed,
- ports 25 and 443 available, this guide works for MacOS, Linux and BSD
+ and a port, normally 25, this guide works for MacOS, Linux and BSD
systems.
<ol>
<li>
Install dovel by running:
- <tt>go install blmayer.dev/x/dovel/cmd/dovel</tt>.
+ <tt>go install git.derelict.garden/dovel/email/cmd/dovel</tt>.
</li>
<li>
Configure dovel by creating the configuration file, an
- example is provided below. Running <tt>dovel</tt>
+ example is provided bellow. Running <tt>dovel</tt>
is enough to start.
</li>
<li>
Configure your MX record in your domain registrar to
point to your server. This is needed to receive email.
- Define a password for your user using the environment
- variable DOVEL_PASS.
</li>
<li>
Configure other DNS records as you wish in your domain
@@ -136,9 +134,9 @@ _ __ /_ __ \_ | / / _ \_ /
</ol>
<h3>Example configuration</h3>
- Dovel needs the file <tt>~/.dovel-config.json</tt> is order to work
- correctly, otherwise it will use default settings which may not suit
- you.
+ Dovel needs the file <tt>~/.config/dovel/config.json</tt> is order to
+ work correctly, otherwise it will use default settings which may not
+ suit you.
<pre>
{
"webport": "8000",
@@ -165,15 +163,14 @@ _ __ /_ __ \_ | / / _ \_ /
<p>
To see all options please refer to the
- <a href=//pkg.go.dev/blmayer.dev/x/dovel> go docs</a>.
+ <a href=//pkg.go.dev/git.derelict.garden/dovel/email> go docs</a>.
</p>
<h2>Using</h2>
Using <tt>dovel</tt> email server and the web interface is meant to be
super easy: the server uses the configuration above, you can add more
inboxes. The web interface is much more interesting: It uses the
- Golang <tt>template</tt> package to build pages. The default user is
- "x", the password is set using an environment variable.
+ Golang <tt>template</tt> package to build pages.
<p>
As a starting point, look at the <tt>www/</tt> folder in our
@@ -182,11 +179,6 @@ _ __ /_ __ \_ | / / _ \_ /
application to apply changes.
</p>
- <p>
- I currently use dovel for my personal email and my git mail
- workflow.
- </p>
-
<h3>Functions</h3>
In addition to the template features provided by golang, this project
defines some functions to improve its capabilities, the go
@@ -194,8 +186,8 @@ _ __ /_ __ \_ | / / _ \_ /
<h2>Contributing</h2>
Sending bug reports, starting discussions and sending patches can be
- done easily by email, this project follows the convention I defined
- on <a href=//blmayer.dev/x>my projects page</a>.
+ done easily by email, this project follows the convention defined
+ on <a href=//git.derelict.garden>derelict garden's git</a>.
<p>
Financial support is also greatly appreciated, you can donate