Mercurial > eldonilo > avatar

annotate configuration.js.example @ 20:e4916f1763e5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Sat, 16 Jul 2011 13:54:47 +0200
parents 9ff8f951da99
children d63a2784564d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
1 /*
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
2 * Copyright (C) 2011 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
3 *
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
4 * This file is the source code of an XMPP avatar retriever.
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
5 *
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or modify
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
7 * it under the terms of the GNU Affero General Public License as
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
8 * published by the Free Software Foundation, version 3 of the License.
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
9 *
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
10 * This program is distributed in the hope that it will be useful,
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
13 * GNU Affero General Public License for more details.
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
14 *
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
15 * You should have received a copy of the GNU Affero General Public License
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
17 */
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
18
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
19 'use strict';
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
20
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
21 var config = exports;
d5cfe54f11aa Initial commit.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
22
13
38ddd5888b8d It’s now a client instead of a component. :)
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 10
diff changeset
23 // The JID and password of the account used.
20
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
24 config.jid = 'avatar@example.org';
8
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
25 config.password = 'hellohello';
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
26
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
27 // Root of the webservice, useful if you want to proxy it.
20
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
28 config.webRoot = '/avatar/';
8
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
29
9
9360b78c7a5b Add WebHost configuration, and default it to both IPv6 and IPv4.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8
diff changeset
30 // These are the host and the port on which the web service will
9360b78c7a5b Add WebHost configuration, and default it to both IPv6 and IPv4.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8
diff changeset
31 // listen. If you want IPv4 connection only, instead of both IPv4 and
9360b78c7a5b Add WebHost configuration, and default it to both IPv6 and IPv4.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8
diff changeset
32 // IPv6, replace '::' by '0.0.0.0'. If you want a port < 1024, you
9360b78c7a5b Add WebHost configuration, and default it to both IPv6 and IPv4.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8
diff changeset
33 // have to start it as root, use a proxy or redirect it using a
9360b78c7a5b Add WebHost configuration, and default it to both IPv6 and IPv4.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8
diff changeset
34 // firewall like iptables.
9360b78c7a5b Add WebHost configuration, and default it to both IPv6 and IPv4.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8
diff changeset
35 config.webHost = '::';
8
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
36 config.webPort = 8032;
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
37
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
38 // Directory for the cache of the images.
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
39 config.directory = 'data';
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
40
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
41 // When true, assume that the TYPE of the avatar is image/png if not
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
42 // specified. Warning: it doesn’t follow the spec and is only a
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
43 // workaround for buggy clients.
e0cd5ede76af Better documentation.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 7
diff changeset
44 config.guessType = false;
16
27eaec05cfd0 Expire the avatar after a configurable amount of time.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 13
diff changeset
45
27eaec05cfd0 Expire the avatar after a configurable amount of time.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 13
diff changeset
46 // Time after which the avatar will be retrieved again, in seconds.
27eaec05cfd0 Expire the avatar after a configurable amount of time.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 13
diff changeset
47 config.expire = 24*60*60;
18
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
48
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
49 // Allowed extensions, associated with their MIME type.
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
50 config.extensions = {
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
51 png: 'image/png',
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
52 svg: 'image/svg+xml',
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
53 jpg: 'image/jpeg',
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
54 gif: 'image/gif'
92d6e1b40df5 Move available extensions into configuration.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 16
diff changeset
55 };
19
9ff8f951da99 Add Gravatar fallback.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 18
diff changeset
56
20
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
57 // Image to use as fallback when there is no usable avatar. If not set,
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
58 // a SVG image will be displayed.
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
59 //config.defaultImage = 'http://example.org/default.svg';
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
60
19
9ff8f951da99 Add Gravatar fallback.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 18
diff changeset
61 // Try Gravatar if there is a problem during XMPP avatar retrieving.
20
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
62 //config.useGravatar = false;
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
63
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
64 // Prints XMPP stanzas
e4916f1763e5 Deactivable debug; fix a stupid bug in gravatar; add a better default image and make it configurable.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 19
diff changeset
65 config.debug = false;