Simple open source Libravatar__ compatible avatar image server written in PHP.
+Features:
+
+- Delivers images for email addresses
+- 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.
+
__ http://wiki.libravatar.org/api/
2. Adjust the config file to your needs
3. Create a default image and put it into the raw folder, name it ``default.png``
4. Setup your web server and set the document root to the ``www/`` directory.
- Make sure you allow ``.htaccess`` file and have ``mod_rewrite`` activated.
+ Make sure you allow the ``.htaccess`` file and have ``mod_rewrite`` activated.
+5. 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.
=====
You can force the update with ``--force``.
+====
+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
+
+__ https://www.libravatar.org/tools/check_domain
+__ https://www.libravatar.org/tools/check
+
+
=======
License
=======
git.cweiske.de / surrogator.git / blobdiff