link to my blog post

[auerswald-callnotifier.git] / README.rst

diff --git a/README.rst b/README.rst
index daf94e24b085105f8a30b8a2eedf82527b52862c..f64ab3a65ee550b488f4ffb68b40fac3a47018b1 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -12,11 +12,66 @@ incoming and/or outgoing calls into a file or a database.
 Callnotifier is able to resolve the names of calls via LDAP and the
 caller location city names via OpenGeoDb.
 
 Callnotifier is able to resolve the names of calls via LDAP and the
 caller location city names via OpenGeoDb.
 

+Blog post: https://cweiske.de/tagebuch/auerswald-callnotifier.htm
+

 .. contents::
 
 .. contents::
 

+
+============
+Installation
+============
+
+1. Clone the git repository
+2. Install dependencies
+3. Configure the tool
+4. Run ``./callnotifier.php``
+
+
+Dependencies
+============
+- PEAR's Console_CommandLine package
+- PEAR's Net_LDAP2 package for LDAP name resolution
+- curl for the dreambox notifier
+
+
+Systemd service
+===============
+
+1. Copy ``scripts/systemd/auerswald-callnotifier.service`` to ``/etc/systemd/system/``
+2. Adjust user and group name and callnotifier path
+3. Enable the service::
+
+    $ systemctl daemon-reload
+    $ systemctl enable auerswald-callnotifier
+    $ systemctl start auerswald-callnotifier
+    $ systemctl status auerswald-callnotifier
+
+

 =============
 Configuration
 =============
 =============
 Configuration
 =============

+
+Compact 3000
+============
+Enable the debug port by activating
+
+- Configuration
+
+  - Server configuration
+
+    -  D channel output via IP D channel output via IP on/off
+
+German:
+
+- Einrichtung
+
+  - Serverkonfiguration
+
+    - D-Kanal über IP ausgeben D-Kanal über IP ausgeben ein-/ausschalten
+
+
+Callnotifier
+============

 Copy ``data/callnotifier.config.php.dist`` to ``data/callnotifier.config.php``
 (same name, just no ``.dist``), open it in a text editor and adjust it to
 your needs.
 Copy ``data/callnotifier.config.php.dist`` to ``data/callnotifier.config.php``
 (same name, just no ``.dist``), open it in a text editor and adjust it to
 your needs.


@@ -104,10 +159,29 @@ Example configuration::
     );
 
 
     );
 
 

-====
-TODO
-====
-- multiple notification methods: XMPP, dreambox, notify-send
+Logger
+======
+Logger handle react on events like incoming or outgoing calls,
+if they start or finish, or on any data received from the ISDN bus.
+
+Available logger:
+
+CallDb
+  Log calls in a SQL database
+CallDreambox
+  Send messages on incoming calls to the DreamBox satellite
+  receiver
+CallEcho
+  Log to the command line. Helpful for debugging.
+CallFile
+  Log finished calls into a text file
+CallFileTop
+  Log finished calls into a text file, newest on top
+CallNotifySend
+  Use the unix ``notify-send`` command on starting and finished calls
+CallSendXmpp
+  Send an XMPP headline message for incoming calls to one or multiple
+  users.

 
 
 ============
 
 
 ============


@@ -118,9 +192,15 @@ This is a problem with PHP since pcntl_signal handling and blocking sockets
 do not work together. The signal will not be handled.
 
 
 do not work together. The signal will not be handled.
 
 

+=======
+License
+=======
+Auerswald callnotifier is licensed under the terms of the GPLv3 or later.
+
+

 ======
 Source
 ======
 ======
 Source
 ======

-Original git website: http://git.cweiske.de/?p=auerswald-callnotifier.git
+Original git website: https://git.cweiske.de/auerswald-callnotifier.git

 
 Mirror: https://github.com/cweiske/auerswald-callnotifier
 
 Mirror: https://github.com/cweiske/auerswald-callnotifier