source: skype/README @ 21a387f

Last change on this file since 21a387f was 21a387f, checked in by Miklos Vajna <vmiklos@…>, at 2008-06-18T17:47:26Z

docu update

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