Revision ea61ba1b README.md

View differences:

README.md
109 109
##Compile
110 110
Once you have installed all the dependencies, just use:
111 111

  
112
	sh install.sh
112
	sh autogen.sh
113 113

  
114
to start the whole compilation process. If you're not interested in
115
Data Channels or WebSockets (or you don't care about either of them)
116
you can pass a specific compilation flag to disable them: 
114
to generate the configure file. After that, configure and compile as
115
usual to start the whole compilation process:
117 116

  
118
	sh install.sh nodatachans nowebsockets
117
	./configure --prefix=/opt/janus
118
	make
119
	make install
119 120

  
120
As the flag names suggest, 'nodatachans' disables support for Data
121
Channels, while 'nowebsockets' disables WebSockets.
121
If you're not interested in Data Channels or WebSockets (or you don't
122
care about either of them) you can disable them when configuring: 
122 123

  
123
The script will then try to check whether you have all the dependencies
124
installed, and then issue a 'make' for you to start compiling. If
125
Doxygen and graphviz are available, it will also build the documentation
126
for you as well in the docs/html subfolder. If you prefer not to build
127
the documentation (or not to build it again and again every time you
128
compile!) use the 'nodocs' option (along 'nodatachans' and
129
'nowebsockets', if needed):
124
	./configure --disable-websockets --disable-data-channels
130 125

  
131
	sh install.sh nodocs
126
If Doxygen and graphviz are available, the process will also build the
127
documentation for you. If you prefer not to build it, use the
128
--disable-docs configuration option:
129

  
130
	./configure --disable-docs
131

  
132
You can also selectively enable/disable other features (e.g., specific
133
plugins you don't care about). Use the --help option when configuring
134
for more info.
132 135

  
133 136

  
134 137
##Configure and start
135 138
To start the gateway, you can use the janus executable. There are several
136 139
things you can configure, either in a configuration file:
137 140

  
138
	./conf/janus.cfg
141
	<installdir>/etc/janus/janus.cfg
139 142

  
140 143
or on the command line:
141 144

  
142
	./janus --help
145
	<installdir>/bin/janus --help
143 146
	
144 147
	janus 0.0.5
145 148

  
......
203 206
Options passed through the command line have the precedence on those
204 207
specified in the configuration file. To start the gateway, simply run:
205 208

  
206
	./janus
209
	<installdir>/bin/janus
207 210

  
208 211
This will start the gateway, and have it look at the configuration file.
209 212
By default, only an HTTP webserver is started. To enable HTTPS support,
......
222 225
A default certificate is provided with this package in the certs folder,
223 226
which you can use launching the executable with these parameters:
224 227

  
225
	./janus -c certs/mycert.pem -k certs/mycert.key
228
	<installdir>/bin/janus -c /path/to/mycert.pem -k /path/to/mycert.key
226 229

  
227 230
At this point, the gateway will be listening on the 8088 port (or whatever
228 231
you changed that to) of your machine. To test whether it's working

Also available in: Unified diff