README
1This is a package implementing a xbmsp streaming protocol server and
2a (test) client code.
3
4COMMAND LINE OPTIONS
5
6 -l address
7 Listen only given local address. Only one -l flag can be
8 given. By default all local interface addresses are listened.
9
10 -p port
11 Listen given port (default is 1400).
12
13 -r directory
14 Use diven document root (default is current dir). If -S
15 flags are present, it's often the best choice to use an
16 empty directory as a document root. With option -r -
17 user can create a virtual root directory into which the
18 directories can be added with -S flag.
19
20 -u user
21 Run as given user. Give up the user privileges and run with
22 as given user instead. You need to have root privileges in
23 order to use this flag.
24
25 -P password
26 Require password authentication from the client. Only
27 clients supplying the given password can use the server.
28 The client can also pass an user name in the authentication
29 step, but it's ignored.
30
31 -L
32 Follow symbolic links in the data directories. Normally
33 symbolic links are not followed because of security reasons.
34 This option overrides the default and more secure option.
35
36 -f
37 Fork process to background.
38
39 -F pidfile
40 Save pid number to given file. This is especially usable
41 if the server is running in the daemon mode (-f).
42
43 -S mountpoint=dir
44 Show dir in the root of the fileserver as mountpoint. Multiple
45 -S flags can be present.
46
47EXAMPLE
48
49 ccxstream -f -F /var/run/ccxstream.pid -P s3cre7 -r /u/documents -S video=/u/videos -S audio=/u/mp3
50
51 Run server in background and show directory /u/documents as a
52 root directory of the server. In addition show directory
53 /u/videos in as directory video and directory /u/mp3 as directory
54 audio in the document root. All clients need to authenticate
55 with password "s3cre7"
56
57CAUTION
58
59 For security reasons symbolic links are not followed. Document root
60 can however be a symbolic link. If you want to use symbolic link
61 to point to a shared directory (-S flag) you can circumvent the
62 symbolic link by adding /. to the end of the path. If for example
63 /u/videos is actually a symbolic link pointing to a real video
64 directory, you can use flag -S video=/u/videos/. instead of plain
65 -S video=/u/videos that would not work with a symlink.
66
67FOR WINDOWS/CYGWIN USERS
68
69 Cygwin uses peculiar file mapping. Ordinary drive letters are not
70 used, but instead drives are mapped to unix like pathnames. C:
71 becomes /cygdrive/c and D: becomes /cygdrive/c and so on. For
72 example the path C:\DATA\MEDIA\VIDEO is /cygdrive/c/DATA/MEDIA/VIDEO
73 (I'm sure that you can figure it out).
74
75 It's also a known issue that in some Windows systems you have to use
76 -l flag with the external ip-address of your Windows box in order to
77 access it from the outside of your Windows box.
78