source: skype/README @ 7ce0373

Last change on this file since 7ce0373 was 7ce0373, checked in by Miklos Vajna <vmiklos@…>, at 2009-06-06T11:54:36Z

bitlebee-skype is now part of Debian experimental

  • Property mode set to 100644
File size: 12.5 KB
Line 
1= Skype plugin for BitlBee
2Miklos Vajna <vmiklos-at-vmiklos-dot-hu>
3
4== Status
5
6[quote, Wilmer van der Gaast (author of BitlBee)]
7____
8Okay, this exists now, with lots of thanks to vmiklos for his *excellent*
9work!!
10
11It's not in the main BitlBee and it'll never be for various reasons, but
12because it's a plugin that shouldn't be a problem.
13____
14
15One day I browsed the BitlBee bugtracker and found
16http://bugs.bitlbee.org/bitlbee/ticket/82[this] ticket. Then after a while I
17returned and saw that it was still open. So I wrote it.
18
19It's pretty stable (one day I wanted to restart it because of an upgrade
20and just noticed it was running for 2+ months without crashing), I use
21it for my daily work. Being a plug-in, no patching is required, you can
22just install it after installing BitlBee itself.
23
24NOTE: You will see that this implementation of the Skype plug-in still requires
25a Skype instance to be running. This is because I'm not motivated to reverse
26engineer Skype's
27http://en.wikipedia.org/wiki/Skype_Protocol#Obfuscation_Layer[obfuscation
28layer]. (Not mentioning that you should ask your lawyer about if it is legal or
29not..)
30
31== Requirements
32
33* Skype >= 1.4.0.99. The latest version I've tested is 2.0.0.72.
34* BitlBee >= @BITLBEE_VERSION@. Use old versions (0.5.1 or earlier) if
35  you have older BitlBee installed.
36* Skype4Py >= 0.9.28.7. Previous versions won't work due to API changes.
37  The latest version I've tested is 1.0.31.0.
38
39* Python >= 2.5. Skype4Py does not work with 2.4.
40* PyGObject >= 2.8.0. Older versions are part of PyGTK. (And you don't want to
41  install GTK for nothing, right?)
42* pyopenssl or python-gnutls.
43
44`bitlbee-skype` has been tested under Linux and Mac OS X. Skype and Skype4py is
45available under Windows, too, so it probably works, but this has not been tested.
46
47== How to set it up
48
49Before you start. The setup is the following: BitlBee can't connect directly to
50Skype servers (the company's ones). It needs a running Skype client to do so.
51In fact BitlBee will connect to `skyped` (a tcp server, provided in this
52package) and `skyped` will connect to to your Skype client.
53
54The benefit of this architecture is that you can run Skype and `skyped`
55on a machine different to the one where you run BitlBee (it can be even
56a public server) and/or your IRC client.
57
58NOTE: The order is important. First `skyped` starts Skype. Then `skyped`
59connects to Skype, finally BitlBee can connect to `skyped`.
60
61=== Installing under Frugalware or Debian
62
63- Install the necessary packages:
64
65----
66# pacman-g2 -S bitlbee-skype
67----
68
69or
70
71----
72# apt-get install skyped bitlbee-plugin-skype
73----
74
75and you don't have to compile anything manually.
76
77=== Installing under OS X
78
79- Install the necessary packages from ports:
80
81NOTE: You have to edit the Portfile manually to include the install-dev target,
82just append install-dev after install-etc.
83
84----
85# port -v install bitlbee
86# port -v install py25-gobject
87----
88
89and you have to install `bitlbee-skype`, `skype4py` and `python-gnutls` from
90source.
91
92=== Installing from source
93
94NOTE: bitlbee-skype by default builds and installs skyped and the
95plugin. In case you just want to install the plugin for a public server
96or you want to use skyped with a public server (like
97`bitlbee1.asnetinc.net`), you don't need both.
98
99- You need the latest stable BitlBee release (unless you want to use a
100  public server):
101
102----
103$ wget http://get.bitlbee.org/src/bitlbee-@BITLBEE_VERSION@.tar.gz
104$ tar xf bitlbee-@BITLBEE_VERSION@.tar.gz
105$ cd bitlbee-@BITLBEE_VERSION@
106----
107
108- Now compile and install it:
109
110----
111$ ./configure
112$ make
113# make install install-dev
114----
115
116- To install http://skype4py.sourceforge.net/[Skype4Py] from source
117  (unless you want to install the plugin for a public server):
118
119----
120$ tar -zxvf Skype4Py-x.x.x.x.tar.gz
121$ cd Skype4Py-x.x.x.x
122# python setup.py install
123----
124
125- To install http://pypi.python.org/pypi/python-gnutls[python-gnutls] from source
126  (unless you want to install the plugin for a public server):
127
128----
129$ tar -zxvf python-gnutls-x.x.x.tar.gz
130$ cd python-gnutls-x.x.x
131# python setup.py install
132----
133
134NOTE: On OS X you will need the following hacks first:
135
136----
137$ export LD_LIBRARY_PATH=/opt/local/lib
138$ export CFLAGS="-I/opt/local/include"
139$ export LDFLAGS="-L/opt/local/lib"
140----
141
142- Get the plugin code (in an empty dir, or whereever you want, it does
143  not matter):
144
145----
146$ wget http://vmiklos.hu/project/bitlbee-skype/bitlbee-skype-@VERSION@.tar.gz
147$ tar xf bitlbee-skype-@VERSION@.tar.gz
148$ cd bitlbee-skype-@VERSION@
149----
150
151- Compile and install it:
152
153----
154$ ./configure
155$ make
156# make install
157----
158
159This will install the plugin to where BitlBee expects them, which is
160`/usr/local/lib/bitlbee` if you installed BitlBee from source.
161
162=== Configuring
163
164- Set up `~/.skyped/skyped.conf`: Create the `~/.skyped` directory, copy
165  `skyped.conf` and `skyped.cnf` from
166  `/usr/local/etc/skyped/skyped.conf` to `~/.skyped`, adjust `username`
167  and `password`. The `username` should be your Skype login and the
168  `password` can be whatever you want, but you will have to specify that
169  one when adding the Skype account to BitlBee (see later).
170
171NOTE: Here, and later - `/usr/local/etc` can be different on your installation
172if you used the `--sysconfdir` switch when running bitlbee-skype's `configure`.
173
174- Generate the SSL pem files:
175
176----
177# cd ~/.skyped
178# openssl req -new -x509 -days 365 -nodes -config skyped.cnf -out skyped.cert.pem \
179        -keyout skyped.key.pem
180----
181
182NOTE: Maybe you want to adjust the permissions in the `~/.skyped`
183dir. For example make it readable by just your user.
184
185- If both pyopenssl and python-gnutls are available, then python-gnutls
186  will be used. This behaviour can be overwritten by:
187
188----
189$ export SKYPED_NO_GNUTLS=1
190----
191
192- Start `skyped` (the tcp server):
193
194----
195$ skyped
196----
197
198- Start your `IRC` client, connect to BitlBee and add your account:
199
200----
201account add skype <user> <pass>
202account set skype/server localhost
203----
204
205<user> should be your Skype account name, <pass> should be the one you declared
206in `skyped.conf`. If you want to run skyped on a remote machine, replace
207`localhost` with the name of the machine.
208
209If you are running skyped on a custom port:
210
211----
212account set skype/port <port>
213----
214
215If you want to set your full name (optional):
216
217----
218account set skype/display_name "John Smith"
219----
220
221If you want to see your skypeout contacts online as well (they are
222offline by default):
223
224----
225account set skype/skypeout_offline false
226----
227
228== Setting up Skype in a VNC server (optional)
229
230Optionally, if you want to run Skype on a server, you might want to setup up
231a `VNC` server as well. I used `tightvnc` but probably other `VNC` servers will
232work, too.
233
234First run
235
236----
237$ vncpasswd ~/.vnc/passwd
238----
239
240and create a password. You will need it at least once.
241
242Now create `~/.vnc/xstartup` with the following contents:
243
244----
245#!/bin/sh
246
247twm
248----
249
250Adjust the permissions:
251
252----
253$ chmod +x ~/.vnc/xstartup
254----
255
256Then start the server:
257
258----
259$ vncserver
260----
261
262Then connect to it, start an `xterm`, set up Skype (username, password,
263enable X11 API and allow the `Skype4Py` client), quit from Skype, and
264start `skyped`. If you want to watch its traffic, enable debug messages
265and foreground mode:
266
267----
268$ skyped -n -d
269----
270
271== Features
272
273- Download nicks and away statuses from Skype
274
275- Noticing joins / parts while we're connected
276
277- Sending messages
278
279- Receiving messages
280
281- Receiving away status changes
282
283- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
284
285- Error handling when `skyped` is not running and when it exits
286
287- Marking received messages as seen so that Skype won't say there are unread messages
288
289- Adding / removing contacts
290
291- Set away state when you do a `/away`.
292
293- When you `account off`, Skype will set status to `Offline`
294
295- When you `account on`, Skype will set status to `Online`
296
297- Detect when somebody wants to add you and ask for confirmation
298
299- Detect when somebody wants to transfer a file
300
301- Group chat support:
302
303  * Detect if we're invited
304
305  * Send / receive group chat messages
306
307  * Invite others (using `/invite <nick>`)
308
309  * Part from group chats
310
311  * Starting a group chat (using `/j #nick`)
312
313- Topic changes in group chats:
314
315  * Show the current topic (if any) on join
316
317  * Notice when someone changes the topic
318
319  * Support changing the topic using `/topic`
320
321- Viewing the profile using the `info` command.
322
323- Handling skype actions (when the `CHATMESSAGE` has `EMOTED` type)
324
325- Setting your display name using the `nick` command.
326
327- Running Skype on a machine different to BitlBee is possible, the
328  communication is encrypted.
329
330- Managing outgoing calls (with call duration at the end, including
331  SkypeOut calls if you use a phone number instead of a nick):
332
333  * `account set skype/call nick`
334  * `account set -del skype/call`
335
336- Managing incoming calls via questions, just like when you add / remove
337  contacts.
338
339- Querying the current SkypeOut balance:
340
341  * `account set skype/balance query`
342
343- For debug purposes, it's possible to send any command to `skyped`. To
344  achieve this, you need to:
345
346  * `account set skype/skypeconsole true`
347
348  * then writing `skypeconsole: <command>` will work in the control
349    channel.
350
351  * `account set skype/skypeconsole_receive true` will make the
352    `skypeconsole` account dump all the recieved raw traffic for you
353
354- If you want to automatically join bookmarked groupchats right after
355  you logged in, do:
356
357  * `account set skype/auto_join true`
358
359== What needs to be done (aka. TODO)
360
361- Notice if foo invites bar. Currently you can see only that bar joined.
362
363- Public chats. See
364  link:https://developer.skype.com/jira/browse/SCL-381[this feature
365  request], this is because it is still not possible (under Linux) to
366  `join_chat` to a public chat..
367
368- Add yasrd (Yet Another Skype-Related Daemon) to allow using a public
369  server for users who are behind NAT.
370
371== I would like to have support for ...
372
373If something does not work and it's not in the TODO section, then please
374contact me! Please also try the link:HACKING[git version] before reporting a bug, your
375problem may be already fixed there.
376
377In fact, of course, I wrote this documentation after figured out how to do this
378setup, so maybe I left out some steps. If you needed 'any' additional tricks,
379then it would be nice to include them here.
380
381== Known bugs
382
383- File transfers are view-only from BitlBee. Quoting the
384  https://developer.skype.com/Docs/ApiDoc/FILETRANSFER_object[relevant
385  documentation]: 'File transfers cannot be initiated nor accepted via
386  API commands.' So it's not something I can add support for, sadly.
387
388== Screenshots
389
390You can reach some screenshots link:shot[here].
391
392== Additional resources
393
394You can reach the Changelog link:Changelog[here], and a gitweb interface
395http://vmiklos.hu/gitweb/?p=bitlbee-skype.git[here].
396
397The Skype API documentation is
398https://developer.skype.com/Docs/ApiDoc[here] if you're interested.
399
400
401== Testimonials
402
403----
40400:56 < scathe> I like your skype plugin :)
405----
406
407----
408It's really working great so far.
409
410Good Job and thank you!
411Sebastian
412----
413
414----
415Big respect for your work, i really appreciate it.
416
417Martin
418----
419
420----
421Thanks for bitlbee-skype. As a blind Linux user, I cannot use the
422skype GUI client because qt apps ar not accessible yet with the
423available screen readers. bitlbee-skype allows me to make use of skype
424without having to interact much with the GUI client, which helps me a
425lot.
426
427Lukas
428----
429
430----
43102:12 < newton> i must say, i love this little bee ;)
43202:15 < newton> tried it out today with the skype plugin, good work!
433----
434
435----
43618:10 < miCSu> it works fine
437----
438
439----
44013:56 < seo> i just want to thank you :)
44113:56 < seo> for bitlbee-skype
44213:57 < seo> it's working very well, so, again, thank you for your work, and for sharing it
443----
444
445----
44622:16 < ecraven> vmiklos: thanks a lot for the skype plugin for bitlbee!
447----
448
449----
450I'm blind and so I have to use a screen reader, in my case Gnome-Orca.
451But since Skype is written in QT, while Orca uses gtk+, I have no direct
452access to the Skype interface. That's why I desided to use Skyped and
453Erc.
454The text console is fully accessible.
455Thank you very much.
456
457Hermann
458----
459
460----
461i love that bitlbeeplugin. big thx for that.
462
463michael
464----
465
466== Thanks
467
468to the following people:
469
470* Wilmer van der Gaast, for answering questions about the BitlBee plugin interface
471
472* Arkadiusz Wahlig, author of skype4py, for making suggestions to skyped
473
474* Gabor Adam Toth (tg), for noticing extra code is needed to handle multiline
475  messages
476
477* Cristobal Palmer (tarheelcoxn), for helping to testing the plugin in a
478  timezone different to mine
479
480* Risko Gergely, for his SkypeOut ideas
481
482* people on `#bitlbee` for feedback
483
484Back to my link:/projects[projects page].
485
486// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.