From cd428a60b178aa621ac26e47a7d404af596eecd1 Mon Sep 17 00:00:00 2001 From: Igor Pashev Date: Wed, 6 Apr 2016 03:16:36 +0800 Subject: Version 0.0.1 --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..67eb6fb --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +Juan de la Cosa +=============== + +HTTP server for managing [MariaDB](http://mariadb.org/) users. +Designed to work behind [Sproxy](https://github.com/zalora/sproxy) +and assuming users' logins are their email addresses +(MariaDB allows up to 80 characters). + +Currently it only let users get new passwords. + +Requirements +============ +Juan de la Cosa is written in Haskell with [GHC](http://www.haskell.org/ghc/). +All required Haskell libraries are listed in [juandelacosa.cabal](juandelacosa.cabal). +Use [cabal-install](http://www.haskell.org/haskellwiki/Cabal-Install) +to fetch and build all pre-requisites automatically. + +Installation +============ + $ git clone https://github.com/zalora/juandelacosa.git + $ cd juandelacosa + $ cabal install + +Usage +===== +Type `juandelacosa --help` to see usage summary: + + Usage: + juandelacosa [options] + + Options: + -f, --file=MYCNF Read this MySQL client config file + -g, --group=GROUP Read this options group in the above file [default: client] + + -s, --socket=SOCK Listen on this UNIX-socket [default: /tmp/juandelacosa.sock] + -p, --port=PORT Instead of UNIX-socket, listen on this TCP port (localhost) + + -h, --help Show this message + +Example: + + $ juandelacosa -p 8080 + $ curl http://localhost:8080 -H 'From: jack.frost@example.com' + Tiw7CdJOmYxJBZ7J + +The above request will change the password for 'jack.frost@example.com'@'%' +and return the new password to user. Once it's behind Sproxy +any user can get a new password in a secure way. + -- cgit v1.2.3