diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e65396 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# mailq-inspector + +State of this tool: Still in development, nothing is really stable at this point + +The goal of mailq-inspector is to provide an easy way to inspect and handle mails that are stuck in your postfix mailq. +It is written in go, so all you need to do to build it is run `go build`. + +## How to use + +At this point, i still need to write a lot of code (and documentation). +Just invoke `mailq-inspector` and maybe pass `--help` to it to get a rough idea of available options. + +## Testing +In order to provide an environment that can be used to test this tool without sacrificing an actual production mailserver, a Vagrantfile is included. +Invoke `vagrant up` to build the box. +Invoke `vagrant rsync-auto` if you want `/vagrant` to stay in sync with the environment on your local machine. + +Finally, invoke `vagrant ssh` to ssh into the vagrant box. + +To test mailq-inspector, change into `/vagrant` and run it: +``` +cd /vagrant +./mailq-inspector +``` + + diff --git a/Vagrantfile b/Vagrantfile index a0f97cc..b08c227 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -10,6 +10,7 @@ Vagrant.configure("2") do |config| # Give that vagrant box an apparently good FQDN echo "local-vagrant.example.com" > /etc/hostname echo "local-vagrant.example.com" > /etc/mailname + echo "127.0.1.2 local-vagrant.example.com local-vagrant" > /etc/hosts hostnamectl set-hostname local-vagrant.example.com # Basic preparations