From f555f0effca332660f0cea3c2e8724dea70e6b57 Mon Sep 17 00:00:00 2001
From: LX3JL <jeanluc@MBPdeJeanLuc3.fritz.box>
Date: Mon, 4 Jan 2016 12:49:30 +0100
Subject: [PATCH] readme

added read file
---
 readme | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 readme

diff --git a/readme b/readme
new file mode 100644
index 0000000..acfd711
--- /dev/null
+++ b/readme
@@ -0,0 +1,87 @@
+1. Copyright:
+
+© 2016 Luc Engelmann LX1IQ
+
+The XLX Multiprotocol Gateway Reflector Server is part of the software system
+for the D-Star Network.
+The sources are published under GPL Licenses.
+
+2. Usage:
+
+The packages which are described in this document are designed to install server
+software which is used for the D-Star network infrastructure.
+It requires a 24/7 internet connection which can support 20 voice streams or more
+to connect repeaters and hotspot dongles!!
+
+- The server requires a fix IP-address !
+- The public IP address should have a DNS record which must be published in the
+common host files.
+
+If you want to run this software please make sure that you can provide this
+service free of charge, like the developer team provides the software and the
+network infrastructure free of charge!
+
+3. Requirements:
+
+The software packages for Linux are tested on Debian7 (Wheezy) 32 and 64bit or newer.
+Raspbian will work but is not recommended.
+Please use the stable version listed above, we cannot support others.
+
+4. Installation:
+
+Debian 7 (Wheezy) 32 and 64bit:
+
+// after a clean installation of debian make sure to run update and upgrade
+# apt-get update
+# apt-get upgrade
+
+// install git
+# apt-get install git git-core
+
+// install webserver with PHP5 support
+# apt-get install apache2 php5
+
+//install g++ compiler
+ # apt-get install build-essential
+
+//download and compile the XLX sources
+# git clone https://github.com/LX3JL/xlxd.git
+# cd xlxd/src/
+# make
+# make clean
+# make install
+
+// copy startup script “xlxd” to /etc/init.d
+# cp ~/xlxd/scripts/xlxd /etc/init.d/xlxd
+
+// adapt the default startup parameters to your needs
+# pico /etc/init.d/xlxd
+
+// Last step is to declare the service for automatic startup and shutdown
+# service xlxd start
+# service xlxd status
+# update-rc.d xlxd defaults
+
+// start or stop the service with:
+# service xlxd start
+# service xlxd stop
+
+// copy dashboard to /var/www
+# cp -r ~/xlxd/dashboard /var/www/db
+
+// reboot server to see if the auto-start is working
+# reboot
+
+
+5. Firewall settings:
+
+XLX Server requires the following ports to be open and forwarded properly for in- and outgoing network traffic:
+ TCP port 80        (http) optional TCP port 443 (https)
+ TCP port 8080      (RepNet)
+ UDP port 10001     (json interface XLX Core)
+ TCP port 22        (ssh) optional  TCP port 10022
+ UDP port 30001     (DExtra protocol)
+ UPD port 20001     (DPlus protocol)
+ UDP port 30051     (DCS protocol)
+
+© 2016 Luc Engelmann LX1IQ