Difference between revisions of "OS4X Core installation"
(New page: == TAR Package == Unpack the provided tar archive file for your platform. You get the following directory structure: dist |-- apache | `-- images | `-- sounds |-- etc |...) |
|||
| Line 39: | Line 39: | ||
=== incoming === | === incoming === | ||
Incoming files which get successfully transfered by os4xrd get placed here. This should be an own filesystem. It must also be on the same filesystem as the directory „tmp“ (see below). The user running the OS4X processes must have read, write and execute permissions on that directory. For easy administration, set permissions to 777 (a+rwx). | Incoming files which get successfully transfered by os4xrd get placed here. This should be an own filesystem. It must also be on the same filesystem as the directory „tmp“ (see below). The user running the OS4X processes must have read, write and execute permissions on that directory. For easy administration, set permissions to 777 (a+rwx). | ||
| + | |||
| + | === outgoing === | ||
| + | For availability reasons, we suggest to use an own filesystem for outgoing files. The send queue daemon can send every file available on the system. | ||
| + | |||
| + | === rrd === | ||
| + | Statistical files (like RRDtool database files) are stored in this directory. Per partner about 320kB of data is needed. | ||
| + | |||
| + | === scripts === | ||
| + | Event scripts are stored in this directory by default. These scripts are called whenever a session is started or ended, files start to transfer or the end of transfer is reached. | ||
| + | |||
| + | === tmp === | ||
| + | Temporary files like files during the receiving process are stored in this directory. After successful transfer they are moved into the incoming directory. Keep in mind to set the size to the maximum file size you can receive because these files will be temporarily stored into this directory. | ||
| + | This directory must be on the same filesystem as <code>[[OS4X Core installation#incoming|incoming]]</code>, otherwise the moving process cannot be done. The user running the OS4X processes must have read, write and execute permissions on that directory. For easy administration, set permissions to 777 (a+rwx). | ||
| + | |||
| + | == Notes about upgrades == | ||
| + | If you upgrade from an older OS4X version, you will see that the names of the binaries have changed. Some new binaries are new, others (like „os4xeq“) have a new name („os4xeq2“). A symbolic link is created to support the complete web interface for the older and the newer OS4X version. The web interface calls all binaries without the appendix „2“, so without the links (i.e. „os4xeq“ -> „os4xeq2“, „os4xsqd“ -> „os4xsqd2“ and so on), the web interface will display errors. | ||
Revision as of 14:12, 9 April 2007
TAR Package
Unpack the provided tar archive file for your platform. You get the following directory structure:
dist |-- apache | `-- images | `-- sounds |-- etc |-- opt | `-- os4x | |-- backup | |-- bin | |-- cert | |-- incoming | |-- outgoing | |-- rrd | |-- scripts | `-- tmp `-- sql
Filesystem directories
The created directory structure under "/opt" shows a suggestion for a standard installation. All directories will get defined via web interface, so keep in mind that the names can change. An explanation for each directory is as follows:
backup
In this directory, backup files of the MySQL database can be stored. The scripts os4xbackup and os4xrestore use this directory.
bin
The binaries of the installation are stored here. The directory must at least contain the following binaries:
- os4xeq2 – program to enqueue files into the send queue
- os4xped2 – program to edit partner entries in the database
- os4xrd2 – the receiving daemon
- os4xsqd2 – the send queue daemon
cert
Global certificates, needed for resolving certificate chain resolution, are stored in this directory.
incoming
Incoming files which get successfully transfered by os4xrd get placed here. This should be an own filesystem. It must also be on the same filesystem as the directory „tmp“ (see below). The user running the OS4X processes must have read, write and execute permissions on that directory. For easy administration, set permissions to 777 (a+rwx).
outgoing
For availability reasons, we suggest to use an own filesystem for outgoing files. The send queue daemon can send every file available on the system.
rrd
Statistical files (like RRDtool database files) are stored in this directory. Per partner about 320kB of data is needed.
scripts
Event scripts are stored in this directory by default. These scripts are called whenever a session is started or ended, files start to transfer or the end of transfer is reached.
tmp
Temporary files like files during the receiving process are stored in this directory. After successful transfer they are moved into the incoming directory. Keep in mind to set the size to the maximum file size you can receive because these files will be temporarily stored into this directory.
This directory must be on the same filesystem as incoming, otherwise the moving process cannot be done. The user running the OS4X processes must have read, write and execute permissions on that directory. For easy administration, set permissions to 777 (a+rwx).
Notes about upgrades
If you upgrade from an older OS4X version, you will see that the names of the binaries have changed. Some new binaries are new, others (like „os4xeq“) have a new name („os4xeq2“). A symbolic link is created to support the complete web interface for the older and the newer OS4X version. The web interface calls all binaries without the appendix „2“, so without the links (i.e. „os4xeq“ -> „os4xeq2“, „os4xsqd“ -> „os4xsqd2“ and so on), the web interface will display errors.