added docs for basedirectory and logging

This commit is contained in:
Sebastian Sdorra
2020-04-25 17:27:48 +02:00
parent dbca56ce6b
commit 28d813c12d
3 changed files with 78 additions and 0 deletions

32
docs/v2/logging.md Normal file
View File

@@ -0,0 +1,32 @@
# Logging
SCM-Manager logs information which can be useful, if the system not behave as expected.
The logging behavior depends on your operating system and installation.
| Type of Installation | Logging |
|----------------------|---------|
| Docker | Stdout |
| RPM | /var/log/scm |
| DEB | /var/log/scm |
| Unix | $BASEDIR/logs |
| Mac OS X | ~/Library/Logs/SCM-Manager |
| Windows | $BASEDIR\SCM-Manager |
The location of the **$BASEDIR** can be found [here](basedirectory).
## Configuration
The logging behaviour of SCM-Manager can be configured via a xml find.
The syntax and properties can be found [here](http://logback.qos.ch/manual/configuration.html).
The location of the file depends also on the type of installation.
| Type of Installation | Path |
|----------------------|---------|
| Docker | /opt/scm-server/conf/logging.xml |
| RPM | /etc/scm/logging.xml |
| DEB | /etc/scm/logging.xml |
| Unix | $EXTRACT_PATH/scm-server/conf/logging.xml |
| Mac OS X | $EXTRACT_PATH/scm-server/conf/logging.xml |
| Windows | $EXTRACT_PATH/scm-server/conf/logging.xml |
**$EXTRACT_PATH** is the path were you etract the content of the package.