Projects tigase _server server-core Issues #713
Improvements to admin guide - tigase deployment (#713)
wojciech.kapcia@tigase.net opened 8 years ago
Due Date
2016-09-29
  • include a section in Admin guide about Tigase service management: preparation, start/stop (basically steps to install sys-init on different distributions and how to use it)

  • include deployment recommend standards (i.e. utilizing sysinit, open iptables, use dedicated system account [and cover it's limitations, i.e. ports >1024 and how to circumvent it], point to High Load guide, etc.)

This could/should be usable in deployments wikis.

Daniel Wisnewski commented 8 years ago

Wojciech, I've added information of init.d and setup to the admin guide in associated commit. I've also updated network information in the quick start guide, everything should be covered, let me know if I'm missing anything.

wojciech.kapcia@tigase.net commented 8 years ago
Other ports you may need to forward to the server are: - 5222 - 5223 - 5269 - 5277 - 5280 - 5290 - 8080
  • include statement references wrong file?
Unresolved directive in index.asciidoc - include::text/Admin_Guide_07_-Quick_Start_G-_Script_Selection.asciidoc[]
  • Admin_Guide_07_-Quick_Start-G-_Script_Selection

    • it's not necessarily related to package system used, CentOS should be added to redhat section

    • installation - it's a bit confusing - this may look like the user should move the files to this location; in addition - this is not correct as (unfortunately) each distribution has slightly different directory structure

Once you’ve located the appropriate distribution scripts, take the tigase file in your distribution’s folder and move it to your system’s init.d folder (/scripts/$distro/init.d). 
  • it's essential to edit each script after installation and set a couple of variables, at least
TIGASE_HOME=/home/tigase/tigase-server
USERNAME=tigase
USERGROUP=tigase
NAME=tigase
JAVA_HOME=/usr/lib/jvm/java/
  • simply copying scripts is not enough! there are short descriptions in scripts for distribution, but those should be included in guide, for example for RHEL:
$ cat scripts/redhat/init.d/tigase
#!/bin/bash
### BEGIN INIT INFO
#
# tigase        This starts and stops the Tigase XMPP server.
#
# chkconfig: 345 85 15
# description: Tigase is a XMPP server.
#
# processname: tigase
# pidfile: /var/run/tigase/tigase.pid
# config: /home/tigase/tigase-server/etc/tigase.conf
#
### management instructions
##
## to install: /sbin/chkconfig --add tigase
## to check:   /sbin/chkconfig --list tigase
## to start:   /sbin/chkconfig tigase <on|off|reset>
##
### END INIT INFO
  • debina installation script - I'm not sure we should recommend using it, it references some old files with old config, which may do more harm than good:
cp -f $CURDIR/scripts/debian/init-debian.properties $ETCDIR/init.properties
cp -f $CURDIR/scripts/debian/tigase-debian.conf /etc/default/tigase
cp -f $CURDIR/scripts/debian/tigase.init.d /etc/init.d/tigase
  • formatting at the end seems to be a bit off.
Daniel Wisnewski commented 8 years ago

I've made edits to the documentation based on those recommendations, and pulled installation procedures for debian from the scripts. Let me know if anything needs pulling or more adjustment.

wojciech.kapcia@tigase.net commented 8 years ago

Thank you.

There were some warnings when generating the documentation so I've quickly fixed them and corrected some other formatting.

issue 1 of 1
Type
Bug
Priority
Normal
Assignee
RedmineID
4552
Version
tigase-server-7.1.0
Spent time
13h 45m
Issue Votes (0)
Watchers (0)
Reference
tigase/_server/server-core#713
Please wait...
Page is in error, reload to recover