aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 67eb6fb4806f635701db5749c5b99a08a7f448bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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.