search

wollardj / Mandrill

Multi-user web front-end for managing a Munki repository.
Apache License 2.0
51 stars 3 forks source link

readme

NO LONGER MAINTAINED

I'm no longer in the macintosh systems engineering game, so I no longer have a professional need for a tool such as this. If anyone is interested in providing this project with a new loving home, please reach out!

Mandrill

Multi-user web front-end for managing a Munki repository. If you're here because of MailChimp, my apologies but this isn't the Mandrill you're looking for. /wavehand

Mandrill is a NodeJS web application written using the Meteor framework. It supports one database engine: MongoDB. There are no plans to support other engines, but fear not, mandrillctl will install and secure MongoDB for you. If you already have MongoDB running on your server via homebrew, you should probably remove that installation first, or use an alternate server.

mandrill git-log

Installing Mandrill on Linux

Most of the instructions below only apply to OS X. If you're using Linux, see the step through wiki guide for Ubuntu or CentOS to get started.

Installation Prerequisites

Installing mandrillctl OS X Only

Installation kicks off with the installation of the command line tool for Mandrill, mandrillctl. Since you're here, you've already got npm and node installed, so all you need to do is...

sudo npm install -g mandrillctl

The -g means it's installing mandrillctl globally instead of within your home directory. It's also going to drop a symlink in your search path which you probably wouldn't be able to do without running it through sudo.

Installing Mandrill On OS X

mandrillctl makes it pretty simple to install MongoDB + Mandrill and have your server running in no time. In general, there are four commands you'll want to run to make this happen:

# Install mandrill
sudo mandrillctl --install

# Defaults to port 80.
# If you specify a port that's in use by another process,
# mandrillctl let you know.
sudo mandrillctl --set-http-port 3001

# Set your hostname (sub directories aren't supported)
sudo mandrillctl --set-http-host http://mandrill.example.com

# Don't forget to turn on the lights before you go
sudo mandrillctl --start

That's it! Using the example values above, you should now be able to open your browser to http://mandrill.example.com:3001 and login!

Initial Login

Like any good web app, the default username and password are admin and admin. I hope it's obvious that you should change this password immediately.

Updating Mandrill

Mandrill has a built in command for updating to the current release

sudo mandrillctl --update

Additional Mandrill commands

You can get a list of mandrillctl options by issuing:

mandrillctl --help

As of version 0.7.1 the following options are available:

-h, --help                     output usage information
-i, --install                  Alias for --update
-u, --update                   Installs or updates Mandrill and its
                               requirements.
                               NOTE: If you need to use a proxy server, set 
                               the http_proxy environment variable prior to
                               running this command.
                               `export http_proxy=http://proxy.server:port/`
-f, --force                    Use with -u or -i to bypass prompts
-s, --status                   Displays the status of the Mandrill and MongoDB
                               server processes.
--stop                         Halts the MongoDB and Mandrill servers
--start                        Starts the MongoDB and Mandrill servers
--restart                      Restarts the MongoDB and Mandrill servers
--no-logo                      Don't include the Mandrill logo and version in
                               the output
--get-http-port                Displays the port on which Mandrill will listen
--set-http-port <port>         Sets the port on which Mandrill will
                               listen
--get-http-host                Displays the host/fqdn for the Mandrill server.
--set-http-host <http://fqdn>  Sets the host/fqdn for the
                               Mandrill server
--uninstall                    Uninstalls Mandrill, MongoDB + databases.
                               mandrillctl will not uninstall itself.

Questions?