source: skype/README @ b019c23

Last change on this file since b019c23 was b019c23, checked in by Miklos Vajna <vmiklos@…>, at 2008-06-28T00:06:44Z

add note about skype4py-1.x breakage

  • Property mode set to 100644
File size: 10.0 KB
Line 
1= Skype plugin for BitlBee
2Miklos Vajna <vmiklos-at-vmiklos-dot-hu>
3
4== Status
5
6[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, I use it for my daily work. Being a plug-in, no patching
20is required, you can just install it after installing BitlBee itself.
21
22NOTE: You will see that this implementation of the Skype plug-in still requires
23a Skype instance to be running. This is because I'm not motivated to reverse
24engineer Skype's
25http://en.wikipedia.org/wiki/Skype_Protocol#Obfuscation_Layer[obfuscation
26layer]. (Not mentioning that you should ask your lawyer about if it is legal or
27not..)
28
29== Requirements
30
31* Skype >= 1.4.0.99. The latest version I've tested is 2.0.0.68.
32* BitlBee >= 1.1.1dev. The latest version I've tested is 1.2.
33* Skype4Py >= 0.9.28.7. Previous versions won't work due to API changes.
34NOTE: I had not had time yet to add support for 1.x yet.
35* Python >= 2.5. Skype4Py does not work with 2.4.
36* PyGObject >= 2.8.0. Older versions are part of PyGTK. (And you don't want to
37  install GTK for nothing, right?)
38* pyopenssl or python-gnutls.
39
40`bitlbee-skype` has been tested under Linux and Mac OS X. Skype and Skype4py is
41available under Windows, too, so it probably works, but this has not been tested.
42
43== How to set it up
44
45Before you start. The setup is the following: BitlBee can't connect directly to
46Skype servers (the company's ones). It needs a running Skype client to do so.
47In fact BitlBee will connect to `skyped` (a tcp server, provided in this
48package) and `skyped` will connect to to your Skype client.
49
50The benefit of this architecture is that you can run Skype and `skyped`
51on a machine different to the one where you run BitlBee (it can be even
52a public server) and/or your IRC client.
53
54NOTE: The order is important. First `skyped` starts Skype. Then `skyped`
55connects to Skype, finally BitlBee can connect to `skyped`.
56
57=== Installing under Frugalware
58
59- Install the necessary packages:
60
61----
62# pacman-g2 -S bitlbee-skype skype4py
63----
64
65and you don't have to compile anything manually.
66
67=== Installing under Debian
68
69- Install the necessary development package:
70
71----
72# apt-get install bitlbee-dev
73----
74
75and you have to install `bitlbee-skype` and `skype4py` from source.
76
77=== Installing from source
78
79- You need the latest stable BitlBee release:
80
81----
82$ wget http://get.bitlbee.org/src/bitlbee-1.2.tar.gz
83$ tar xf bitlbee-1.2.tar.gz
84$ cd bitlbee-1.2
85----
86
87NOTE: You no longer need additional patches, as of version 1.1.1dev.
88
89- Now compile and install it:
90
91----
92$ ./configure
93$ make
94# make install install-dev
95----
96
97- Get the plugin code (in an empty dir, or whereever you want, it does
98  not matter):
99
100----
101$ wget http://vmiklos.hu/project/bitlbee-skype/bitlbee-skype-@VERSION@.tar.gz
102$ tar xf bitlbee-skype-@VERSION@.tar.gz
103$ cd bitlbee-skype-@VERSION@
104----
105
106- Compile and install it:
107
108----
109$ ./configure
110$ make
111# make install
112----
113
114This will install the plugin to where BitlBee expects them, which is
115`/usr/local/lib/bitlbee` if you installed BitlBee from source.
116
117- To install http://skype4py.sourceforge.net/[Skype4Py] from source:
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=== Configuring
126
127- Edit `/usr/local/etc/skyped/skyped.conf`: adjust `username` and `password`. The
128  `username` should be your Skype login and the `password` can be whatever you
129  want, but you will have to specify that one when adding the Skype account to
130  BitlBee (see later).
131
132NOTE: Here, and later - `/usr/local/etc` can be different on your installation
133if you used the `--sysconfdir` switch when running bitlbee-skype's `configure`.
134
135- Generate the SSL pem files:
136
137----
138# cd /usr/local/etc/skyped
139# openssl req -new -x509 -days 365 -nodes -config skyped.cnf -out skyped.cert.pem \
140        -keyout skyped.key.pem
141----
142
143NOTE: Maybe you want to adjust the permissions in the `/usr/local/etc/skyped`
144dir. For example make it readable by just your user.
145
146- If both pyopenssl and python-gnutls are available, then python-gnutls
147  will be used. This behaviour can be overwritten by:
148
149----
150$ export SKYPED_NO_GNUTLS=1
151----
152
153- Start `skyped` (the tcp server):
154
155----
156$ skyped
157----
158
159- Start your `IRC` client, connect to BitlBee and add your account:
160
161----
162account add skype <user> <pass>
163account set skype/server localhost
164----
165
166<user> should be your Skype account name, <pass> should be the one you declared
167in `skyped.conf`. If you want to run skyped on a remote machine, replace
168`localhost` with the name of the machine.
169
170If you are running skyped on a custom port:
171
172----
173account set skype/port <port>
174----
175
176If you want to set your full name (optional):
177
178----
179account set skype/display_name "John Smith"
180----
181
182If you want to see your skypeout contacts online as well (they are
183offline by default):
184
185----
186account set skype/skypeout_offline false
187----
188
189== Setting up Skype in a VNC server (optional)
190
191Optionally, if you want to run Skype on a server, you might want to setup up
192a `VNC` server as well. I used `tightvnc` but probably other `VNC` servers will
193work, too.
194
195First run
196
197----
198$ vncpasswd ~/.vnc/passwd
199----
200
201and create a password. You will need it at least once.
202
203Now create `~/.vnc/xstartup` with the following contents:
204
205----
206#!/bin/sh
207
208twm
209----
210
211Adjust the permissions:
212
213----
214$ chmod +x ~/.vnc/xstartup
215----
216
217Then start the server:
218
219----
220$ vncserver
221----
222
223Then connect to it, start an `xterm`, set up Skype (username, password,
224enable X11 API and allow the `Skype4Py` client), quit from Skype, and
225start `skyped`. If you want to watch its traffic, enable debug messages
226and foreground mode:
227
228----
229$ skyped -n -d
230----
231
232== Features
233
234- Download nicks and away statuses from Skype
235
236- Noticing joins / parts while we're connected
237
238- Sending messages
239
240- Receiving messages
241
242- Receiving away status changes
243
244- `skyped` (the tcp daemon that is a gateway between Skype and tcp)
245
246- Error handling when `skyped` is not running and when it exits
247
248- Marking received messages as seen so that Skype won't say there are unread messages
249
250- Adding / removing contacts
251
252- Set away state when you do a `/away`.
253
254- When you `account off`, Skype will set status to `Offline`
255
256- When you `account on`, Skype will set status to `Online`
257
258- Detect when somebody wants to add you and ask for confirmation
259
260- Detect when somebody wants to transfer a file
261
262- Group chat support:
263
264  * Detect if we're invited
265
266  * Send / receive group chat messages
267
268  * Invite others (using `/invite <nick>`)
269
270  * Part from group chats
271
272  * Starting a group chat (using `/j #nick`)
273
274- Topic changes in group chats:
275
276  * Show the current topic (if any) on join
277
278  * Notice when someone changes the topic
279
280  * Support changing the topic using `/topic`
281
282- Viewing the profile using the `info` command.
283
284- Handling skype actions (when the `CHATMESSAGE` has `EMOTED` type)
285
286- Setting your display name using the `nick` command.
287
288- Running Skype on a machine different to BitlBee is possible, the
289  communication is encrypted.
290
291- Managing outgoing calls (with call duration at the end, including
292  SkypeOut calls if you use a phone number instead of a nick):
293
294  * `account set skype/call nick`
295  * `account set -del skype/call`
296
297- Managing incoming calls via questions, just like when you add / remove
298  contacts.
299
300- Querying the current SkypeOut balance:
301
302  * `account set skype/balance query`
303
304== What needs to be done (aka. TODO)
305
306- Notice if foo invites bar. Currently you can see only that bar joined.
307
308- Public chats. See
309  link:https://developer.skype.com/jira/browse/SCL-381[this feature
310  request], this is because it is still not possible (under Linux) to
311  `join_chat` to a public chat..
312
313- Add `--disable-skyped` and `--disable-plugin` switches in case one wants to
314  build `bitlbee-skype` only for a public server or only for use with a public
315  server.
316
317== I would like to have support for ...
318
319If something does not work and it's not in the TODO section, then please
320contact me! Please also try the link:HACKING[git version] before reporting a bug, your
321problem may be already fixed there.
322
323In fact, of course, I wrote this documentation after figured out how to do this
324setup, so maybe I left out some steps. If you needed 'any' additional tricks,
325then it would be nice to include them here.
326
327== Known bugs
328
329- None at this time.
330
331== Screenshots
332
333You can reach some screenshots link:shot[here].
334
335== Additional resources
336
337You can reach the Changelog link:Changelog[here], and a gitweb interface
338http://vmiklos.hu/gitweb/?p=bitlbee-skype.git[here].
339
340The Skype API documentation is
341https://developer.skype.com/Docs/ApiDoc[here] if you're interested.
342
343
344== Testimonials
345
346----
34700:56 < scathe> vmiklos: I like your skype plugin :)
348----
349
350----
351It's really working great so far.
352
353Good Job and thank you!
354Sebastian
355----
356
357----
358Big respect for your work, i really appreciate it.
359
360Martin
361----
362
363----
364Thanks for bitlbee-skype. As a blind Linux user, I cannot use the
365skype GUI client because qt apps ar not accessible yet with the
366available screen readers. bitlbee-skype allows me to make use of skype
367without having to interact much with the GUI client, which helps me a
368lot.
369
370Lukas
371----
372
373----
37402:12 < newton> i must say, i love this little bee ;)
37502:15 < newton> tried it out today with the skype plugin, good work!
376----
377
378== Thanks
379
380for the following people:
381
382* Wilmer van der Gaast, for answering questions about the BitlBee plugin interface
383
384* Arkadiusz Wahlig, author of skype4py, for making suggestions to skyped
385
386* Gabor Adam Toth (tg), for noticing extra code is needed to handle multiline
387  messages
388
389* Cristobal Palmer (tarheelcoxn), for helping to testing the plugin in a
390  timezone different to mine
391
392* Risko Gergely, for his SkypeOut ideas
393
394* people on `#bitlbee` for feedback
395
396Back to my link:/projects[projects page].
397
398// vim: ft=asciidoc
Note: See TracBrowser for help on using the repository browser.