diff options
| author | Simeon Simeonov | 2015-04-18 21:12:03 +0200 |
|---|---|---|
| committer | Simeon Simeonov | 2015-04-18 21:12:03 +0200 |
| commit | 34846014399f8756962051df02d251b91b65bb0c (patch) | |
| tree | c3659df8e9ab10713d40cb17343bfa9f2e8d37d9 /INSTALL | |
| parent | 5d19e4e05f8fcd44e6a596f5e919fb91e45e54b7 (diff) | |
Update documentation changelog and examples. Final touches
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 17 |
1 files changed, 9 insertions, 8 deletions
| @@ -9,16 +9,16 @@ Installing the dependencies | |||
| 9 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 9 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 | 10 | ||
| 11 | 11 | ||
| 12 | Gentoo GNU/Linux 2013, 2014 | 12 | Gentoo GNU/Linux 2014, 2015 |
| 13 | .......................... | 13 | .......................... |
| 14 | 14 | ||
| 15 | # emerge -va dev-python/pyopenssl dev-python/cherrypy dev-python/notify-python dev-python/pyosd | 15 | # emerge -va dev-python/pyopenssl dev-python/twisted-web dev-python/notify-python dev-python/pyosd |
| 16 | 16 | ||
| 17 | 17 | ||
| 18 | Ubuntu GNU/Linux | 18 | Ubuntu GNU/Linux |
| 19 | ................ | 19 | ................ |
| 20 | 20 | ||
| 21 | # apt-get install python-openssl python-cherrypy python-notify2 python-pyosd | 21 | # apt-get install python-openssl python-twisted-web python-notify2 python-pyosd |
| 22 | 22 | ||
| 23 | 23 | ||
| 24 | FreeBSD 9, 10 | 24 | FreeBSD 9, 10 |
| @@ -27,7 +27,7 @@ FreeBSD 9, 10 | |||
| 27 | # cd /usr/ports/security/py-openssl | 27 | # cd /usr/ports/security/py-openssl |
| 28 | # make install clean | 28 | # make install clean |
| 29 | 29 | ||
| 30 | # cd /usr/ports/www/py-cherrypy | 30 | # cd /usr/ports/www/py-twistedWeb |
| 31 | # make install clean | 31 | # make install clean |
| 32 | 32 | ||
| 33 | # cd /usr/ports/devel/py-notify | 33 | # cd /usr/ports/devel/py-notify |
| @@ -45,7 +45,7 @@ This is where virtualenv may become handy (provided that it has been installed): | |||
| 45 | $ virtualenv beinc_installation | 45 | $ virtualenv beinc_installation |
| 46 | $ cd beinc_installation | 46 | $ cd beinc_installation |
| 47 | $ source bin/activate | 47 | $ source bin/activate |
| 48 | $ pip install cherrypy | 48 | $ pip install Twisted |
| 49 | $ pip install pyopenssl | 49 | $ pip install pyopenssl |
| 50 | $ cd beinc-<version> | 50 | $ cd beinc-<version> |
| 51 | $ ./beinc_server.py -h | 51 | $ ./beinc_server.py -h |
| @@ -71,13 +71,14 @@ Create a configuration file based on beinc_config_sample.json, defining your ins | |||
| 71 | Start the BEINC server: | 71 | Start the BEINC server: |
| 72 | $ ./beinc_server.py -H 10.0.0.44 -p 9678 | 72 | $ ./beinc_server.py -H 10.0.0.44 -p 9678 |
| 73 | The example loads the server listening on 10.0.0.44, port 9678 using the default | 73 | The example loads the server listening on 10.0.0.44, port 9678 using the default |
| 74 | ~/.beinc_server.json as a configuration file and usually gives you the cherrypy console | 74 | ~/.beinc_server.json as a configuration file and usually gives you the Twisted |
| 75 | log console | ||
| 75 | 76 | ||
| 76 | beinc_poller.py: | 77 | beinc_poller.py: |
| 77 | $ ./beinc_poller.py -h | 78 | $ ./beinc_poller.py -h |
| 78 | The example lists all available command options | 79 | The example lists all available command options |
| 79 | $ ./beinc_poller.py -t 10 -f 7 --cert-file /home/sgs/weechat_cert.crt \ | 80 | $ ./beinc_poller.py -n weechat -t 10 -f 7 --cert-file /home/sgs/weechat_cert.crt \ |
| 80 | -P /home/sgs/.weechat_beinc_passwd https://10.0.0.44:9678/pull/weechat | 81 | -p /home/sgs/.weechat_beinc_passwd https://10.0.0.44:9678 |
| 81 | Starts polling from the instance (target) defined above, | 82 | Starts polling from the instance (target) defined above, |
| 82 | defining an OSD timeout of 10 seconds, polling frequency of 7 seconds, | 83 | defining an OSD timeout of 10 seconds, polling frequency of 7 seconds, |
| 83 | checking whether the server's SSL certificate was signed (issued) by /home/sgs/weechat_cert.crt, | 84 | checking whether the server's SSL certificate was signed (issued) by /home/sgs/weechat_cert.crt, |
