diff --git a/docs/en/installation/index.md b/docs/en/installation/index.md index 90c07799f6..6ef0c8cb4c 100644 --- a/docs/en/installation/index.md +++ b/docs/en/installation/index.md @@ -7,7 +7,7 @@ partiallyActive: true * [Debian/Ubuntu](debian/) * [Red Hat/CentOS/Fedora](redhat/) * [Windows](windows/) -* Mac OS X +* [Mac OS X](osx/) * [Unix General](unix/) * [Docker](docker/) * [Kubernetes](k8s/) diff --git a/docs/en/installation/osx.md b/docs/en/installation/osx.md new file mode 100644 index 0000000000..a4fbbf1485 --- /dev/null +++ b/docs/en/installation/osx.md @@ -0,0 +1,64 @@ +--- +title: Mac OS X +subtitle: SCM-Manager installation on OS X using homebrew +displayToc: true +--- + +To install SCM-Manager on OS X we offer a [Homebrew](https://brew.sh/) tap. + +## Quickstart + +```bash +brew install scm-manager/tap/scm-server +brew services start scm-manager/tap/scm-server +``` + +After a few seconds SCM-Manager should be started on port 8080. +The default username is `scmadmin` with the password `scmadmin`. + +## Detailed installation + +To install SCM-Manager with homebrew we had to add the SCM-Manager tap: + +```bash +brew tap scm-manager/tap +``` + +After the tap was added, we can install SCM-Manager: + +```bash +brew install scm-server +``` + +Now SCM-Manager can be started: + +```bash +scm-server +``` + +If you want to start it in the background as OSX service: + +```bash +brew services start scm-manager/tap/scm-server +``` + +After a few seconds SCM-Manager should be started on port 8080. +The default username is `scmadmin` with the password `scmadmin`. + +## Troubleshooting + +If the service does not start have a look at the logs `~/Library/Logs`. + +## Home directory + +SCM-Manager stores all its information in its home directory at `~/Library/Application\ Support/SCM-Manager`. + +## Configuration + +Most of the configuration of scm-manager can be configured via the web interface. +But the startup and the web server configuration must be configured via configuration files. +The default configuration of the debian package should match 90% of the use cases, +if you have to change something ensure you know what you are doing. + +To configure the startup have a look at `/usr/local/opt/scm-server/libexec/bin/scm-server`. +To configure logging and the webserver, `//usr/local/opt/scm-server/libexec/conf` is the right place.