Local configuration file template added, config-local.php will be ignored

[hub.git] / application / hub / config-local.php-dist

diff --git a/application/hub/config-local.php-dist b/application/hub/config-local.php-dist
new file mode 100644 (file)
index 0000000..4cbdcee
--- /dev/null
+++ b/application/hub/config-local.php-dist
@@ -0,0 +1,64 @@
+<?php
+/**
+ * Local configuration entries which you can customize. Please keep the
+ * comments starting with CFG: as-is or else, the later configuration wizard
+ * (aka. 'admin' project) will not be able to parse it. You need to rename this
+ * file to config-local.php and make in that new file your changes.
+ *
+ * If you want to start an own network (which may accept different types of
+ * objects which would be rejected by the global network) please change
+ * hub_bootstrap_nodes (semicolon-seperated list) to your bootstrapper.
+ *
+ * You can set external_ip to a hostname, e.g. me.homelinux.org, which will be
+ * included in the announcement. This is very useful for consumer DSL
+ * connections because they might be disconnected every 24 hours and rotate the
+ * IP number.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+// Some hub-specific configuration like port hostname where we will listen, etc.
+$cfg = FrameworkConfiguration::getInstance();
+
+// CFG: NODE-LISTEN-ADDR
+$cfg->setConfigEntry('node_listen_addr', '0.0.0.0');
+
+// CFG: NODE-TCP-LISTEN-PORT
+$cfg->setConfigEntry('node_tcp_listen_port', 9060);
+
+// CFG: NODE-UDP-LISTEN-PORT
+$cfg->setConfigEntry('node_udp_listen_port', 9060);
+
+// CFG: BOOT-NODE-TCP-LISTEN-PORT
+$cfg->setConfigEntry('boot_node_tcp_listen_port', 9061);
+
+// CFG: BOOT-NODE-UDP-LISTEN-PORT
+$cfg->setConfigEntry('boot_node_udp_listen_port', 9061);
+
+// CFG: NODE-DEFAULT-MODE (can be 'regular', 'list', 'master' or 'boot', default is 'regular')
+$cfg->setConfigEntry('node_default_mode', 'regular');
+
+// CFG: EXTERNAL-IP
+$cfg->setConfigEntry('external_ip', '');
+
+// CFG: HUB-BOOTSTRAP-NODES
+$cfg->setConfigEntry('hub_bootstrap_nodes', '188.138.90.169:9061');
+
+// [EOF]
+?>