summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--INSTALL5
-rw-r--r--README22
2 files changed, 18 insertions, 9 deletions
diff --git a/INSTALL b/INSTALL
index 2749b34..d00a3d9 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,7 +1,7 @@
1Installation Instructions 1Installation Instructions
2------------------------- 2-------------------------
3 3
4Refer to README for a basic information about the differents BEINC components 4Refer to README for a basic information about the different BEINC components
5and their software requirements! 5and their software requirements!
6 6
7 7
@@ -9,7 +9,6 @@ Installing the dependencies
9~~~~~~~~~~~~~~~~~~~~~~~~~~~ 9~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 10
11 11
12
13Gentoo GNU/Linux 2013, 2014 12Gentoo GNU/Linux 2013, 2014
14.......................... 13..........................
15 14
@@ -72,7 +71,7 @@ Create a configuration file based on beinc_config_sample.json, defining your ins
72Start the BEINC server: 71Start the BEINC server:
73$ ./beinc_server.py -H 10.0.0.44 -p 9678 72$ ./beinc_server.py -H 10.0.0.44 -p 9678
74The example loads the server listening on 10.0.0.44, port 9678 using the default 73The example loads the server listening on 10.0.0.44, port 9678 using the default
75~/.beinc_server.json as a configuration file 74~/.beinc_server.json as a configuration file and usually gives you the cherrypy console
76 75
77beinc_poller.py: 76beinc_poller.py:
78$ ./beinc_poller.py -h 77$ ./beinc_poller.py -h
diff --git a/README b/README
index 4115d7d..10c99e9 100644
--- a/README
+++ b/README
@@ -1,8 +1,6 @@
1Copyright (C) 2014 - Simeon Simeonov 1Copyright (C) 2014 - Simeon Simeonov
2See the end of the file for license conditions. 2See the end of the file for license conditions.
3 3
4The file INSTALL in this very same directory describes how to setup & use BEINC
5
6 4
7What is BEINC? 5What is BEINC?
8-------------- 6--------------
@@ -22,6 +20,7 @@ beinc_generic_client.py - a simple client used to push notification messages
22 Its main purpose is to provide a convenient way to 20 Its main purpose is to provide a convenient way to
23 test beinc_server.py (and beinc_poller.py) as well as 21 test beinc_server.py (and beinc_poller.py) as well as
24 to serve as an example on how to develop BEINC-clients 22 to serve as an example on how to develop BEINC-clients
23+ documentation and a sample configuration file (beinc_config_sample.json)
25 24
26 25
27Why should I use BEINC and what has it done for me lately? 26Why should I use BEINC and what has it done for me lately?
@@ -69,10 +68,21 @@ Solution:
69 beinc_poller.py should be able to access the server running beinc_server.py 68 beinc_poller.py should be able to access the server running beinc_server.py
70 Polling interval of 5 seconds should be enough for most users. 69 Polling interval of 5 seconds should be enough for most users.
71 70
72Read beinc_config_sample.json.readme for details on how to setup beinc_server.py 71Read beinc_config_sample.json.readme for details on how to setup
73and beinc_weechat.py! 72beinc_server.py and beinc_weechat.py!
74Use "-h" command line parameter in order to display the available options for 73Use "-h" command line parameter to display the available options for
75beinc_poller.py and beinc_generic_client.py 74beinc_poller.py and beinc_generic_client.py
75Each configured beinc_server.py instance has an unique name.
76There are 2 operations that can be done on an instance:
77 - push - a client is sending a notification to the BEINC server.
78 A push is available for all instances.
79 - pull - a poller (f.i. beinc_poller.py) is fetching data from the instance-queue.
80 A pull is available only for instances defined for queueing.
81 (read beinc_config_sample.json.readme for details!)
82Example:
83If you defined a beinc_server.py instance with SSL-support called "beinc_test",
84your URL for pushing will be: https://hostname:port/push/beinc_test
85and for polling: https://hostname:port/pull/beinc_test
76 86
77 87
78Supported systems & requirements 88Supported systems & requirements
@@ -91,7 +101,7 @@ beinc_weechat.py: Weechat >= 0.4.0
91beinc_poller.py: pynotify >= 0.1 (optional), pyosd >= 0.2 (optional) 101beinc_poller.py: pynotify >= 0.1 (optional), pyosd >= 0.2 (optional)
92beinc_generic_client.py: No additional software required 102beinc_generic_client.py: No additional software required
93 103
94Read INSTALL for more details about installing the requirements! 104Read INSTALL in this very same folder for more details about installing the requirements!
95 105
96 106
97License 107License