diff --git a/docs/en/installation/index.md b/docs/en/installation/index.md index e72a9ce42b..7bded0b811 100644 --- a/docs/en/installation/index.md +++ b/docs/en/installation/index.md @@ -6,8 +6,8 @@ partiallyActive: true * [Debian/Ubuntu](debian/) * [Red Hat/CentOS/Fedora](redhat/) -* [Linux General](linux/) -* [Docker](docker/) -* [Helm/Kubernetes](helm/) * [Windows](windows/) * Mac OS X +* [Unix General](unix/) +* [Docker](docker/) +* [Helm/Kubernetes](helm/) diff --git a/docs/en/installation/linux.md b/docs/en/installation/linux.md deleted file mode 100644 index d1cd4a93a8..0000000000 --- a/docs/en/installation/linux.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Linux -subtitle: General linux installation -displayToc: true ---- -## Requirements - -Ensure that Java JRE is installed at least in version 8. -Recommended is Java 11. - -If you want to use [Mercurial](https://www.mercurial-scm.org/), ensure it is installed on your machine. - -## Installation - -Download [scm-server-2.0.0-rc8-app.tar.gz](https://packages.scm-manager.org/repository/releases/content/sonia/scm/scm-server/2.0.0-rc8/scm-server-2.0.0-rc8-app.tar.gz) -and verify the checksum (sha1: 8bf465525d5a8c5907d1f74096af1783bc0b2fa7). - -```bash -wget https://packages.scm-manager.org/repository/releases/content/sonia/scm/scm-server/2.0.0-rc8/scm-server-2.0.0-rc8-app.tar.gz -echo "8bf465525d5a8c5907d1f74096af1783bc0b2fa7 *scm-server-2.0.0-rc8-app.tar.gz" | sha1sum -c - -``` - -Extract the archive: - -```bash -tar xvfz scm-server-2.0.0-rc8-app.tar.gz -C /opt -``` - -## Start - -The application can be started by using the scm-server script. - -```bash -/opt/scm-server/bin/scm-server -``` - -## Daemonize - -To start the application in background, we can use the `start` parameter. - -```bash -/opt/scm-server/bin/scm-server start -``` diff --git a/docs/en/installation/unix.md b/docs/en/installation/unix.md new file mode 100644 index 0000000000..de94aa988f --- /dev/null +++ b/docs/en/installation/unix.md @@ -0,0 +1,61 @@ +--- +title: Unix +subtitle: General unix installation +displayToc: true +--- + +## Requirements + +Ensure that Java JRE is installed at least in version 8, we recommend currently Java 11. +If you want to use [Mercurial](https://www.mercurial-scm.org/), ensure it is installed on your machine. + +## Installation + +Grab the latest version and checksum from [download page](/download) and replace `` and `` in the code blocks below. +Download and verify the checksum. + +```bash +wget https://packages.scm-manager.org/repository/public/sonia/scm/scm-packaging/unix//unix--app.tar.gz +wget https://packages.scm-manager.org/repository/releases/content/sonia/scm/scm-server/2.0.0-rc8/scm-server-2.0.0-rc8-app.tar.gz +echo " *unix--app.tar.gz" | sha1sum -c - +``` + +Extract the archive: + +```bash +tar xvfz unix--app.tar.gz -C /opt +``` + +The application can be started by using the scm-server script. + +```bash +/opt/scm-server/bin/scm-server +``` + +if you want to start the application in background, we can use the `start` parameter. + +```bash +/opt/scm-server/bin/scm-server start +``` + +After the scm-manager is started, it should be reachable on port 8080 +The default username is `scmadmin` with the password `scmadmin`. + +## Troubleshooting + +If SCM-Manager does not start have a look at the logs `/opt/scm-server/logs` or `~/.scm/logs` + +## Home directory + +SCM-Manager stores all its information in its home directory. +The directory is located in the home directory of the user, which has started the process, and is named `.scm`. + +## 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 `/opt/scm-server/bin/scm-server`. +To configure logging and the webserver, `/opt/scm-server/conf` is the right place. diff --git a/docs/en/installation/windows.md b/docs/en/installation/windows.md index b98c379c63..b261d3566b 100644 --- a/docs/en/installation/windows.md +++ b/docs/en/installation/windows.md @@ -36,6 +36,7 @@ scm-server.exe start ``` SCM-Manager is now starting and after a few seconds it should be reachable on port 8080. +The default username is `scmadmin` with the password `scmadmin`. ## Troubleshooting