From 15a18c265e4c983ce330d9500d2993ece023dedb Mon Sep 17 00:00:00 2001 From: Florian Scholdei Date: Wed, 1 Apr 2020 08:38:13 +0200 Subject: [PATCH] Add getting-stated guide for v2 --- docs/Home.md | 2 +- docs/getting-started.md | 10 +++----- docs/v2/getting-started.md | 47 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 8 deletions(-) create mode 100644 docs/v2/getting-started.md diff --git a/docs/Home.md b/docs/Home.md index 05c1fca3ac..c85a89c971 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -82,8 +82,8 @@ repositories over http. ### SCM Manager 2 +- [Getting started](v2/getting-started.md) - [Configuration for Intellij IDEA](v2/intellij-idea-configuration.md) -- [State of SCM-Manager 2 development](v2/state-of-development.md) - [SCM v2 Test Cases](v2/test-cases.md) - [Table of decisions made during development](v2/decision-table.md) - [Definition of done](definition-of-done.md) diff --git a/docs/getting-started.md b/docs/getting-started.md index e96f161fee..623070f5b9 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,18 +2,14 @@ ### Install Java -SCM-Manager needs an installed Java 1.7 or newer. It is recommended to -use the [oracle jre](http://java.oracle.com/). How to check -which version of Java is installed: +SCM-Manager needs an installed Java 1.7 or newer. It is recommended to use the [oracle jre](http://java.oracle.com/). +How to check which version of Java is installed: ```bash java -version ``` -### Install the latest version of Java - -Download java from [here](http://java.oracle.com/) and follow -the install instructions. +Download java from [here](http://java.oracle.com/) and follow the install instructions. ### Install SCM-Manager diff --git a/docs/v2/getting-started.md b/docs/v2/getting-started.md new file mode 100644 index 0000000000..1c2135dc45 --- /dev/null +++ b/docs/v2/getting-started.md @@ -0,0 +1,47 @@ +# Getting started + +### Install Java + +SCM-Manager needs an installed Java 1.8 or newer. It is recommended to use the [oracle jre](http://java.oracle.com/). +How to check which version of Java is installed: + +```bash +java -version +``` + +Download java from [here](http://java.oracle.com/) and follow the install instructions. + +### Install SCM-Manager + +#### Standalone Server + +Download the latest version of SCM-Manager from +[Nexus](https://maven.scm-manager.org/nexus/#nexus-search;gav~sonia.scm~scm-server~2.*~~), +extract the downloaded .zip or .tar.gz archive and start SCM-Manager 2 with + +```bash +scm-server/bin/scm-server +``` + +or + +```bash +scm-server\bin\scm-server.bat +``` + +#### Docker + +To start SCM-Manager with a persistent volume on port 8080 run the following command: + +```bash +docker run -p 8080:8080 -v scm-home:/var/lib/scm --name scm scmmanager/scm-manager:2.0.0-latest +``` + +### First access + +Your SCM-Manager should be running on port 8080. You can access it locally via . + +| | | +| ------------ | ----------------------- | +| **Username** | scmadmin | +| **Password** | scmadmin |