Coverage for templates/description.html: 100%

68 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-03-29 00:10 +0000

1{% extends 'base.html' %} 

2{% load i18n %} 

3{% load static %} 

4{% load bootstrap4 %} 

5  

6{% block title %}{% trans 'federated avatar hosting service' %}{% endblock %} 

7  

8{% block content %} 

9  

10<h2>What is Libravatar?</h2> 

11  

12ivatar/Libravatar (from "libre" and "avatar" or "internet" and "avatar") is a piece of <a href="http://www.gnu.org/philosophy/free-sw.html">free software</a> to do federated avatar hosting. What does that do and why should you care? 

13<br/> 

14Say you've got a profile image you like to use when you have an account somewhere. You want this photo to show up whenever you interact socially with a website. In other words, you want your blog comments, status updates, git commits or anything else you do publicly to be associated with that image. 

15<br/> 

16Uploading your image everywhere is clearly a waste of time. What if there was a place where you could put it and where every website out there could access it easily? That's the idea behind <a href="http://www.gravatar.com/">Gravatar</a>, the service that pioneered this approach and inspired Libravatar. 

17  

18<h2>How to use it</h2> 

19  

20All you have to do is <a href="{% url 'new_account' %}">sign up on libravatar.org</a>, upload your photo and tell us what your email address is. That's all.<br/> 

21<br/> 

22<img src="{% static 'img/ivatar-screenshot-profile-view.png' %}"> 

23<br/> 

24Once you've done that, a bunch of websites (where you've entered your email address, usually as part of the registration process) will start displaying your avatar next to your name.<br/> 

25<img src="{% static 'img/gitlab-profile-view.png' %}"> 

26<br/> 

27  

28<h2>Freedom and federation</h2> 

29  

30How is Libravatar <a href="{% url 'features' %}">different</a> from Gravatar though? The main difference is that while <a href="{% url 'home' %}">Libravatar.org</a> is an online avatar hosting service just like Gravatar, the software that powers the former is also available for download under a free software license. 

31<br/> 

32Why would you want to <a href="{% url 'run_your_own' %}">run your own</a> instance? Our belief is that centralised approaches don't put users in control. If you own your own domain name, you control how mail is delivered to your domain. You should also be able to control how avatars are served to other websites. 

33<br/> 

34  

35For example, if you own a business, you may want to integrate with existing systems (e.g. a staff directory) and delegate authentication to what you're already using (LDAP?). Plus, you can choose what happens when email addresses are not found (display your company logo?). 

36<br/> 

37  

38<h2>What else?</h2> 

39  

40Libravatar also supports things like <a href="http://openid.net/">OpenID</a>. Not only can you <a href="{% url 'openid-login' %}">login</a> without creating a username and password, but you can also assign a photo to your OpenID identifier just like you assign photos to your email addresses.<br/> 

41<img src="{% static 'img/ivatar-openid-screenshot.png' %}"> 

42<br/> 

43<!-- TODO: Pipeline URL --> 

44There are lots of other things in the <a href="https://bugs.launchpad.net/libravatar/+bugs?field.importance=WISHLIST">pipeline</a> and if you have a great idea why not tell us? 

45  

46<h2>How does it work?</h2> 

47  

48The basic architecture is meant to be simple and scalable: 

49<br/> 

50  

51<ol> 

52 <li>Users log into a dynamic <a href="http://www.djangoproject.com/">Django</a>-based site where they upload their photos and confirm their email or OpenID addresses.</li> 

53 <li>Photos are dynamically resized as requested directly to end-user browsers.</li> 

54</ol> 

55<br/> 

56<!-- TODO architecture picture does no longer reflect the reality --> 

57<img src="{% static 'img/architecture.png' %}"> 

58<br/> 

59<br/> 

60  

61<!-- TODO: API url --> 

62If you're interested in the details of how third-party websites display Libravatar photos, have a look at our <a href="https://wiki.libravatar.org/api/">API</a>. The gist of it is that clients get a base URL via a DNS lookup and then tack on the hashed value of the user's email or OpenID address to form the final image: 

63<br/> 

64<figure> 

65 <img src="https://seccdn.libravatar.org/avatar/63a75a80e6b1f4adfdb04c1ca02e596c"> 

66 <figcaption>&lt;img src="https://seccdn.libravatar.org/avatar/63a75a80e6b1f4adfdb04c1ca02e596c"&gt;</code></figcaption> 

67</figure>  

68<br/> 

69<!-- TODO: Libraries url --> 

70It's pretty simple, but for most web applications it's even easier because they're just using one of the convenient <a href="https://wiki.libravatar.org/libraries/">libraries</a> provided by the community. 

71  

72  

73<div style="height:40px"></div> 

74  

75{% endblock %}