mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-01-04 22:59:51 +01:00
added docs for basedirectory and logging
This commit is contained in:
@@ -83,6 +83,8 @@ repositories over http.
|
||||
### SCM Manager 2
|
||||
|
||||
- [Getting started](v2/getting-started.md)
|
||||
- [Base directory](v2/basedirectory.md)
|
||||
- [Logging](v2/logging.md)
|
||||
- [Configuration for Intellij IDEA](v2/intellij-idea-configuration.md)
|
||||
- [SCM v2 Test Cases](v2/test-cases.md)
|
||||
- [Table of decisions made during development](v2/decision-table.md)
|
||||
|
||||
44
docs/v2/basedirectory.md
Normal file
44
docs/v2/basedirectory.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Base Directory
|
||||
|
||||
The SCM-Manager base directory aka. home directory,
|
||||
contains all data which is create by SCM-Manager such as repository and configurations.
|
||||
The location of the base directory depends on your operating system and type of installation.
|
||||
|
||||
| Type of Installation | Base directory |
|
||||
|----------------------|----------------|
|
||||
| Docker | /var/lib/scm |
|
||||
| RPM | /var/lib/scm |
|
||||
| DEB | /var/lib/scm |
|
||||
| Unix | ~/.scm |
|
||||
| Mac OS X | ~/Library/Application Support/SCM-Manager |
|
||||
| Windows | %APPDATA%\SCM-Manager |
|
||||
|
||||
## Change base directory location
|
||||
|
||||
The location of the base directory can be changed by using one of the following ways.
|
||||
|
||||
### Environment variable
|
||||
|
||||
By setting the environment variable **SCM_HOME** e.g.:
|
||||
|
||||
```bash
|
||||
export SCM_HOME=/home/scm
|
||||
/opt/scm-server/bin/scm-server
|
||||
```
|
||||
|
||||
For rpm and deb installations the variable can be changed via the file `/etc/default/scm-server`.
|
||||
|
||||
## System property
|
||||
|
||||
The path can be changed by setting the system property **scm.home** e.g.:
|
||||
|
||||
```bash
|
||||
-Dscm.home=/home/scm
|
||||
```
|
||||
## Properties file
|
||||
|
||||
If SCM-Manager finds a file called `scm.properties` on the class path it reads the property `scm.home` e.g.:
|
||||
|
||||
```properties
|
||||
scm.home=/home/scm
|
||||
```
|
||||
32
docs/v2/logging.md
Normal file
32
docs/v2/logging.md
Normal 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.
|
||||
Reference in New Issue
Block a user