diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 34 |
1 files changed, 17 insertions, 17 deletions
| @@ -1,38 +1,38 @@ | |||
| 1 | ## Installation Instructions | 1 | # Installation Instructions |
| 2 | 2 | ||
| 3 | Refer to README for a basic information about the different BEINC components | 3 | Refer to README for a basic information about the different BEINC components |
| 4 | and their software requirements! | 4 | and their software requirements! |
| 5 | 5 | ||
| 6 | 6 | ||
| 7 | ### Installing the dependencies | 7 | ## Installing the dependencies |
| 8 | 8 | ||
| 9 | #### Gentoo GNU/Linux 2014, 2015 | 9 | ### Gentoo GNU/Linux |
| 10 | 10 | ||
| 11 | # emerge -va dev-python/pyopenssl dev-python/notify-python | 11 | ```bash |
| 12 | emerge -va dev-python/notify2 | ||
| 13 | ``` | ||
| 12 | 14 | ||
| 13 | 15 | ||
| 14 | #### Ubuntu GNU/Linux | 16 | ### Ubuntu GNU/Linux |
| 15 | 17 | ||
| 16 | # apt-get install python-openssl python-notify2 | 18 | ```bash |
| 19 | apt-get install python-notify2 | ||
| 20 | ``` | ||
| 17 | 21 | ||
| 18 | 22 | ||
| 19 | #### FreeBSD 10, 11 | 23 | ### FreeBSD 12 |
| 20 | |||
| 21 | # cd /usr/ports/security/py-openssl | ||
| 22 | # make install clean | ||
| 23 | 24 | ||
| 24 | # cd /usr/ports/devel/py-notify | 25 | # cd /usr/ports/devel/py-notify |
| 25 | # make install clean | 26 | # make install clean |
| 26 | 27 | ||
| 27 | 28 | ||
| 28 | #### Intallation using virtualenv and pip | 29 | ### Intallation using virtualenv and pip |
| 29 | 30 | ||
| 30 | Very often you are not the administrator of the server hosting your BEINC server | 31 | Very often you are not the administrator of the server hosting your BEINC server |
| 31 | This is where virtualenv may become handy (provided that it has been installed): | 32 | This is where virtualenv may become handy (provided that it has been installed): |
| 32 | $ virtualenv beinc_installation | 33 | $ virtualenv beinc_installation |
| 33 | $ cd beinc_installation | 34 | $ cd beinc_installation |
| 34 | $ source bin/activate | 35 | $ source bin/activate |
| 35 | $ pip install pyopenssl | ||
| 36 | $ cd beinc-<version> | 36 | $ cd beinc-<version> |
| 37 | $ ./beinc_server.py -h | 37 | $ ./beinc_server.py -h |
| 38 | 38 | ||
| @@ -59,13 +59,13 @@ The example loads the server listening on 10.0.0.44, port 9678 using the default | |||
| 59 | ~/.beinc_server.json as a configuration file and usually gives you the Twisted | 59 | ~/.beinc_server.json as a configuration file and usually gives you the Twisted |
| 60 | log console | 60 | log console |
| 61 | 61 | ||
| 62 | beinc_poller.py: | 62 | beinc_pull.py: |
| 63 | $ ./beinc_poller.py -h | 63 | $ ./beinc_pull.py -h |
| 64 | The example lists all available command options | 64 | The example lists all available command options |
| 65 | $ ./beinc_poller.py -n weechat -t 10 -f 7 --cert-file /home/sgs/weechat_cert.crt \ | 65 | $ ./beinc_pull.py -n weechat -t 10 -f 7 --cert-file /home/sgs/weechat_cert.crt \ |
| 66 | -p /home/sgs/.weechat_beinc_passwd https://10.0.0.44:9678 | 66 | -p /home/sgs/.weechat_beinc_passwd https://10.0.0.44:9678 |
| 67 | Starts polling from the instance (target) defined above, | 67 | Starts pulling from the instance (target) defined above, |
| 68 | defining an OSD timeout of 10 seconds, polling frequency of 7 seconds, | 68 | defining an OSD timeout of 10 seconds, pulling frequency of 7 seconds, |
| 69 | checking whether the server's SSL certificate was signed (issued) by /home/sgs/weechat_cert.crt, | 69 | checking whether the server's SSL certificate was signed (issued) by /home/sgs/weechat_cert.crt, |
| 70 | extracting the target's password from /home/sgs/.weechat_beinc_passwd | 70 | extracting the target's password from /home/sgs/.weechat_beinc_passwd |
| 71 | 71 | ||
