Mirrors/go-inbucket
1
0
Fork 0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 17:47:03 +00:00
Code Issues Releases Wiki Activity

Update README with installation steps

Browse Source
This commit is contained in:
James Hillyerd
2012-10-13 16:12:48 -07:00
parent eb363aa670
commit 6834d71c9b
1 changed files with 33 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -7,15 +7,43 @@ address and make them available to view via a web interface.
It allows web developers, software engineers and system administrators to It allows web developers, software engineers and system administrators to
quickly see the emailed output of ther applications. No per-account setup is quickly see the emailed output of ther applications. No per-account setup is
required! Mailboxes are created on the fly as mail is received for them, and required! Mailboxes are created on the fly as mail is received for them, and
no password is required to browse the cotent of the mailboxes. no password is required to browse the content of the mailboxes.
Inbucket has a built-in SMTP server and stores incoming mail as flat files on Inbucket has a built-in SMTP server and stores incoming mail as flat files on
disk - no external SMTP or database daemons required. disk - no external SMTP or database daemons required.
Status Development Status
------ ------------------
Inbucket is currently in development. It mostly works, but is not well Inbucket is currently in the early stages of development.
tested or documented.
It can:
* Receive SMTP and ESMTP messages and store them to disk
* List subject, sender and date of messages for a particular mailbox
* Display the content of a particular message (text only)
* Display the source of a particular message (headers + body text)
* Delete a message
It does not yet:
* Parse MIME multipart emails
* Display HTML email
* Display or download attachments
Installation
------------
You will need a functioning [Go installation][1] for this to work.
# From the base of your GOPATH...
go get github.com/robfig/revel
go get github.com/jhillyerd/inbucket
go build -o bin/revel github.com/robfig/revel/cmd
bin/revel run github.com/jhillyerd/inbucket
By default the SMTP server will be listening on localhost port 2500 and
the web interface will be available at [localhost:9000](http://localhost:9000/).
Inbucket's configuration can be found in the `inbucket/conf/app.conf` file.
About About
----- -----