annotate README @ 979:1d558dfb32ca

server: pages redirection: when using a redirection dict, a new "page" key can be used to redirect to a named page. "args" can be added to specified named arguments to set (will be put in request.args, in addition to existing ones). The redirection is done dynamically, during the request workflow.
author Goffi <goffi@goffi.org>
date Sun, 12 Nov 2017 12:56:46 +0100
parents 5264fec78a1d
children a24dd1d316f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
903
5264fec78a1d updated version (0.6.1)
Goffi <goffi@goffi.org>
parents: 901
diff changeset
1 Libervia v0.6.1
818
f8a7a046ff9c copyright update
Goffi <goffi@goffi.org>
parents: 790
diff changeset
2 (c) Jérôme Poisson aka Goffi 2008-2016
f8a7a046ff9c copyright update
Goffi <goffi@goffi.org>
parents: 790
diff changeset
3 (c) Adrien Cossa aka Souliane 2013-2016
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
4
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
5 Libervia is a frontend for SàT
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
6 SàT is a XMPP (Jabber) client.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
7
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
8 ** LICENCE **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
9
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
10 Libervia is free software: you can redistribute it and/or modify
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
11 it under the terms of the GNU Affero General Public License as
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
12 the Free Software Foundation, either version 3 of the License, or
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
13 (at your option) any later version.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
14
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
15 Libervia is distributed in the hope that it will be useful,
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
18 GNU Affero General Public License for more details.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
19
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
20 You should have received a copy of the GNU Affero General Public License
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
21 along with Libervia. If not, see <http://www.gnu.org/licenses/>.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
22
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
23
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
24 ** ABOUT **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
25
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
26 Libervia is a web frontend for the "Salut à Toi" (SàT) XMPP client. Please check SàT for more information (it's anyway needed to run libervia)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
27
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
28 ** How to use it ? **
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
29
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
30 Refer to the wiki for installation/use instructions:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
31 http://wiki.goffi.org/wiki/Libervia
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
32
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
33 refer to SàT README for more informations
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
34
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
35 ** CREDIT **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
36
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
37 A big big thank to the authors/contributors of...
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
38
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
39 proxy65:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
40 SàT (plugin_xep_0065) use nearly all the code from proxy65 (http://code.google.com/p/proxy65/) which was coded by Dave Smith (2002-2004) and maintained by Fabio Forno (2007-2008).
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
41 As the original MIT licence allows, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
42
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
43 progressbar:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
44 SàT (jp) use ProgressBar (http://pypi.python.org/pypi/progressbar/2.2), a class coded by Nilton Volpato which allow the textual representation of progression.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
45
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
46 twisted:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
47 SàT is heavily based on the twisted framework (http://twistedmatrix.com/trac/), a very great tool which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :).
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
48
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
49 wokkel:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
50 SàT use a library with high level enhancements on top of twisted, which is called wokkel (http://wokkel.ik.nu). Lot of thanks to Ralph Meijer and all other contributors.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
51
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
52 Urwid:
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
53 Primitivus is based on Urwid (http://excess.org/urwid/) which saved me a lot of time. It's really a great library to easily make a sophisticated interface.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
54
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
55 Pyjamas:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
56 Libervia is built with a Pyjamas (http://pyjs.org), a Google Web Toolkit port for python, including Python to Javascript compiler, and Pyjamas Desktop which allow to execute the same application on the desktop or through a browser. It's really an amazing tool.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
57
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
58 lxml(http://lxml.de/):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
59 this powerful and efficient XML parsing module is used sometimes to replace Twisted internal tools: its API is handy, and it have some features like evil content cleaning.
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
60
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
61 pillow(https://python-pillow.github.io/):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
62 This image manipulation module is used for avatars
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
63
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
64 txJSON-RPC:
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
65 Libervia use txJSON-RPC (https://launchpad.net/txjsonrpc), a twisted library to communicate with the browser's javascript throught JSON-RPC
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
66
168
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
67 Mutagen:
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
68 Mutagen (https://bitbucket.org/lazka/mutagen) is an audio metadata handling library, it's used by the radiocol plugin.
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
69
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
70 Python OTR (http://python-otr.pentabarf.de), PyCrypto (https://www.dlitz.net/software/pycrypto) and pyOpenSSL(https://github.com/pyca/pyopenssl):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
71 Used for cryptography
168
eb2f7b1560c2 misc: README cleaning + added Mutagen to credits
Goffi <goffi@goffi.org>
parents: 166
diff changeset
72
526
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
73 otr.js and its dependencies Big Integer Library, CryptoJS, EventEmitter:
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
74 Libervia frontend uses otr.js and its dependencies:
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
75 - otr.js was coded by Arlo Breault (2014) and is released under the Mozilla Public License Version 2.0
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
76 - Big Integer Library was coded by Leemon Baird (2000-2013) and is in the public domain
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
77 - CryptoJS was coded by Jeff Mott (2009-2013) and is released under the MIT licence
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
78 - EventEmitter was coded by Oliver Caldwell (2011-2013) and is released under the MIT licence
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
79 As the original licences allow, the code is reused and sub-licenced until GPL v3 to follow the rest of the code.
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
80
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
81 mardown (https://pythonhosted.org/Markdown/) and html2text (https://pypi.python.org/pypi/html2text/2015.6.21):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
82 both are used for syntaxes conversions
714
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
83
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
84 Jinja2 (http://jinja.pocoo.org/):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
85 a poweful template engine for Python that we use for designing Libervia's static blog pages
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
86
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
87 miniupnp (http://miniupnp.free.fr/):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
88 this UPnP-IGD implementation is used to facilitate P2P sessions
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
89
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
90 netifaces (https://pypi.python.org/pypi/netifaces):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
91 when available, this module is used to detect local IPs
526
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
92
542
fb20b1423143 README: redirect media credits to sat_media repository (the pictures are no more hosted here)
souliane <souliane@mailoo.org>
parents: 526
diff changeset
93 pictures found in the sat_media repository and used by SàT and Libervia:
fb20b1423143 README: redirect media credits to sat_media repository (the pictures are no more hosted here)
souliane <souliane@mailoo.org>
parents: 526
diff changeset
94 Please read the credits and licence information that are given in the README and COPYING files for each work: http://repos.goffi.org/sat_media/file
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
95
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
96 the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
97
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
98 PyXDF (http://freedesktop.org/wiki/Software/pyxdg):
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
99 Used to follow FreeDesktop XDG standards
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
100
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
101 A special thank to people working on XMPP standards, libre standards are the way to go !
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
102
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
103 and the others:
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
104 and of course, nothing would be possible without Python (http://www.python.org/), GNU and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), and also XFCE (http://www.xfce.org), etc. Thanks thanks thanks, thanks to everybody in the Free (Libre) chain for making a part of the dream.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
105
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
106 If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
107
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
108
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
109 ** CONTRIBUTORS **
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
110
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
111 Salut à Toi has received contributions from:
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
112
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
113 - Adrien Vigneron <adrienvigneron@mailoo.org>: huge work on Libervia's CSS, SàT Logo (the mascot is his work), and Quiz game graphics. He's friendly and talented, his work is really appreciated.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
114
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
115 - Xavier Maillard <xavier@maillard.im>: bugs fixes. He's following the project for a while, maybe a future frontend contributor?
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
116
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
117 - Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>: bugs fixes, Libervia's notification, Libervia as a twisted application plugin. A guy always around XMPP projects, he plan to work on a non D-Bus bridge.
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
118
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
119 - Matthieu Rakotojaona <matthieu.rakotojaona@gmail.com>: English translation of the social contract. A great quality translation!
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
120
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
121 - Thomas Preud'homme <robotux@debian.org>: bugs fixes. He's also one of the co-maintainer of the Debian package.
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
122
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
123 - Dal <kedals0@gmail.com>: profiles management, argparse refactoring in jp.
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
124
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
125 - Matteo Cypriani <mcy@lm7.fr>: jp's mainloop update + doc improvements + various fixes. He's also the other co-maintainer of the Debian package.
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
126
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
127 - Olly Betts <olly@survex.com>: icon fix in Wix [N.B: Wix has been removed]
545
95bdad7041d4 version update
Goffi <goffi@goffi.org>
parents: 542
diff changeset
128
136
9d7d98954e34 misc: updated README with contributors
Goffi <goffi@goffi.org>
parents: 131
diff changeset
129 Many thanks to them.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
130
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
131 A big thanks also to all the maintainers of SàT packages.
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
132
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
133
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
134 ** CONTACT **
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
135
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
136 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
137
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
138 Goffi:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
139 - goffi@goffi.org (e-mail)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
140 - goffi@jabber.fr (jid)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
141 - http://www.goffi.org (blog, with fresh news about SàT)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
142
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
143 Souliane:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
144 - souliane@mailoo.org (e-mail)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
145 - souliane@libervia.org (jid)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
146
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
147 You'll find the latest version and other stuffs on *.goffi.org websites:
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
148
903
5264fec78a1d updated version (0.6.1)
Goffi <goffi@goffi.org>
parents: 901
diff changeset
149 - wiki (wiki.goffi.org), in French & English so far
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
150 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
151 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
152 - mailing lists (lists.goffi.org)
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
153
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
154 and the official SàT website is at http://www.salut-a-toi.org
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
155
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
156
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
157
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
158 This software is dedicated to Roger Poisson.