Surrogator Code
Simple Libravatar compatible avatar image server
Status: Alpha
Brought to you by:
cweiske
Menu
▾
▴
Tree [9a8729] master / History
Andreas Resch
Read Me
Surrogator
Simple open source Libravatar compatible avatar image server written in PHP.
Features:
- Delivers images for email addresses and OpenIDs
- Very easy to setup.
- No graphics processing is done on the server, keeping the CPU load low. All avatar images get pre-generated for a set of sizes
- If no image at the user requested size is found, the next larger image gets returned.
- Supports the mm fallback image (mystery man)
Homepage: sf.net/p/surrogator
Setup
Copy data/surrogator.config.php.dist to data/surrogator.config.php (remove the .dist)
Adjust the config file to your needs
(optional) Create a default image and put it into the raw folder, name it default.png
Setup your web server and set the document root to the www/ directory. Make sure you allow the .htaccess file and have mod_rewrite activated.
Add DNS entries for _avatars._tcp and _avatars-sec._tcp. A bind config file excerpt would look like this:
_avatars._tcp.example.org. IN SRV 0 0 80 avatars.example.org _avatars-sec._tcp.example.org. IN SRV 0 0 443 avatars.example.org
This makes the avatar server avatars.example.org responsible for the domain example.org, on ports 80 (HTTP) and 443 (HTTPS).
It is possible to use an existing domain as avatar server. Just copy avatar.php into its document root dir and copy the rewrite rule from .htaccess into the domain's .htaccess file if one exists. If not, copy the whole .htaccess file. After that, you have to point the $cfgFile path at the beginning of the avatar.php file to the correct location.
Usage
Put images in raw/ folder. Name has to be email address + image file extension, for example foo@example.org.png. Surrogator supports .png, .jpg and svg files.
For OpenIDs, use the url-encoded URL + extension as filename, for example replace / with %2F. The filename for http://example.org/~foo would be http:%2F%2Fexample.org%2F~foo.jpg.
Run php surrogator.php. The small files get generated.
You will get more information with -v
When you run surrogator.php again, it will only generate small files when the raw file is newer than the "square" file in the var folder. You can force the update with --force.
Note: PHP imagick extension is required for svg files.
Test
To check if everything is setup correctly, try the following tools:
- Libravatar domain check tool for DNS resolution tests
- Libravatar server check tool for image resolving tests
See the libravatar wiki about running a custom server and the API specification for more information.
License
Surrogator is licensed under the AGPL v3 or later.
Author
Written by Christian Weiske, cweiske@cweiske.de
