Ailur-Archives
/
CTAMail
Archived
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Tracker-Friendly 2024-06-26 00:09:48 +01:00
parent 4cfa13572f
commit ac811aa92e
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,3 +1,21 @@
# CTAMail
Hectamail rewrite in Go
This is a rewrite of HectaMail, a now derelict python-based maddy frontend, using Golang.
## Nice, how do I host my own
Just git clone, go build, copy & edit the config and run the executable:
```
git clone https://concord.hectabit.org/HectaBit/CTAMail.git --depth=1
cd CTAMail
go build
cp config.ini.example config.ini
nano config.ini # Or vim or what have you
./ctamail
```
Read `ERRORS.md` for more infomation on server administration and errors.
## Great! What's the API?
You don't need the API. It's not designed to be interfaced with outside of itself, unlike other Burger-based software, and is entirely self contained. If you *must*, we do not provide offical support and you should just read `main.go`.