[README] Add README

main
Joaquin 3 years ago
parent 793a810ceb
commit c4e1855ca7
Signed by: puly
GPG Key ID: 9E9299CD96C65EC6
  1. 27
      README.md

@ -1,3 +1,28 @@
# postmail_demo # postmail_demo
Postmail (PMAIL) Demo Postmail (PMAIL) Demo
# SETUP
Run `pmailcli.mkuser.sh` to setup users
Run `node .` to start the server daemon
Use the postmail scripts for management directly on the server through SSH or mount them on any client though sshfs or anyother filesyncing system
The scripts require no args and walk you through all neccesary input
User LOGIN and server LOGIN prompts are reffering to the user and FQDN/IP youre sending the mail as, not TO
As long as your domain points to the server hosting the server daemon and port 27050 is accesible, no further setup is required and you can send and receive mail as your domain
# Scripts
`pmailcli.fetchmail.sh` - Fetch all new mail
`pmailcli.mkindex.sh` - Create and send pmail
`pmailcli.trust.sh` - Whitelist user (NECCESARY for receiving mail from that user)
`pmailcli.clean.sh` - Clean unused uploaded file on your server to save on storage
When sending mail, for every uploaded file you will be asked for a short description, this is strictly private and is used as a little note describing the file so you can judge later based on the note and filename whether you want to delete it or not after it has been sent to every user

Loading…
Cancel
Save