https://github.com/andreineculau/gravatar-proxy

A gravatar proxy for your intranet
https://github.com/andreineculau/gravatar-proxy

Last synced: 24 days ago
JSON representation

A gravatar proxy for your intranet

• Host: GitHub
• URL: https://github.com/andreineculau/gravatar-proxy
• Owner: andreineculau
• Created: 2015-08-02T21:03:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-08T19:18:08.000Z (about 9 years ago)
• Last Synced: 2023-03-12T09:48:04.653Z (over 1 year ago)
• Language: CoffeeScript
• Size: 113 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Gravatar proxy

A gravatar proxy for your intranet

## Install and run

```sh

git clone git://github.com/andreineculau/gravatar-proxy.git

cd gravatar-proxy

npm install

# edit config.coffee as you see fit

npm start

```

Here's what you can configure out-of-the-box: [config.coffee](config.coffee).

In production, try

* [forever](https://github.com/foreverjs/forever)

* [upstarter](https://github.com/carlos8f/node-upstarter)

* ...

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/andreineculau/gravatar-proxy)

## URLs

Accessing a gravatar is done via `GET /`.

In order to make an email (its hash) known, just `POST /[email protected]`.

If you want to create aliases, just `PUT /[email protected]`

## Common setups

By default, gravatar-proxy will, well.. proxy requests straight to gravatar.com .

### Redirect setup

A common setup is that you have some server that hosts the avatars and you

just want a proxy to tie up the MD5 hashes to the usernames, and maybe also

restrict the email addresses to those that are known to your group.

You can see an example in [getAvatar.redirect.coffee](getAvatar.redirect.coffee),

assuming that your `config.coffee` looks like this

```coffee

  getAvatar: require './getAvatar.redirect'

  allowUnknownHashes: false

```

### Proxy with resizing setup

In addition to the previous setup, you might want to resize the avatars based on

`req.query.s(ize)` or implement support for `req.query.d(efault)`.

You can see an example in [getAvatar.storeAndResize.coffee](getAvatar.storeAndResize.coffee),

assuming that your `config.coffee` looks like this

```coffee

  getAvatar: require './getAvatar.storeAndResize'

  allowUnknownHashes: true

```

and you have executed

```bash

npm install request lwip

mkdir cache

```

**NOTE**: this setup has `allowUnknownHashes: true` because

[getAvatar.storeAndResize.coffee](getAvatar.storeAndResize.coffee) handles unknown hashes on its own.

## License

[Apache 2.0](LICENSE)