merge with develop branch
45
CHANGELOG.md
@@ -4,8 +4,50 @@ All notable changes to this project will be documented in this file.
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
|
||||
## Unreleased
|
||||
### Added
|
||||
- enrich commit mentions in markdown viewer by internal links ([#1210](https://github.com/scm-manager/scm-manager/pull/1210))
|
||||
|
||||
### Changed
|
||||
- Checkboxes can now be 'indeterminate' ([#1215](https://github.com/scm-manager/scm-manager/pull/1215))
|
||||
|
||||
### Fixed
|
||||
- Fixed installation of debian packages on distros without preinstalled `at` ([#1216](https://github.com/scm-manager/scm-manager/issues/1216) and [#1217](https://github.com/scm-manager/scm-manager/pull/1217))
|
||||
- Fixed broken migration with empty security.xml ([#1219](https://github.com/scm-manager/scm-manager/issues/1219) and [#1221](https://github.com/scm-manager/scm-manager/pull/1221))
|
||||
- Mercurial on Python 3
|
||||
|
||||
## [2.1.1] - 2020-06-23
|
||||
### Fixed
|
||||
- Wait until recommended java installation is available for deb packages ([#1209](https://github.com/scm-manager/scm-manager/pull/1209))
|
||||
- Do not force java home of recommended java dependency for rpm and deb packages ([#1195](https://github.com/scm-manager/scm-manager/issues/1195) and [#1208](https://github.com/scm-manager/scm-manager/pull/1208))
|
||||
- Migration of non-bare repositories ([#1213](https://github.com/scm-manager/scm-manager/pull/1213))
|
||||
|
||||
## [2.1.0] - 2020-06-18
|
||||
### Added
|
||||
- Option to configure jvm parameter of docker container with env JAVA_OPTS or with arguments ([#1175](https://github.com/scm-manager/scm-manager/pull/1175))
|
||||
- Added links in diff views to expand the gaps between "hunks" ([#1178](https://github.com/scm-manager/scm-manager/pull/1178))
|
||||
- Show commit contributors in table on changeset details view ([#1169](https://github.com/scm-manager/scm-manager/pull/1169))
|
||||
- Show changeset parents on changeset details view ([#1189](https://github.com/scm-manager/scm-manager/pull/1189))
|
||||
- Annotate view to display commit metadata for each line of a file ([#1196](https://github.com/scm-manager/scm-manager/pull/1196))
|
||||
|
||||
### Fixed
|
||||
- Avoid caching of detected browser language ([#1176](https://github.com/scm-manager/scm-manager/pull/1176))
|
||||
- Fixes configuration of jetty listener address with system property `jetty.host` ([#1173](https://github.com/scm-manager/scm-manager/pull/1173), [#1174](https://github.com/scm-manager/scm-manager/pull/1174))
|
||||
- Fixes loading plugin bundles with context path `/` ([#1182](https://github.com/scm-manager/scm-manager/pull/1182/files), [#1181](https://github.com/scm-manager/scm-manager/issues/1181))
|
||||
- Sets the new plugin center URL once ([#1184](https://github.com/scm-manager/scm-manager/pull/1184))
|
||||
- Diffs with CR characters are parsed correctly ([#1185](https://github.com/scm-manager/scm-manager/pull/1185))
|
||||
- Close file lists in migration ([#1191](https://github.com/scm-manager/scm-manager/pull/1191))
|
||||
- Use command in javahg.py from registrar (Upgrade to newer javahg version) ([#1192](https://github.com/scm-manager/scm-manager/pull/1192))
|
||||
- Fixed wrong e-tag format ([sdorra/web-resource #1](https://github.com/sdorra/web-resources/pull/1))
|
||||
- Fixed refetching loop for non existing changesets ([#1203](https://github.com/scm-manager/scm-manager/pull/1203))
|
||||
- Fixed active state of sub navigation items, which are using activeWhenMatch ([#1199](https://github.com/scm-manager/scm-manager/pull/1199))
|
||||
- Handles repositories in custom directories correctly in migration from 1.x ([#1201](https://github.com/scm-manager/scm-manager/pull/1201))
|
||||
- Usage of short git commit ids in changeset urls ([#1200](https://github.com/scm-manager/scm-manager/pull/1200))
|
||||
- Fixes linebreaks in multiline tooltip ([#1207](https://github.com/scm-manager/scm-manager/pull/1207))
|
||||
|
||||
## [2.0.0] - 2020-06-04
|
||||
### Added
|
||||
- Detect renamed files in git and hg diffs ([#1157](https://github.com/scm-manager/scm-manager/pull/1157))
|
||||
- ClassLoader and Adapter parameters to typed store apis ([#1111](https://github.com/scm-manager/scm-manager/pull/1111))
|
||||
- Native packaging for Debian, Red Hat, Windows, Unix, Docker and Kubernetes ([#1165](https://github.com/scm-manager/scm-manager/pull/1165))
|
||||
@@ -15,7 +57,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Correctly resolve Links in markdown files ([#1152](https://github.com/scm-manager/scm-manager/pull/1152))
|
||||
- Missing copy on write in the data store ([#1155](https://github.com/scm-manager/scm-manager/pull/1155))
|
||||
- Resolved conflicting dependencies for scm-webapp ([#1159](https://github.com/scm-manager/scm-manager/pull/1159))
|
||||
- Mercurial on Python 3
|
||||
|
||||
## [2.0.0-rc8] - 2020-05-08
|
||||
### Added
|
||||
@@ -169,3 +210,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
[2.0.0-rc5]: https://github.com/scm-manager/scm-manager/releases/tag/2.0.0-rc5
|
||||
[2.0.0-rc6]: https://github.com/scm-manager/scm-manager/releases/tag/2.0.0-rc6
|
||||
[2.0.0-rc7]: https://github.com/scm-manager/scm-manager/releases/tag/2.0.0-rc7
|
||||
[2.0.0-rc8]: https://github.com/scm-manager/scm-manager/releases/tag/2.0.0-rc8
|
||||
[2.0.0]: https://github.com/scm-manager/scm-manager/releases/tag/2.0.0
|
||||
|
||||
16
Jenkinsfile
vendored
@@ -83,10 +83,6 @@ node('docker') {
|
||||
stage('SonarQube') {
|
||||
def sonarQube = new SonarCloud(this, [sonarQubeEnv: 'sonarcloud.io-scm', sonarOrganization: 'scm-manager', integrationBranch: 'develop'])
|
||||
sonarQube.analyzeWith(mvn)
|
||||
|
||||
if (!waitForQualityGateWebhookToBeCalled()) {
|
||||
currentBuild.result = 'UNSTABLE'
|
||||
}
|
||||
}
|
||||
|
||||
if (isBuildSuccessful() && (isMainBranch() || isReleaseBranch())) {
|
||||
@@ -224,18 +220,6 @@ boolean isMainBranch() {
|
||||
return mainBranch.equals(env.BRANCH_NAME)
|
||||
}
|
||||
|
||||
boolean waitForQualityGateWebhookToBeCalled() {
|
||||
boolean isQualityGateSucceeded = true
|
||||
timeout(time: 10, unit: 'MINUTES') { // Needed when there is no webhook for example
|
||||
def qGate = waitForQualityGate()
|
||||
echo "SonarQube Quality Gate status: ${qGate.status}"
|
||||
if (qGate.status != 'OK') {
|
||||
isQualityGateSucceeded = false
|
||||
}
|
||||
}
|
||||
return isQualityGateSucceeded
|
||||
}
|
||||
|
||||
void withGPGEnvironment(def closure) {
|
||||
withCredentials([
|
||||
file(credentialsId: 'oss-gpg-secring', variable: 'GPG_KEYRING'),
|
||||
|
||||
32
README.md
@@ -9,8 +9,8 @@ repositories over http.
|
||||
|
||||
- Very easy installation
|
||||
- No need to hack configuration files, SCM-Manager is completely
|
||||
configureable from its Web-Interface
|
||||
- No Apache and no database installation is required
|
||||
configurable from its Web-Interface
|
||||
- No Apache and no database installation required
|
||||
- Central user, group and permission management
|
||||
- Out of the box support for Git, Mercurial and Subversion
|
||||
- Full RESTFul Web Service API (JSON and XML)
|
||||
@@ -19,34 +19,32 @@ repositories over http.
|
||||
- Useful plugins available
|
||||
- Licensed under the MIT-License
|
||||
|
||||
This branch (default) is for the development of SCM-Manager 2.x. If you are interested in the development of version 1.x, please checkout the 1.x branch.
|
||||
This branch (`develop`) is for the development of SCM-Manager 2.x. If you are interested in the development of version
|
||||
1.x, please checkout the branch `support/1.x`.
|
||||
|
||||
## News
|
||||
|
||||
- **2018-09-25** - [SCM-Manager 2 gets a boost by Cloudogu
|
||||
GmbH](https://www.scm-manager.org/scm-manager-2/scm-manager-2-gets-a-boost-by-cloudogu-gmbh/)
|
||||
- **2018-05-04** - SCM-Manager 1.60 released
|
||||
([download](http://www.scm-manager.org/download/) \|
|
||||
[release notes](release-notes.md))
|
||||
- **2018-04-11** - SCM-Manager 1.59 released
|
||||
|
||||
[All news](http://www.scm-manager.org/news/)
|
||||
All news regarding SCM-Manager will be published in our [blog](https://www.scm-manager.org/blog/).
|
||||
|
||||
## Mailing List
|
||||
|
||||
- <scmmanager@googlegroups.com> -
|
||||
[archive](http://groups.google.com/group/scmmanager) \|
|
||||
[subscribe](mailto:scmmanager+subscribe@googlegroups.com)
|
||||
\|
|
||||
[subscribe](mailto:scmmanager+subscribe@googlegroups.com) \|
|
||||
[unsubscribe](mailto:scmmanager+unsubscribe@googlegroups.com)
|
||||
|
||||
## Documentation
|
||||
You can find the complete documentation in the [docs/](docs/Home.md) directory.
|
||||
You can find the complete documentation on our [homepage](https://www.scm-manager.org/docs/).
|
||||
|
||||
## Need help?
|
||||
|
||||
Looking for more guidance? Full documentation lives [in the SCM-Manager repository](https://github.com/scm-manager/scm-manager/blob/develop/docs/Home.md). Do you have further ideas or need support?
|
||||
Looking for more guidance? Full documentation lives on our [homepage](https://www.scm-manager.org/docs/) or the
|
||||
dedicated pages for our [plugins](https://www.scm-manager.org/plugins/). Do you have further ideas or need support?
|
||||
|
||||
- **Community Support** - Contact the SCM-Manager support team for questions about SCM-Manager, to report bugs or to request features through the official channels. [Find more about this here](https://www.scm-manager.org/support/).
|
||||
- **Community Support** - Contact the SCM-Manager support team for questions about SCM-Manager, to report bugs or to
|
||||
request features through the official channels. [Find more about this here](https://www.scm-manager.org/support/).
|
||||
|
||||
- **Enterprise Support** - Do you require support with the integration of SCM-Manager into your processes, with the customization of the tool or simply a service level agreement (SLA)? **Contact our development partner Cloudogu! Their team is looking forward to discussing your individual requirements with you and will be more than happy to give you a quote.** [Request Enterprise Support](https://cloudogu.com/en/scm-manager-enterprise/).
|
||||
- **Enterprise Support** - Do you require support with the integration of SCM-Manager into your processes, with the
|
||||
customization of the tool or simply a service level agreement (SLA)? **Contact our development partner Cloudogu!
|
||||
Their team is looking forward to discussing your individual requirements with you and will be more than happy to
|
||||
give you a quote.** [Request Enterprise Support](https://cloudogu.com/en/scm-manager-enterprise/).
|
||||
|
||||
14
docs/de/index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Dokumentation
|
||||
subtitle: SCM-Manager Dokumentation
|
||||
---
|
||||
Diese Dokumentation beschreibt die Verwaltung und Verwendung vom SCM-Manager. Sie steht in verschiedenen Sprachen und Versionen zur Verfügung, die im Menü rechts ausgewählt werden können.
|
||||
|
||||
Der SCM-Manager 2 ist ein extrem leichtgewichtiges Source Code Management-Tool und kann über eine Vielzahl von Plugins individuell erweitert werden.
|
||||
Die Dokumentation zum SCM-Manager ist in fünf verschiedene Kategorien unterteilt:
|
||||
|
||||
- Der Abschnitt "Erste Schritte" beschreibt die Installation und die Konfiguration des SCM-Managers und beantwortet häufig gestellte Fragen.
|
||||
- Der Bereich "Administration" handelt von Themen, die beim Betreiben einer Instanz von Belangen sind.
|
||||
- Unter der Rubrik "Entwicklung" werden alle Informationen zusammengefasst, die für die Weiterentwicklung des SCM-Managers relevant sind. Hierbei wird beschrieben, wie der SCM-Manager gebaut werden kann und was es dabei zu Beachten gilt.
|
||||
- Der Bereich "Pluginentwicklung" legt den Fokus auf den Prozess eben dieser.
|
||||
- Unter dem Abschnitt "Anwenderorientiert" werden aus Anwendersicht die Funktionen des SCM-Managers in der Basis-Variante mit dem Mindest-Set an Plugins beschrieben. Die Features der optionalen Plugins werden in separaten Dokumentationen vorgestellt.
|
||||
6
docs/de/navigation.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
- section: Anwenderorientiert
|
||||
entries:
|
||||
- /user/repo/
|
||||
- /user/user/
|
||||
- /user/group/
|
||||
- /user/admin/
|
||||
BIN
docs/de/user/admin/assets/administration-information.png
Normal file
|
After Width: | Height: | Size: 203 KiB |
BIN
docs/de/user/admin/assets/administration-permissionRoles.png
Normal file
|
After Width: | Height: | Size: 162 KiB |
BIN
docs/de/user/admin/assets/administration-plugins-available.png
Normal file
|
After Width: | Height: | Size: 182 KiB |
BIN
docs/de/user/admin/assets/administration-plugins-installed.png
Normal file
|
After Width: | Height: | Size: 188 KiB |
BIN
docs/de/user/admin/assets/administration-settings-general.png
Normal file
|
After Width: | Height: | Size: 188 KiB |
14
docs/de/user/admin/index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Administration
|
||||
partiallyActive: true
|
||||
---
|
||||
Im Bereich Administration kann die SCM-Manager Instanz administriert werden. Von hier können Plugins verwaltet, Berechtigungsrollen festgelegt und angepasst, sowie Einstellungen vorgenommen werden.
|
||||
|
||||
* [Plugins](plugins/)
|
||||
* [Berechtigungsrollen](roles/)
|
||||
* [Einstellungen](settings/)
|
||||
|
||||
### Information
|
||||
Auf der Informationsseite in der Administration findet man die aktuelle Version der SCM-Manager Instanz und hilfreiche Links zur Kontaktaufnahme mit dem SCM-Manager Support-Team.
|
||||
|
||||

|
||||
19
docs/de/user/admin/plugins.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Administration
|
||||
subtitle: Plugins
|
||||
---
|
||||
Unter dem Eintrag "Plugins" können mithilfe des externen Plugin-Centers Plugins für den SCM Manager verwaltet werden. Die Plugins werden nach installierten und verfügbaren Plugins unterschieden und nach Funktionsschwerpunkt wie bspw. Workflow oder Authentifizierung gruppiert.
|
||||
|
||||
Die Plugins können über Funktions-Icons auf den Kacheln verwaltet werden. Systemrelevante Plugins, die der SCM-Manager selbst liefert, können weder deinstalliert noch aktualisiert werden.
|
||||
|
||||
Damit Änderungen der Plugins wirksam werden, muss der SCM-Manager-Server neugestartet werden. Das kann nach jeder einzelnen Aktion erfolgen. Es ist aber auch möglich viele unterschiedliche Aktionen wie Installieren, Aktualisieren und Löschen in eine Warteschlange einzureihen und alle Aktionen mit einem einzigen Neustart auszuführen. Wird eine Aktion (Installieren, Deinstallieren, Aktualisieren) für ein Plugin ausgewählt, erscheinen die Schaltflächen "Änderungen ausführen" und "Änderungen abbrechen". Über "Änderungen ausführen" öffnet sich ein Pop-Up Fenster, indem die aktuelle Warteschlange (alle ausgeführten Aktionen ohne Neustart) angezeigt werden. Der Anwender hat nun die Möglichkeit zu entscheiden, ob die Änderungen durch einen Neustart ausgeführt werden sollen. Falls Aktionen, die sich bereits in der Warteschlange befinden nicht mehr erwünscht sind, kann die gesamte Warteschlange über den Button "Änderungen abbrechen" verworfen werden.
|
||||
|
||||
### Installiert
|
||||
Auf der Übersicht für installierte Plugins werden alle auf der SCM-Manager Instanz installierten Plugins angezeigt. Optionale Plugins können hier deinstalliert und aktualisiert werden.
|
||||
|
||||

|
||||
|
||||
### Verfügbar
|
||||
Auf der Übersicht der verfügbaren Plugins werden alle kompatiblen Plugins, die über das SCM-Plugin-Center zur Verfügung stehen, aufgeführt. Die Plugins können über den Download-Icon heruntergeladen und mit einem Neustart des SCM-Manager-Servers installiert werden.
|
||||
|
||||

|
||||
11
docs/de/user/admin/roles.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Administration
|
||||
subtitle: Berechtigungsrollen
|
||||
---
|
||||
Auf der Seite "Berechtigungsrollen" können unterschiedliche Profile mit Berechtigungen erstellt werden. Einer Rolle werden ein Name und ein Satz an Berechtigungen zugewiesen. Diese Rolle kann dann Nutzern und Gruppen für einzelne Repositories zugewiesen werden.
|
||||
|
||||
Es gibt vordefinierte System-Rollen, die nicht verändert oder gelöscht werden können.
|
||||
|
||||
Durch einen Klick auf eine Rolle sieht man die Informationen zur Rolle und welche Berechtigungen dieser Rolle zugewiesen sind. Benutzerdefinierte Rollen können nachträglich editiert und gelöscht werden.
|
||||
|
||||

|
||||
59
docs/de/user/admin/settings.md
Normal file
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Administration
|
||||
subtitle: Einstellungen
|
||||
displayToc: true
|
||||
---
|
||||
In den Einstellungen findet die globale Konfiguration der SCM-Manager Instanz statt. Viele SCM-Manager-Plugins, die sich konfigurieren lassen, erhalten nach ihrer Installation einen Eintrag unter Einstellungen. Dadurch ist er nach Bedarf maximal konfigurierbar.
|
||||
|
||||
### Generell
|
||||
#### Realm Beschreibung
|
||||
Im Feld "Realm Beschreibung" kann definiert werden, welcher Authentication Realm für die Anmeldung mit Basic Authentication verwendet wird.
|
||||
|
||||
#### Namespace Strategien
|
||||
Im SCM-Manager werden die Repositories nach Namespaces gruppiert. Diese Gruppierung kann nach unterschiedlichen Strategien stattfinden:
|
||||
|
||||
* Benutzername: Der Benutzername des angemeldeten Benutzers wird verwendet
|
||||
* Aktuelles Jahr: Das aktuelle Jahr wird verwendet
|
||||
* Repository Typ: Der Typ (git, hg oder svn) wird verwendet
|
||||
* Benutzerdefiniert: Der Namespace kann beim Erstellen des Repositories frei gewählt werden
|
||||
|
||||
#### Login Info URL
|
||||
Auf der Login-Seite des SCM-Managers werden hilfreiche Plugins und Features vorgestellt. Falls man eigene Informationen auf die Login-Seite abbilden möchte, kann diese URL ausgetauscht werden.
|
||||
|
||||
#### XSRF Protection aktivieren
|
||||
Um Angriffe auf den SCM-Manager mit Cross Site Scripting (XSS / XSRF) zu erschweren. Dieses Feature ist noch experimentell.
|
||||
|
||||
#### Plugin-Center-URL
|
||||
Der SCM-Manager kann ein Plugin-Center anbinden, um schnell und bequem Plugins verwalten zu können. Um ein anderes SCM-Plugin-Center als das vorkonfigurierte zu verwenden, reicht es aus diese URL zu ändern. Läuft der SCM-Manager im Cloudogu EcoSystem kann die Plugin Center URL über einen Eintrag im etcd gesetzt werden.
|
||||
|
||||
#### Anonyme Zugriff erlauben
|
||||
Der SCM-Manager 2 hat das Konzept für anonyme Zugriffe über einen "_anonymous"-Benutzer realisiert. Beim Aktivieren des anonymen Zugriffs wird ein neuer Benutzer erstellt mit dem Namen "_anonymous". Dieser Nutzer kann wie ein gewöhnlicher Benutzer für unterschiedliche Aktionen berechtigt werden. Bei einem Zugriff auf den SCM-Manager ohne Zugangsdaten (gilt nicht für die Web-Oberflächen) wird dieser anonyme Benutzer verwendet.
|
||||
|
||||
Beispiel: Falls der anonyme Zugriff aktiviert ist und der "_anonymous"-Benutzer volle Zugriffsrechte auf ein bestimmtes Git-Repository hat, kann jeder über eine Kommandozeile mit den klassischen Git-Befehlen ohne Zugangsdaten auf dieses Repository zugreifen. Zugriffe über SSH werden aktuell nicht unterstützt.
|
||||
|
||||
#### Anmeldeversuche
|
||||
Es lässt sich konfigurieren wie häufig sich ein Benutzer falsch anmelden darf, bevor dessen Benutzerkonto gesperrt wird. Der Zähler für fehlerhafte Anmeldeversuche wird nach einem erfolgreichen Login zurückgesetzt. Man kann dieses Feature abschalten, indem man "-1" in die Konfiguration einträgt.
|
||||
|
||||
#### Timeout bei fehlgeschlagenen Anmeldeversuchen
|
||||
Falls konfiguriert werden Benutzerkonten bei zu vielen fehlgeschlagenen Anmeldeversuche gesperrt. Über einen Timeout kann gesteuert werden, wie lange diese Konten deaktiviert werden.
|
||||
|
||||
#### Base URL
|
||||
Bei der Base URL handelt es sich um die URL, unter der die SCM-Manager Instanz aufgerufen werden kann. Über eine Checkbox kann konfiguriert werden, ob diese Base URL erzwungen werden soll. Durch das Erzwingen werden Zugriff auf diese Applikation über andere URLs auf die Base URL umgeleitet.
|
||||
|
||||
Beispiel: Die Base URL lautet www.scm-manager.com/scm, es gibt aber noch eine zweite URL www.scm-manager.io/scm. Beide zeigen auf dieselbe SCM-Manager Instanz. Wenn die Base URL erzwungen wird, wird der Anwender bei einem Zugriff über www.scm-manager.io/scm direkt auf die Base URL www.scm-manager.com/scm weitergeleitet.
|
||||
|
||||
**Achtung:** Wenn die Base URL auf einen falschen Wert gesetzt wird und der Haken bei "Base URL erzwingen" gesetzt wurde, ist die SCM-Manager Instanz nicht mehr erreichbar.
|
||||
|
||||
#### Proxy Einstellungen
|
||||
Falls die SCM-Manager Instanz hinter einem Proxy-Server liegt, kann hier die Verbindung konfiguriert werden.
|
||||
|
||||

|
||||
|
||||
### Mercurial
|
||||
Hier können globale Einstellungen zum Arbeiten mit dem Source Control Management Tool "Mercurial", kurz hg, konfiguriert werden.
|
||||
|
||||
### Git
|
||||
Hier können globale Einstellungen zum Arbeiten mit dem Source Control Management Tool "Git" konfiguriert werden.
|
||||
|
||||
### Subversion
|
||||
Hier können globale Einstellungen zum Arbeiten mit dem Source Control Management Tool "Subversion", kurz svn, konfiguriert werden.
|
||||
BIN
docs/de/user/group/assets/create-group.png
Normal file
|
After Width: | Height: | Size: 153 KiB |
BIN
docs/de/user/group/assets/external-cas-group.png
Normal file
|
After Width: | Height: | Size: 147 KiB |
BIN
docs/de/user/group/assets/groups-information.png
Normal file
|
After Width: | Height: | Size: 149 KiB |
BIN
docs/de/user/group/assets/groups-overview.png
Normal file
|
After Width: | Height: | Size: 154 KiB |
BIN
docs/de/user/group/assets/groups-settings-general.png
Normal file
|
After Width: | Height: | Size: 157 KiB |
BIN
docs/de/user/group/assets/groups-settings-permissions.png
Normal file
|
After Width: | Height: | Size: 201 KiB |
9
docs/de/user/group/external.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Gruppen
|
||||
subtitle: Externe Gruppen (CAS)
|
||||
---
|
||||
Benutzer, die sich über eine CAS-Instanz (Central Authentication Service) am SCM-Manager anmelden, erhalten zusätzliche Gruppen aus dem CAS beigefügt. Externe Gruppen können ohne ein manuelles Anlegen im SCM-Manager genutzt werden. Das Hinzufügen, der als "extern" gekennzeichneten Gruppen, bringt jedoch die Vorteile mich sich, dass die angelegten Gruppen bei der Autovervollständigung im SCM-Manager berücksichtigt werden und es können Berechtigungen direkt an eine externe Gruppe zugewiesen werden. Welche externen Gruppen einem Benutzer zugewiesen sind, lässt sich über die Profil-Seite eines angemeldeten Benutzers auslesen.
|
||||
|
||||
Siehe Beispiel: CasGroup
|
||||
|
||||

|
||||
25
docs/de/user/group/index.md
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Gruppen
|
||||
partiallyActive: true
|
||||
---
|
||||
Der Bereich Gruppen umfasst alles, was auf einen Zusammenschluss mehrerer Anwender und deren Berechtigungen herunterzubrechen ist.
|
||||
|
||||
* [Externe Gruppen (CAS)](external/)
|
||||
* [Einstellungen](settings/)
|
||||
|
||||
Um nicht jeden Benutzer einzeln berechtigen zu müssen, gibt es im SCM-Manager die Möglichkeit Gruppen anzulegen. Diese Gruppen können mit Berechtigungen ausgestattet werden und können beliebig viele Benutzer enthalten.
|
||||
|
||||
### Übersicht
|
||||
Die Gruppenübersicht zeigt eine Liste der existierenden Gruppen an. Die Gruppen werden dabei nach internen Gruppen und externen Gruppen unterschieden. Interne Gruppen werden in der Übersicht durch das Haus-Symbol kenntlich gemacht und sind Gruppen, die im SCM-Manager erstellt wurden. Externe Gruppen wiederum haben das Planeten-Symbol und sind Gruppen, dessen Mitglieder von externen Quellen wie beispielsweise einer LDAP-Instanz verwaltet werden.
|
||||
|
||||

|
||||
|
||||
### Gruppe erstellen
|
||||
Für das Erstellen einer Gruppe wird lediglich ein Name benötigt. Es können aber auch direkt beim Erstellen die Beschreibung und die Mitglieder hinzugefügt werden. Einzig die Berechtigungen der Gruppe müssen nachträglich konfiguriert werden.
|
||||
|
||||

|
||||
|
||||
### Gruppen Informationen
|
||||
Die Informationsseite einer Gruppe zeigt neben den Metadaten auch eine Liste der Gruppenmitglieder an.
|
||||
|
||||

|
||||
13
docs/de/user/group/settings.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Gruppen
|
||||
subtitle: Einstellungen
|
||||
---
|
||||
### Generell
|
||||
In den allgemeinen Einstellungen einer Gruppe können die Beschreibung und die Mitglieder-Liste editiert werden. Ebenso kann die Gruppe hier gelöscht werden. Dieser Vorgang kann nicht rückgängig gemacht werden.
|
||||
|
||||

|
||||
|
||||
### Berechtigungen
|
||||
Eine Gruppe kann globale Berechtigung bekommen. Diese Berechtigungen gelten für alle Mitglieder der Gruppe.
|
||||
|
||||

|
||||
BIN
docs/de/user/repo/assets/create-repository.png
Normal file
|
After Width: | Height: | Size: 150 KiB |
BIN
docs/de/user/repo/assets/repository-branch-detailView.png
Normal file
|
After Width: | Height: | Size: 155 KiB |
BIN
docs/de/user/repo/assets/repository-branches-overview.png
Normal file
|
After Width: | Height: | Size: 152 KiB |
BIN
docs/de/user/repo/assets/repository-code-changesetDetails.png
Normal file
|
After Width: | Height: | Size: 225 KiB |
BIN
docs/de/user/repo/assets/repository-code-changesetsView.png
Normal file
|
After Width: | Height: | Size: 206 KiB |
BIN
docs/de/user/repo/assets/repository-code-fileHistory.png
Normal file
|
After Width: | Height: | Size: 208 KiB |
BIN
docs/de/user/repo/assets/repository-code-fileViewer.png
Normal file
|
After Width: | Height: | Size: 206 KiB |
BIN
docs/de/user/repo/assets/repository-code-sourcesView.png
Normal file
|
After Width: | Height: | Size: 177 KiB |
BIN
docs/de/user/repo/assets/repository-create-branch.png
Normal file
|
After Width: | Height: | Size: 150 KiB |
BIN
docs/de/user/repo/assets/repository-information.png
Normal file
|
After Width: | Height: | Size: 171 KiB |
BIN
docs/de/user/repo/assets/repository-overview-branches.png
Normal file
|
After Width: | Height: | Size: 777 B |
BIN
docs/de/user/repo/assets/repository-overview-changesets.png
Normal file
|
After Width: | Height: | Size: 531 B |
BIN
docs/de/user/repo/assets/repository-overview-settings.png
Normal file
|
After Width: | Height: | Size: 753 B |
BIN
docs/de/user/repo/assets/repository-overview-sources.png
Normal file
|
After Width: | Height: | Size: 976 B |
BIN
docs/de/user/repo/assets/repository-overview.png
Normal file
|
After Width: | Height: | Size: 173 KiB |
BIN
docs/de/user/repo/assets/repository-settings-general-git.png
Normal file
|
After Width: | Height: | Size: 164 KiB |
BIN
docs/de/user/repo/assets/repository-settings-permissionList.png
Normal file
|
After Width: | Height: | Size: 107 KiB |
|
After Width: | Height: | Size: 175 KiB |
22
docs/de/user/repo/branches.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Repository
|
||||
subtitle: Branches
|
||||
---
|
||||
### Übersicht
|
||||
Auf der Branches-Übersicht sind die bereits existierenden Branches aufgeführt. Bei einem Klick auf einen Branch wird man zur Detailseite des Branches weitergeleitet.
|
||||
|
||||
Der Tag "Default" gibt an welcher Branch aktuell, als Standard-Branch dieses Repository im SCM-Manager markiert ist. Der Standard-Branch wird immer zuerst angezeigt, wenn man das Repository im SCM-Manager öffnet.
|
||||
|
||||
Über den "Branch erstellen"-Button gelangt man zum Formular, um neue Branches anzulegen.
|
||||
|
||||

|
||||
|
||||
### Branch erstellen
|
||||
Mit dem "Branch erstellen"-Formular können neue Branches für das Repository erzeugt werden. Dafür muss ausgewählt werden von welchem existierenden Branch der neue Branch abzweigen soll und wie der neue Branch heißen soll. In einem leeren Git Repository können keine Branches erzeugt werden.
|
||||
|
||||

|
||||
|
||||
### Branch Detailseite
|
||||
Hier werden einige Befehle zum Arbeiten mit dem Branch auf einer Kommandozeile aufgeführt.
|
||||
|
||||

|
||||
42
docs/de/user/repo/code.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Repository
|
||||
subtitle: Code
|
||||
displayToc: true
|
||||
---
|
||||
Die Sektion "Code" enthält sämtliche Informationen, die sich auf den Code bzw. Inhalt des Repository beziehen. Oben auf der Seite befindet sich ein Aktionsbalken über den innerhalb der Code-Sektion navigiert werden kann.
|
||||
|
||||
### Sources
|
||||
Die Übersicht der Sources zeigt die Dateien und Ordner in dem Repository an. Wenn Branches existieren, werden die Sources für den ausgewählten Branch angezeigt.
|
||||
|
||||
Es gibt unter dem Aktionsbalken eine Breadcrumbs Navigation, die den Pfad der angezeigten Dateien darstellt. Durch Klicken auf die einzelnen Pfad-Bestandteile, kann man sich durch die Dateistruktur des Repository (zurück-)navigieren.
|
||||
|
||||

|
||||
|
||||
### Changesets
|
||||
Die Übersicht der Changesets/Commits zeigt die Änderungshistorie je Branch an. Jeder Listeneintrag stellt einen Commit dar.
|
||||
|
||||
Über den Details-Button kann man sich den Inhalt / die Änderungen dieses Changesets ansehen.
|
||||
|
||||
Über den Sources-Button gelangt man zur Sources-Übersicht und es wird der Datenstand zum Zeitpunkt nach diesem Commit angezeigt.
|
||||
|
||||

|
||||
|
||||
### Changeset Details
|
||||
Auf der Detailseite eines Changesets sieht man zusätzlich zu den Metadaten des Changesets sämtliche Änderungen, die in diesem Changeset enthalten sind. Die Diffs werden dabei im bekannten Format je Datei inklusive Syntax-Highlighting angezeigt.
|
||||
|
||||

|
||||
|
||||
### Datei Details
|
||||
Nach einem Klick auf eine Datei in den Sources landet man in der Detailansicht der Datei. Dabei sind je nach Dateiformat unterschiedliche Ansichten zu sehen:
|
||||
|
||||
- Bild-Datei: Bild wird gerendert angezeigt.
|
||||
- Markdown-Datei: Markdown wird gerendert dargestellt. Die Ansicht kann auf eine nicht gerenderte Textansicht umgeschaltet werden.
|
||||
- Text-basierte Datei: Der Text wird angezeigt. Falls verfügbar mit Syntax-Highlighting.
|
||||
- Nicht unterstützte Formate: Ein Download-Button wird angezeigt.
|
||||
|
||||

|
||||
|
||||
### Datei Historie
|
||||
Bei der Datei Details Ansicht kann man über einen Switch oben rechts auf die Historien-Ansicht wechseln. Dort werden die Commits aufgelistet, die diese Datei verändert haben.
|
||||
|
||||

|
||||
39
docs/de/user/repo/index.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Repository
|
||||
partiallyActive: true
|
||||
---
|
||||
Der Bereich Repository umfasst alles auf Basis von Repositories in Namespaces. Dazu zählen alle Operationen auf Branches, der Code und Einstellungen.
|
||||
|
||||
* [Branches](branches/)
|
||||
* [Code](code/)
|
||||
* [Einstellungen](settings/)
|
||||
|
||||
### Übersicht
|
||||
Auf der Übersichtsseite der Repositories werden die einzelnen Repositories nach Namespaces gegliedert aufgelistet. Jedes Repository wird durch eine Kachel dargestellt. Durch einen Klick auf diese Kachel öffnet sich die Readme Seite des jeweiligen Repositories.
|
||||
|
||||

|
||||
|
||||
Über die Suchleiste oben können die Repositories gefiltert werden. Die Suche filtert dabei nach dem Namen und der Beschreibung des Repositories.
|
||||
|
||||
Ein bestimmter Tab des Repositories wie Branches, Changesets oder Sources kann über die blauen Icons geöffnet werden.
|
||||
|
||||
Icon | Beschreibung
|
||||
---|---
|
||||
 | Öffnet die Branches-Übersicht für das Repository
|
||||
 | Öffnet die Changesets-Übersicht für das Repository
|
||||
 | Öffnet die Sources-Übersicht für das Repository
|
||||
 | Öffnet die Einstellungen für das Repository
|
||||
|
||||
### Repository erstellen
|
||||
Im SCM-Manager können neue Git, Mercurial & Subersion (SVN) Repositories über ein Formular angelegt werden. Dieses kann über den Button "Repository erstellen" aufgerufen werden. Dabei muss ein gültiger Name eingetragen und der Repository-Typ bestimmt werden.
|
||||
|
||||
Optional kann man das Repository beim Erstellen direkt initialisieren. Damit werden für Git und Mercurial jeweils der Standard-Branch (master bzw. default) angelegt. Außerdem wird ein initialer Commit ausgeführt, der eine README.md erzeugt.
|
||||
|
||||
Ist die Namespace-Strategie auf "Benutzerdefiniert" eingestellt, muss noch ein Namespace eingetragen werden.
|
||||
|
||||

|
||||
|
||||
### Repository Informationen
|
||||
Die Informationsseite eines Repository zeigt die Metadaten zum Repository an. Darunter befinden sich Beschreibungen zu den unterschiedlichen Möglichkeiten wie man mit diesem Repository arbeiten kann.
|
||||
|
||||

|
||||
23
docs/de/user/repo/settings.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Repository
|
||||
subtitle: Einstellungen
|
||||
---
|
||||
Unter den Repository Einstellungen befinden sich zwei Einträge. Wenn weitere Plugins installiert sind, können es deutlich mehr Unterseiten sein.
|
||||
|
||||
### Generell
|
||||
Unter dem Eintrag "Generell" kann man die Zusatzinformationen zum Repository editieren. Da es sich im Beispiel um ein Git Repository handelt, kann ebenfalls der Standard-Branch für dieses Repository gesetzt werden. Der Standard-Branch sorgt dafür, dass beim Arbeiten mit diesem Repository dieser Branch vorrangig geöffnet wird, falls kein expliziter Branch ausgewählt wurde.
|
||||
|
||||
Über den Button unten auf dieser Seite besteht noch die Möglichkeit dieses Repository aus dem SCM-Manager zu löschen. Dieser Vorgang kann nicht rückgängig gemacht werden.
|
||||
|
||||

|
||||
|
||||
### Berechtigungen
|
||||
Dank des fein granularen Berechtigungskonzepts des SCM-Managers können Nutzern und Gruppen, basierend auf definierbaren Rollen oder auf individuellen Einstellungen, Rechte zugewiesen werden. Berechtigungen können global und auf Repository-Ebene vergeben werden. Globale Berechtigungen werden in der Administrations-Oberfläche des SCM-Managers vergeben. Unter diesem Eintrag handelt es sich um Repository-bezogene Berechtigungen.
|
||||
|
||||
Die Berechtigungen können jeweils für Gruppen und für Benutzer vergeben werden. Dabei gibt es die Möglichkeiten die Berechtigungen über Berechtigungsrollen zu definieren oder jede Berechtigung einzeln zu vergeben. Die Berechtigungsrollen können in der Administrations-Oberfläche definiert werden.
|
||||
|
||||

|
||||
|
||||
Für individuelle Berechtigungen kann man über "Erweitert" einen Dialog öffnen, um jede Berechtigung einzeln zu vergeben.
|
||||
|
||||

|
||||
BIN
docs/de/user/user/assets/create-user.png
Normal file
|
After Width: | Height: | Size: 150 KiB |
BIN
docs/de/user/user/assets/user-information.png
Normal file
|
After Width: | Height: | Size: 151 KiB |
BIN
docs/de/user/user/assets/user-overview.png
Normal file
|
After Width: | Height: | Size: 154 KiB |
BIN
docs/de/user/user/assets/user-settings-general.png
Normal file
|
After Width: | Height: | Size: 154 KiB |
BIN
docs/de/user/user/assets/user-settings-password.png
Normal file
|
After Width: | Height: | Size: 146 KiB |
BIN
docs/de/user/user/assets/user-settings-permissions.png
Normal file
|
After Width: | Height: | Size: 205 KiB |
26
docs/de/user/user/index.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Benutzer
|
||||
partiallyActive: true
|
||||
---
|
||||
Der Bereich Benutzer umfasst alles, was auf einen einzelnen Anwender und dessen Berechtigungen herunterzubrechen ist.
|
||||
|
||||
* [Einstellungen](settings/)
|
||||
|
||||
### Übersicht
|
||||
Auf der Benutzer Übersichtsseite wird eine Liste der existierenden Benutzer angezeigt. Durch Klicken auf einen Benutzer gelangt man zu dessen Detailseite. Über die Schaltfläche "Benutzer erstellen" können neue Benutzer angelegt werden.
|
||||
|
||||

|
||||
|
||||
### Benutzer erstellen
|
||||
Mithilfe des "Benutzer erstellen"-Formulars können neue Benutzer im SCM-Manager angelegt werden. Neue Benutzer haben noch keine Berechtigungen und sollten direkt nach dem Anlegen konfiguriert werden.
|
||||
|
||||

|
||||
|
||||
### Benutzer Detailseite
|
||||
Die Detailseite eines Benutzers zeigt die Informationen zu diesem an.
|
||||
|
||||
Über den "Aktiv"-Marker sieht man, ob dies ein aktivierter Benutzer des SCM-Managers ist. Wird ein Benutzer auf inaktiv gesetzt, kann er sich nicht mehr am SCM-Manager anmelden.
|
||||
|
||||
Der Typ eines Benutzers gibt an, aus welcher Quelle dieser Benutzer stammt. Der Typ "XML" aus dem Beispiel gibt an, dass dieser Benutzer im SCM-Manager erstellt wurde. Daneben kann es aber auch externe Benutzer geben, die beispielweise mithilfe des LDAP-Plugins aus einer LDAP-Instanz angebunden wurden.
|
||||
|
||||

|
||||
21
docs/de/user/user/settings.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Benutzer
|
||||
subtitle: Einstellungen
|
||||
---
|
||||
### Generell
|
||||
In den generellen Einstellungen des Benutzers können der Anzeigename, die E-Mail-Adresse und der Aktivitätsstatus des Kontos editiert werden.
|
||||
|
||||
Über die Schaltfläche unten kann der Benutzer auch komplett gelöscht werden. Dieser Vorgang kann nicht rückgängig gemacht werden.
|
||||
|
||||

|
||||
|
||||
### Passwort
|
||||
Unter dem Eintrag "Passwort" kann das Login-Passwort des Benutzers geändert werden. Falls ein Benutzer sein Passwort selbst ändern möchte, kann er das machen indem er sich einloggt und ganz unten in der Fußzeile der Seite auf seinen Namen klickt. Dann gelangt er in die Kontoeinstellungen kann unter anderem ein neues Passwort vergeben.
|
||||
|
||||

|
||||
|
||||
### Berechtigungen
|
||||
Hier werden die globalen (nicht-Repository-bezogenen) Berechtigungen für einen Benutzer konfiguriert.
|
||||
Für die einzelnen Rechte sind Tooltips verfügbar, welche Auskunft über die Auswirkungen der jeweiligen Berechtigung geben.
|
||||
|
||||

|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
title: State of SCM-Manager 2 development
|
||||
---
|
||||
The development of SCM-Manager 2.0.0 is organised in [Trello Boards](https://trello.com/scmmanager).
|
||||
|
||||
## [Milestone 1](https://trello.com/b/oit1MD92/scm-manager-2-0-0-milestone-1)
|
||||
|
||||
### Main goals
|
||||
* remove deprecated and unused stuff
|
||||
* remove old style listeners
|
||||
* replace [guava eventbus](https://code.google.com/p/guava-libraries/wiki/EventBusExplained) with [legman](https://github.com/sdorra/legman)
|
||||
* introduce new plugin structure
|
||||
* offline plugin installation/updates/deinstallation
|
||||
* use java 7 as default
|
||||
* use of [annotation processors](http://docs.oracle.com/javase/7/docs/api/javax/annotation/processing/Processor.html) instead of classpath scanning
|
||||
* move non core modules (plugin-backend, maven plugins, etc.) to separate repositories
|
||||
|
||||
## [Milestone 2](https://trello.com/b/Afb3hoJ9/scm-manager-2-0-0-milestone-2)
|
||||
|
||||
### Main goals
|
||||
* use [apache shiro](http://shiro.apache.org/) everywhere
|
||||
* improve authentication
|
||||
* improve user and group management
|
||||
* use permission instead of roles
|
||||
|
||||
## [Milestone 3](https://trello.com/b/eLvqTGGe/scm-manager-2-0-0-milestone-3)
|
||||
|
||||
### Main goals
|
||||
* completely new designed rest api
|
||||
|
||||
## Milestone 4
|
||||
|
||||
### Main goals
|
||||
* completely new user interface
|
||||
|
||||
## Milestone 5
|
||||
|
||||
### Main goals
|
||||
* improve repository api
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
title: Command line client
|
||||
---
|
||||
|
||||
You can download the command line client from
|
||||
[here](http://www.scm-manager.org/download/) (the scm-cli-client).
|
||||
|
||||
### Examples
|
||||
|
||||
**1\. Store username, password and server url**
|
||||
|
||||
```bash
|
||||
$ java -jar scm-cli-client-1.47-jar-with-dependencies.jar --user scmadmin --password madmin --server http://localhost:8080/scm store-config
|
||||
|
||||
store config
|
||||
```
|
||||
|
||||
**2\. List all repositories**
|
||||
|
||||
```bash
|
||||
$ java -jar scm-cli-client-1.47-jar-with-dependencies.jar list-repositories
|
||||
|
||||
ID: fbb64701-6dd3-4847-8588-26f693736961
|
||||
Name: scm
|
||||
Type: hg
|
||||
E-Mail: s.sdorra@gmail.com
|
||||
Description: SCM-Manager
|
||||
Public: false
|
||||
Creation-Date: 2011-06-03 16:13:19
|
||||
Last-Modified: 2011-06-03 16:15:38
|
||||
URL: http://localhost:8080/scm/hg/scm
|
||||
Permissions:
|
||||
WRITE - sdorra (Group: false)
|
||||
```
|
||||
|
||||
**3\. Create a new user**
|
||||
|
||||
```bash
|
||||
$ java -jar scm-cli-client-1.47-jar-with-dependencies.jar create-user --name test --display-name "Test User" --mail "test@scm-manager.org" --password secret
|
||||
|
||||
Name: test
|
||||
Display Name: Test User
|
||||
Type: xml
|
||||
E-Mail: test@scm-manager.org
|
||||
Administrator: false
|
||||
Creation-Date:
|
||||
Last-Modified:
|
||||
```
|
||||
|
||||
**4\. Add write permission for user test to repository scm**
|
||||
|
||||
```bash
|
||||
$ java -jar scm-cli-client-1.47-jar-with-dependencies.jar add-permission fbb64701-6dd3-4847-8588-26f693736961 --name test -t WRITE
|
||||
|
||||
ID: fbb64701-6dd3-4847-8588-26f693736961
|
||||
Name: scm
|
||||
Type: hg
|
||||
E-Mail: s.sdorra@gmail.com
|
||||
Description: SCM-Manager
|
||||
Public: false
|
||||
Creation-Date: 2011-06-03 16:13:19
|
||||
Last-Modified: 2011-06-03 16:15:38
|
||||
URL: http://localhost:8080/scm/hg/scm
|
||||
Permissions:
|
||||
WRITE - sdorra (Group: false)
|
||||
WRITE - test (Group: false)
|
||||
```
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Logging
|
||||
subtitle: Configuration and locations of SCM-Manager logging
|
||||
---
|
||||
|
||||
SCM-Manager logs information which can be useful, if the system does not behave as expected.
|
||||
@@ -14,4 +15,21 @@ The logging behavior depends on your operating system and installation.
|
||||
| Mac OS X | ~/Library/Logs/SCM-Manager |
|
||||
| Windows | $BASEDIR\logs |
|
||||
|
||||
The location of the **$BASEDIR** can be found [here](basedirectory).
|
||||
The location of the **$BASEDIR** can be found [here](../basedirectory/).
|
||||
|
||||
## Configuration
|
||||
|
||||
The logging behaviour of SCM-Manager can be configured via an xml file.
|
||||
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.
|
||||
|
||||
@@ -1,8 +1,20 @@
|
||||
---
|
||||
title: SCM-Server and Apache mod_proxy
|
||||
title: Reverse Proxy
|
||||
subtitle: How to use SCM-Manager with common reverse proxies
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
### Apache configuration
|
||||
TODO reverse proxies in general send X-Forwarded headers ...
|
||||
|
||||
### nginx
|
||||
|
||||
TODO ...
|
||||
|
||||
### Apache
|
||||
|
||||
<!--
|
||||
TODO: does this set X-Forwarded Headers?
|
||||
-->
|
||||
|
||||
```apache
|
||||
ProxyPass /scm http://localhost:8080/scm
|
||||
@@ -16,8 +28,16 @@ ProxyPassReverse /scm http://servername:8080/scm
|
||||
- **Warning**: Setting ProxyPassReverseCookiePath would most likely cause problems with session handling!
|
||||
- **Note**: If you encounter timeout problems, please have a look at [Apache Module mod_proxy#Workers](http://httpd.apache.org/docs/current/mod/mod_proxy.html#workers).
|
||||
|
||||
### HA-Proxy
|
||||
|
||||
TODO ...
|
||||
|
||||
### SCM-Server conf/server-config.xml
|
||||
|
||||
<!--
|
||||
TODO: do we need it
|
||||
-->
|
||||
|
||||
NOTE: This file is found in the installation directory, not the user\'s
|
||||
home directory.
|
||||
|
||||
@@ -43,15 +63,3 @@ Example:
|
||||
</Arg>
|
||||
</Call>
|
||||
```
|
||||
|
||||
### SCM-Manager Configuration version 1.5 and above
|
||||
|
||||
1. Login as an admin user and select \"General\"
|
||||
2. Set the \"Base Url\" to the URL of the Apache (**warning:** don\'t check \"Force Base Url\")
|
||||
3. Save the new new settings
|
||||
|
||||
### SCM-Manager Configuration before version 1.5
|
||||
|
||||
1. Login as an admin user and select \"General\"
|
||||
2. Set the Serverport to the apache port (normally port 80)
|
||||
3. Save the new settings
|
||||
@@ -2,6 +2,11 @@
|
||||
title: SCM-Server SSL
|
||||
---
|
||||
|
||||
<!--
|
||||
TODO: Update
|
||||
Node: https://ssl-config.mozilla.org/#server=jetty&version=9.4.28&config=intermediate&guideline=5.4
|
||||
-->
|
||||
|
||||
**Note**: This document describes a ssl configuration with a
|
||||
self-signed certificate
|
||||
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
title: SCM-Server and Apache mod_jk
|
||||
---
|
||||
|
||||
### Apache Configuration
|
||||
```apache
|
||||
JkWorkersFile /etc/apache2/jkworkers.properties
|
||||
JkLogFile /var/log/apache2/mod_jk.log
|
||||
JkLogLevel info
|
||||
|
||||
JkMount /scm* worker1
|
||||
```
|
||||
|
||||
### JK Workers File (jkworkers.properties)
|
||||
```ini
|
||||
worker.list=worker1
|
||||
worker.worker1.type=ajp13
|
||||
worker.worker1.host=localhost
|
||||
worker.worker1.port=8009
|
||||
worker.worker1.lbfactor=50
|
||||
worker.worker1.cachesize=10
|
||||
worker.worker1.cache_timeout=600
|
||||
worker.worker1.socket_keepalive=1
|
||||
```
|
||||
|
||||
### SCM-Server conf/server-config.xml
|
||||
Uncomment the following lines:
|
||||
```xml
|
||||
<Call name="addConnector">
|
||||
<Arg>
|
||||
<New class="org.eclipse.jetty.ajp.Ajp13SocketConnector">
|
||||
<Set name="port">8009</Set>
|
||||
</New>
|
||||
</Arg>
|
||||
</Call>
|
||||
```
|
||||
|
Before Width: | Height: | Size: 89 KiB |
@@ -1,9 +0,0 @@
|
||||
---
|
||||
title: Configuration
|
||||
partiallyActive: true
|
||||
---
|
||||
|
||||
* [Base Directory](basedirectory/)
|
||||
* [Logging](logging/)
|
||||
* [SCM-Server and Apache mod\_proxy](apache/apache-mod_proxy/)
|
||||
* [SCM-Server and Apache mod\_jk](apache/apache-mod_jk/)
|
||||
@@ -1,14 +0,0 @@
|
||||
The logging behaviour of SCM-Manager can be configured via an xml file.
|
||||
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.
|
||||
@@ -33,10 +33,6 @@ title: Intellij IDEA Configuration
|
||||
* Languages & Frameworks / Node.js and NPM
|
||||
* Package Manager: yarn
|
||||
|
||||
* Languages & Frameworks / Javascript
|
||||
* JavaScript language version: Flow
|
||||
* Flow package or executable: .../node_modules/flow-bin
|
||||
|
||||
* Languages & Frameworks / Javascript / Code Quality Tools / ESLint
|
||||
* Enable
|
||||
* ESLint package: .../node_modules/eslint
|
||||
|
||||
|
Before Width: | Height: | Size: 217 KiB After Width: | Height: | Size: 217 KiB |
|
Before Width: | Height: | Size: 338 KiB After Width: | Height: | Size: 338 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Permission Concept
|
||||
subtitle: Fine-grained permission for SCM-Manager v2
|
||||
---
|
||||
|
||||
This documents describes a concept for a fine-grained permission managing via the SCMMv2 UI.
|
||||
@@ -16,7 +17,7 @@ This documents describes a concept for a fine-grained permission managing via th
|
||||
|
||||
### Status Quo SCMv1
|
||||
|
||||
[SCMMv1 's permissions](../Permissions.md) are only related to Repositories:
|
||||
SCMMv1 's permissions are only related to Repositories:
|
||||
|
||||
* Users can either have the Permission READ, WRITER or OWNER
|
||||
* globally (for all repositories) or
|
||||
@@ -121,11 +122,11 @@ In order to fulfill the requirements, this concept describes
|
||||
The global permission component can be reached from **either user and groups** components navigations. The following mockup
|
||||
shows this in the user component:
|
||||
|
||||

|
||||

|
||||
|
||||
The layout of the permission component UI could look like this:
|
||||
|
||||

|
||||

|
||||
|
||||
The UI
|
||||
* queries all available global permissions from the REST API (shiro strings),
|
||||
@@ -141,7 +142,7 @@ permissions (see `PermissionType`).
|
||||
|
||||
The UI is extended like so:
|
||||
|
||||

|
||||

|
||||
|
||||
#### Existing repository dialog
|
||||
|
||||
@@ -397,7 +398,7 @@ and write. That is,
|
||||
|
||||
Internationalization can be handled using the following conventions:
|
||||
|
||||
* All permission i18n are described in `plugins.json` (also for core), see [i18n for Plugins](docs/en/i18n-for-plugins.mdugins.md)
|
||||
* All permission i18n are described in `plugins.json` (also for core), see [i18n for Plugins](../plugins/i18n-for-plugins)
|
||||
* That way the UI for users and groups can find all the translation in the same file
|
||||
* Convention for i18n keys: `permissions.<shiro-String>`, containing `displayName` and `description` each.
|
||||
|
||||
|
Before Width: | Height: | Size: 2.7 MiB |
@@ -2,7 +2,7 @@
|
||||
title: Migrate a v1 plugin
|
||||
---
|
||||
|
||||
Before starting, make sure to read the [Plugin Development](docs/en/plugin-development.mdpment.md).
|
||||
Before starting, make sure to read the [Plugin Development](../plugin-development).
|
||||
|
||||
To migrate an existing SCM-Manager 1.x Plugin, you have to do the following steps:
|
||||
|
||||
@@ -119,7 +119,7 @@ diff -r a988f4cfb7ab src/main/resources/META-INF/scm/plugin.xml
|
||||
### Java sources (src/main/java)
|
||||
|
||||
* try to compile the sources: `mvn compile`
|
||||
* fix problems (See [API changes](api-changes.md))
|
||||
* fix problems (TODO more help here)
|
||||
* Remove XML accept headers from REST Resource classes -> SCMMv2 supports JSON only
|
||||
* Migrate REST Resources (e.g. `v2`, add to Index Resource, Update Links) - See core plugins Git, Hg, Svn, e.g. [`GitConfigResource`](https://github.com/scm-manager/scm-manager/blob/develop/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/GitConfigResource.java)
|
||||
|
||||
@@ -139,7 +139,7 @@ diff -r a988f4cfb7ab src/main/resources/META-INF/scm/plugin.xml
|
||||
"postinstall" : "ui-plugins postinstall"
|
||||
},
|
||||
"dependencies": {
|
||||
"@scm-manager/ui-plugins" : "2.0.0-rc7"
|
||||
"@scm-manager/ui-plugins" : "2.0.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -164,10 +164,10 @@ Some more hints:
|
||||
|
||||
* For Configuration UIs use [`ConfigurationBinder`](https://github.com/scm-manager/scm-manager/blob/develop/scm-ui/ui-components/src/config/ConfigurationBinder.tsx) - See core plugins Git, Hg, Svn, e.g. [scm-git-plugin/index.ts](https://github.com/scm-manager/scm-manager/blob/develop/scm-plugins/scm-git-plugin/src/main/js/index.ts).
|
||||
Note that `readOnly` property checks if update link is returned by REST resource
|
||||
* Don't forget [i18n for Plugins](docs/en/i18n-for-plugins.mdugins.md)
|
||||
* Don't forget [i18n for Plugins](../i18n-for-plugins)
|
||||
|
||||
# Further reading
|
||||
|
||||
* [scm-manager/ui-extensions README](scm-ui/ui-extensions/README.md) - Extension Points within SCM-Manager
|
||||
* [UI Extensions](../../ui-extensions) - Extend the SCM-Manager UI
|
||||
* [scm-manager/ui-components](https://github.com/scm-manager/scm-manager/tree/develop/scm-ui/ui-components) - Reusable UI components within SCM-Manager
|
||||
* [smp-maven-plugin](https://github.com/scm-manager/smp-maven-plugin) - Plugin that facilitates efficient plugin development for SCMM
|
||||
|
||||
@@ -95,18 +95,17 @@ In order to extend the ui the plugin requires a `package.json` in the project ro
|
||||
"postinstall" : "ui-plugins postinstall"
|
||||
},
|
||||
"dependencies": {
|
||||
"@scm-manager/ui-plugins" : "2.0.0-rc7"
|
||||
"@scm-manager/ui-plugins" : "2.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
The `main` field of the `package.json` describes the main entry point of the plugin.
|
||||
The file specified at `main` should use the `binder` from the [@scm-manager/ui-extensions](../../scm-ui/ui-extensions) in oder to bind its extensions.
|
||||
For more information of extensions, binder and extension points, please have a look at the [README.md](../../scm-ui/ui-extensions/README.md) of @scm-manager/ui-extensions.
|
||||
The file specified at `main` should use the `binder` from the [@scm-manager/ui-extensions](../../ui-extensions) in oder to bind its extensions.
|
||||
|
||||
If the plugins gets build (`mvn package` or `mvn install`), the [buildfrontend-maven-plugin](https://github.com/sdorra/buildfrontend-maven-plugin), will call the `build` script of `package.json`.
|
||||
The build script triggers the `plugin` command of [@scm-manager/ui-scripts](../../scm-ui/ui-scripts).
|
||||
The build script triggers the `plugin` command of `@scm-manager/ui-scripts`.
|
||||
The `ui-scripts` will do the following steps:
|
||||
|
||||
* traverses the import statements of the script specified at `main`
|
||||
|
||||
@@ -8,35 +8,25 @@ If you want to share your plugin with SCM-Manager users, you can publish it to t
|
||||
* Create a or Git repository for your plugin
|
||||
* Develop your plugin as described in [Create a plugin](../create/)
|
||||
* Fork the [Plugin Center Repository](https://github.com/scm-manager/plugin-center)
|
||||
* Create a folder with the name of your plugin under the `src/plugins` directory
|
||||
* Put a `index.md` which starts with frontmatter metadata, which describes your plugin e.g.:
|
||||
* Create a folder with the name of your plugin under the `content/plugins` directory
|
||||
* Create a `plugin.yml` in this folder, which describes your plugin e.g.:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: scm-cas-plugin
|
||||
displayName: CAS
|
||||
description: CAS Authentication plugin for version 2.x of SCM-Manager
|
||||
category: authentication
|
||||
author: Cloudogu GmbH
|
||||
---
|
||||
```
|
||||
|
||||
* Document your plugin with [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) below the frontmatter header
|
||||
* Commit your work and open a pull request. Put the url to your plugin repository into the description of the pull request.
|
||||
|
||||
After you have opened the pull request.
|
||||
We will do a few steps to integrate your plugin into the plugin center:
|
||||
|
||||
* We will create a fork of your plugin under the [SCM-Manager Team](https://github.com/scm-manager/) and give your account write permissions
|
||||
* After that we will create a Jenkins job for your plugin on [oss.cloudogu.com](https://oss.cloudogu.com/jenkins/job/scm-manager/job/scm-manager-bitbucket/)
|
||||
* After that we will create a Jenkins job for your plugin on [oss.cloudogu.com](https://oss.cloudogu.com/jenkins/job/scm-manager-plugins/)
|
||||
* At the end we will accept your pull request
|
||||
|
||||
From now on you can work with the repository in the [SCM-Manager Team](https://github.com/scm-manager/).
|
||||
Every time you release your plugin (push a tag to the repository) the Jenkins job will build your plugin and release it to the plugin center.
|
||||
|
||||
|
||||
# Architecture
|
||||
|
||||
The following picture shows the architecture of the involved systems.
|
||||
|
||||

|
||||
Every time you release your plugin (push a release branch e.g.: release/1.0.1) the Jenkins job will build your plugin and release it to the plugin center.
|
||||
|
||||
@@ -12,4 +12,4 @@ Use this as a kind of a checklist whenever you develop something in the UI of SC
|
||||
| ☐ | add help icons to input components |
|
||||
| ☐ | not use colors directly, but refer to `is-primary` or `is-warning` |
|
||||
| ☐ | make sure your view works on mobile devices |
|
||||
| ☐ | document [extension points in wiki](docs/en/extension-points.mdoints.md) |
|
||||
| ☐ | document [extension points](../plugins/extension-points) |
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# ui-extensions
|
||||
---
|
||||
title: UI-Extensions
|
||||
subtitle: How to extend the SCM-Manager UI with plugins
|
||||
---
|
||||
|
||||
UI-Extensions contains the building blocks for the [SCM-Manager](https://scm-manager.org) ui extension system.
|
||||
|
||||
@@ -7,56 +7,24 @@ title: Frequently Asked Questions
|
||||
Username: `scmadmin`\
|
||||
Password: `scmadmin`
|
||||
|
||||
### Where does SCM-Manager store its configuration, log files and the repositories?
|
||||
### Where does SCM-Manager store its configuration, data and repositories?
|
||||
|
||||
SCM-Manager stores the complete data in a directory called .scm (the
|
||||
SCM-Manager home directory). This directory is located in the home
|
||||
directory of the user which is the owner of the process. Except for [rpm
|
||||
and deb](RPM%20and%20DEB%20packages.md)
|
||||
installations, for those installations the home directory is located at
|
||||
/var/lib/scm.
|
||||
All data which is created by SCM-Manager, is stored in the SCM-Manager base directory.
|
||||
The location of the base directory depends on your type of installation.
|
||||
Please have a look at the [documentation](../administration/basedirectory/).
|
||||
|
||||
### How can I change the SCM-Manager home directory?
|
||||
|
||||
You could change the SCM-Manager home directory in a few ways:
|
||||
|
||||
- Edit the scm.properties (WEB-INF/classes) file and add the path to
|
||||
your folder f.e. `scm.home=/var/scm`
|
||||
- Set an environment variable SCM\_HOME with the path of your
|
||||
directory
|
||||
- Start your application server with a java property called `scm.home`
|
||||
f.e. `-Dscm.home=/var/scm`
|
||||
|
||||
### Can I create a directory structure for scm-manager repositories?
|
||||
|
||||
Yes, since version 1.9 you can create directory structures. You can just
|
||||
use a \"/\" in the name of the repository to create the structure. For
|
||||
example the repositories Project/module-1, Project/module-2 and
|
||||
OtherProject/module-1 will result in the following structure.
|
||||
|
||||
```text
|
||||
+ Project
|
||||
| - module-1
|
||||
| - module-2
|
||||
+ OtherProject
|
||||
| - module-1
|
||||
```
|
||||
|
||||
For more information have a look at [#47](https://github.com/scm-manager/scm-manager/issues/47 "Support for directory structure").
|
||||
|
||||
### After creation of a new public repository I am trying to clone it anonymously, but I got request of user and password. What am I doing wrong?
|
||||
|
||||
You have to enable \"Allow Anonymous Access\" at Config-\>General.
|
||||
There are several ways to change the location of the home directory: [documentation](../administration/basedirectory/#change-base-directory-location)
|
||||
|
||||
### Where does SCM-Manager stores it log files?
|
||||
|
||||
SCM-Manager stores the log files in a directory called \"logs\" which is
|
||||
located in the home directory (see question \"Where does SCM-Manager
|
||||
store its configuration, log files and the repositories?\").
|
||||
The location of the log files depends on your operation system and the type of installation.
|
||||
Please have a look at the [documentation](../administration/logging/).
|
||||
|
||||
### How do I enable trace logging?
|
||||
|
||||
Edit scm-server/conf/logging.xml change the line from:
|
||||
Find the location of your `logging.xml` in the [documentation](../administration/logging/#configuration) and change the following line from:
|
||||
|
||||
```xml
|
||||
<logger name="sonia.scm" level="INFO" />
|
||||
@@ -67,17 +35,8 @@ to:
|
||||
<logger name="sonia.scm" level="TRACE" />
|
||||
```
|
||||
|
||||
If you are using the war version with an application server such as
|
||||
tomcat, you have to edit the logback.xml in WEB-INF/classes.
|
||||
After changing the configuration, SCM-Manager must be restarted.
|
||||
|
||||
### How do I install plugins?
|
||||
|
||||
Select Config-\>Plugins. This is supposed to show you a list of all
|
||||
available plugins to install. It is not a place to configure existing
|
||||
plugins. Install Package does not take you to the install screen\... If
|
||||
you only see the installed plugins, see the next question.
|
||||
|
||||
### Why don\'t I see any installable plugins on the plugin tab?
|
||||
|
||||
Is the SCM-Manager server behind a proxy server? Then you have to
|
||||
configure your proxyserver at Config-\>General.
|
||||
Find the plugin you like to install at [plugins](/plugins#categories) and follow the installation instructions on the install page of the plugin.
|
||||
|
||||
@@ -1,11 +1,14 @@
|
||||
---
|
||||
title: Documentation
|
||||
subtitle: SCM-Managert Documentation
|
||||
subtitle: SCM-Manager Documentation
|
||||
---
|
||||
This documentation describes the administration and usage of SCM-Manager. It is available in different languages and versions, which can be selected in the menu on the right.
|
||||
|
||||
This documentation describes the administration and usage of SCM-Manager.
|
||||
SCM-Manager 2 is an extremely lightweight source code management tool that can be individually extended through a variety of plugins.
|
||||
This documentation is divided into five categories:
|
||||
|
||||
## Version and language
|
||||
|
||||
The documentation belongs to a specific language and version of SCM-Manager.
|
||||
You can choose your version and language on the menu to the right.
|
||||
- The section "Getting started" introduces the installation and configuration of SCM-Manager and answers frequently asked questions.
|
||||
- The "Administration" area deals with issues that are important when operating an instance.
|
||||
- The rubric "Development" contains information for the further development of SCM-Manager. It describes how SCM-Manager can be built and what needs to be considered.
|
||||
- The area of "Plugin Development" focuses on the process of plugin development.
|
||||
- "User-oriented" summarizes the features from the user's point of view in the basic version with the minimal set of plugins. The features of the optional plugins are introduced in separate documentations.
|
||||
|
||||
@@ -43,6 +43,24 @@ If you want to use the ssh plugin, keep in mind that this plugin requires an ext
|
||||
docker run --name scm -p 2222:2222 -p 8080:8080 -v scm-home:/var/lib/scm scmmanager/scm-manager:<version>
|
||||
```
|
||||
|
||||
## JVM Parameters
|
||||
|
||||
If it becomes necessary to add JVM parameters to the start, there are two ways to do this:
|
||||
|
||||
* As arguments e.g.:
|
||||
|
||||
```bash
|
||||
docker run scmmanager/scm-manager:<version> -Dsome.property=value
|
||||
```
|
||||
|
||||
* Or as JAVA_OPTS environment variable e.g.:
|
||||
|
||||
```bash
|
||||
docker run -e JAVA_OPTS="-Dsome.property=value" scmmanager/scm-manager:<version>
|
||||
|
||||
```
|
||||
|
||||
|
||||
## Docker Compose
|
||||
|
||||
If you want to use the image with docker-compose have a look at the example below.
|
||||
|
||||
@@ -60,6 +60,12 @@ The default username is `scmadmin` with the password `scmadmin`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Upgrade from SCM-Manager 1.x
|
||||
|
||||
If you had an SCM-Manager 1.x installed before, please remove (or better back up) the old `/opt/scm-server` directory. This must not exist before installing the new 2.x version.
|
||||
|
||||
### Service does not start
|
||||
|
||||
If the service does not start have a look at the systemd journal:
|
||||
|
||||
```bash
|
||||
|
||||
|
Before Width: | Height: | Size: 313 KiB After Width: | Height: | Size: 313 KiB |
@@ -23,7 +23,7 @@ To specify the new names (and namespaces), the SCM-Manager version 2 starts a mi
|
||||
|
||||
You can open this wizard in an internet browser using the URL of your installation (eg. http://localhost:8080/scm/).
|
||||
|
||||

|
||||

|
||||
|
||||
In the figure you can see an example of the page. We tried to guess meaningful names, but for sure you want to make some changes here. Beside choosing new namespaces and names you have to select a migration strategy for each repository. The strategies are described on the page as follows:
|
||||
|
||||
@@ -1,27 +1,35 @@
|
||||
- section: Getting started
|
||||
entries:
|
||||
- /installation/
|
||||
- /configuration/
|
||||
- /migrate-scm-manager-from-v1/
|
||||
- /faq/
|
||||
- /known-issues/
|
||||
|
||||
- section: User-oriented
|
||||
entries:
|
||||
- /user/repo/
|
||||
- /user/user/
|
||||
- /user/group/
|
||||
- /user/admin/
|
||||
|
||||
- section: Administration
|
||||
entries:
|
||||
- /administration/scm-server-ssl/
|
||||
- /administration/logging/
|
||||
- /administration/command-line-client/
|
||||
- /administration/basedirectory/
|
||||
- /administration/logging/
|
||||
- /administration/scm-server-ssl/
|
||||
- /administration/reverse-proxies/
|
||||
|
||||
- section: Development
|
||||
entries:
|
||||
- /development/intellij-idea-configuration/
|
||||
- /development/build-from-source/
|
||||
- /development/ui-common-pitfall/
|
||||
- /administration/permission-concept/
|
||||
- /development/permission-concept/
|
||||
- /development/error-handling/
|
||||
- /development/i18n/
|
||||
- /development/definition-of-done/
|
||||
- /development/ui-dod/
|
||||
- /development/decision-table/
|
||||
|
||||
- section: Plugin Development
|
||||
entries:
|
||||
|
||||
@@ -8,7 +8,15 @@ To release a new version of SCM-Manager v2 you have to do the following steps (r
|
||||
Make sure you have no changes you want to keep!
|
||||
|
||||
```
|
||||
git fetch && git checkout develop && git reset --hard origin/develop
|
||||
git fetch && git checkout -f origin/develop && git clean -fd && git checkout -B develop
|
||||
```
|
||||
|
||||
## Merge support branch
|
||||
|
||||
Check whether there is an integration branch for the previous release or bugfixes not merged into the develop branch. Merge them now.
|
||||
|
||||
```
|
||||
git merge origin/support/<support branch>
|
||||
```
|
||||
|
||||
## Modify Changelog
|
||||
@@ -51,7 +59,15 @@ To release a new version of a Plugin for SCM-Manager v2 you have to do the follo
|
||||
Make sure you have no changes you want to keep!
|
||||
|
||||
```
|
||||
git fetch && git checkout develop && git reset --hard origin/develop
|
||||
git fetch && git checkout -f origin/develop && git clean -fd && git checkout -B develop
|
||||
```
|
||||
|
||||
## Merge support branch
|
||||
|
||||
Check whether there is an integration branch for the previous release or bugfixes not merged into the develop branch. Merge them now.
|
||||
|
||||
```
|
||||
git merge origin/support/<support branch>
|
||||
```
|
||||
|
||||
## Update SCM parent if necessary
|
||||
@@ -61,40 +77,32 @@ If you need to update the parent of the plugin to a new release of SCM-Manager,
|
||||
- `pom.xml`: `parent.version`
|
||||
- `package.json`: `dependencies.ui-plugins`
|
||||
|
||||
```
|
||||
rm -rf node_modules yarn.lock
|
||||
mvn clean install
|
||||
git add yarn.lock pom.xml package.json
|
||||
git commit -m "Update to new version of SCM-Manager"
|
||||
git push
|
||||
```
|
||||
|
||||
## Plugin dependencies
|
||||
|
||||
Check if all plugin dependencies are proper versions and not SNAPSHOT!
|
||||
|
||||
## Build, commit and push
|
||||
|
||||
```
|
||||
rm -rf node_modules yarn.lock && mvn clean install \
|
||||
&& git add yarn.lock pom.xml package.json \
|
||||
&& git commit -m "Update to new version of SCM-Manager" \
|
||||
&& git push origin develop
|
||||
```
|
||||
|
||||
Wait for Jenkins to be green.
|
||||
|
||||
## Create release branch
|
||||
|
||||
```
|
||||
git checkout -b release/<version>
|
||||
```
|
||||
|
||||
## Modify Changelog
|
||||
|
||||
Change "Unreleased" header in `CHANGELOG.md` to `<version> - <current date>`
|
||||
|
||||
## Commit and push release
|
||||
## Create, commit and push release branch
|
||||
|
||||
```
|
||||
git commit -am "Prepare release of <version>"
|
||||
```
|
||||
|
||||
## Push release branch
|
||||
|
||||
```
|
||||
git push origin release/<version>
|
||||
export VERSION=<version> \
|
||||
&& git checkout -b release/$VERSION \
|
||||
&& git commit -am "Prepare release of $VERSION" \
|
||||
&& git push origin release/$VERSION
|
||||
```
|
||||
|
||||
## Wait for Jenkins build
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
---
|
||||
title: Revision Control Plugin Comparison
|
||||
---
|
||||
|
||||
| Plugin Name | Name | Core-Plugin | Requirements | Url |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| scm-svn-plugin | Subversion | X | | <http://subversion.apache.org> |
|
||||
| scm-git-plugin | Git | X | | <http://git-scm.com> |
|
||||
| scm-hg-plugin | Mercurial | X | [Python (v.2.6)](http://www.python.org/getit/releases/2.6), Mercurial | <https://www.mercurial-scm.org/> |
|
||||
| scm-bzr-plugin | Bazaar | | Python, Bazaar | <http://bazaar.canonical.com> |
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
title: State of SCM-Manager 2 development
|
||||
---
|
||||
|
||||
The development of SCM-Manager 2.0.0 is organised in [Trello Boards](https://trello.com/scmmanager).
|
||||
|
||||
## [Milestone 1](https://trello.com/b/oit1MD92/scm-manager-2-0-0-milestone-1)
|
||||
|
||||
### Main goals
|
||||
* remove deprecated and unused stuff
|
||||
* remove old style listeners
|
||||
* replace [guava eventbus](https://code.google.com/p/guava-libraries/wiki/EventBusExplained) with [legman](https://github.com/sdorra/legman)
|
||||
* introduce new plugin structure
|
||||
* offline plugin installation/updates/deinstallation
|
||||
* use java 7 as default
|
||||
* use of [annotation processors](http://docs.oracle.com/javase/7/docs/api/javax/annotation/processing/Processor.html) instead of classpath scanning
|
||||
* move non core modules (plugin-backend, maven plugins, etc.) to separate repositories
|
||||
|
||||
## [Milestone 2](https://trello.com/b/Afb3hoJ9/scm-manager-2-0-0-milestone-2)
|
||||
|
||||
### Main goals
|
||||
* use [apache shiro](http://shiro.apache.org/) everywhere
|
||||
* improve authentication
|
||||
* improve user and group management
|
||||
* use permission instead of roles
|
||||
|
||||
## [Milestone 3](https://trello.com/b/eLvqTGGe/scm-manager-2-0-0-milestone-3)
|
||||
|
||||
### Main goals
|
||||
* completely new designed rest api
|
||||
|
||||
## Milestone 4
|
||||
|
||||
### Main goals
|
||||
* completely new user interface
|
||||
|
||||
## Milestone 5
|
||||
|
||||
### Main goals
|
||||
* improve repository api
|
||||
BIN
docs/en/user/admin/assets/administration-information.png
Normal file
|
After Width: | Height: | Size: 194 KiB |
BIN
docs/en/user/admin/assets/administration-permissionRoles.png
Normal file
|
After Width: | Height: | Size: 158 KiB |
BIN
docs/en/user/admin/assets/administration-plugins-available.png
Normal file
|
After Width: | Height: | Size: 180 KiB |
BIN
docs/en/user/admin/assets/administration-plugins-installed.png
Normal file
|
After Width: | Height: | Size: 186 KiB |
BIN
docs/en/user/admin/assets/administration-settings-general.png
Normal file
|
After Width: | Height: | Size: 182 KiB |
14
docs/en/user/admin/index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Administration
|
||||
partiallyActive: true
|
||||
---
|
||||
The SCM-Manager instance can be administered in the Administration area. From here, plugins can be managed, permission roles can be defined and adjusted, and settings can be made.
|
||||
|
||||
* [Plugins](plugins/)
|
||||
* [Permission Roles](roles/)
|
||||
* [Settings](settings/)
|
||||
|
||||
### Information
|
||||
On the information page in the administration area you can find the version of your SCM-Manager instance and helpful links to get in touch with the SCM-Manager support team.
|
||||
|
||||

|
||||
19
docs/en/user/admin/plugins.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Administration
|
||||
subtitle: Plugins
|
||||
---
|
||||
In the plugins section, plugins for SCM-Manager can be managed with the help of the external plugin center. Plugins are distinguished between installed and available plugins and are grouped based on their main functionality like for example workflow or authentication.
|
||||
|
||||
Plugins can be managed by functionality icons on the tiles. System relevant plugins that come with SCM-Manager by default cannot be deinstalled or updated.
|
||||
|
||||
In order for changes to plugins to become effective, the SCM-Manager server needs to be restarted. That can be done after every single action. It is also possible to queue several actions like the installation of a new plugin, updates or the deletion of a plugin and to perform all actions with one restart. If an action (installation, deinstallation, update) for a plugin was performed, the buttons "Execute changes" and "Abort changes" appear. If you choose to execute the changes, a popup window that shows the current queue (all actions without a restart) appears. Now the user can decide whether to execute the changes by restarting the server. If there are actions in the queue that are no longer desired, the queue can be emptied with the about changes button.
|
||||
|
||||
### Installed
|
||||
The overview for installed plugins shows all plugins that are currently installed on the SCM-Manager instance. Plugins that are optional can be deinstalled or updated here.
|
||||
|
||||

|
||||
|
||||
### Available
|
||||
The overview of all available plugins shows all plugins that are compatible with the current version of the SCM-Manager instance that are available through the SCM-plugin-center. The plugins can be downloaded by clicking on the icon and will be installed after a restart of the SCM-Manager server.
|
||||
|
||||

|
||||
11
docs/en/user/admin/roles.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Administration
|
||||
subtitle: Permission Roles
|
||||
---
|
||||
The page "Permission Roles" can be used to create profiles with certain permissions. Each role gets a name and a set of permissions. Roles can be assigned to users and groups for repositories.
|
||||
|
||||
There are a few predefined system roles which cannot be changed or deleted.
|
||||
|
||||
By clicking on a role you can see the information about it and which permissions the role has. User-defined roles can be edited or deleted at any time.
|
||||
|
||||

|
||||
59
docs/en/user/admin/settings.md
Normal file
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Administration
|
||||
subtitle: Settings
|
||||
displayToc: true
|
||||
---
|
||||
The settings area is where the global configuration of SCM-Manager happens. Many SCM-Manager plugins that need some kind of configuration get an area in the settings. This makes it maximally configurable if required.
|
||||
|
||||
### General
|
||||
#### Realm Description
|
||||
The field "Realm Description" is used to set the authentication realm for logins with basic authentication.
|
||||
|
||||
#### Namespace Strategy
|
||||
SCM-Manager groups repositories by namespaces. This grouping can be based on different strategies:
|
||||
|
||||
* Username: The username of the user that creates the repository is used.
|
||||
* Current year: The current year is used.
|
||||
* Repository type: The type (Git, HG, SVN) is used.
|
||||
* Custom: The namespace can be freely set when creating the repository.
|
||||
|
||||
#### Login Info URL
|
||||
The login screen of SCM-Manager shows helpful plugins and features. If you want to show your own information in the login screen, you can change the URL here.
|
||||
|
||||
#### Enable XSRF Protection
|
||||
Activate this option to make attacks using cross site scripting (XSS / XSRF) on SCM-Manager more difficult. This feature is still in an experimental state.
|
||||
|
||||
#### Plugin Center URL
|
||||
A plugin center can be used to conveniently manage plugins. If you want to use a plugin center that is not the default one, you only have to change this URL. If SCM-Manager is operated as part of a Cloudogu EcoSystem, the plugin center URL can be changed in the etcd.
|
||||
|
||||
#### Enable Anonymous Access
|
||||
In SCM-Manager 2 the access for anonymous access is realized by using an "_anonymous" user. When the feature is activated, a new user with the name "_anonymous" is created. This user can be authorized just like any other user. This user is used for access to SCM-Manager without login credentials (this does not apply to access via web UI).
|
||||
|
||||
Example: If anonymous access is enabled and the "_anonymous" user has full access on a certain Git repository, everybody can access this repository via command line and the classic Git commands without any login credentials. Access via SSH is not supported at this time.
|
||||
|
||||
#### Login Attempt Limit
|
||||
It can be configured how many failed login attempts a user can have before the account gets disabled. The counter for failed login attempts is reset after a successful login. This feature can be deactivated by setting the value "-1".
|
||||
|
||||
#### Login Attempt Limit Timeout
|
||||
If the deactivation of accounts after too many unsuccessful login attempts is activated. This timeout can be used to set for how long accounts will be disabled.
|
||||
|
||||
#### Base URL
|
||||
The base URL represents the URL that a SCM-Manager instance is available at. The checkbox "Force Base URL" can be used to force redirects to the base URL. If activated, access to this application through different URLs are redirected to the base URL.
|
||||
|
||||
Example: The base URL is www.scm.manager.com/scm but there is a second URL www.scm-manager.io/scm. Both URLs point to the same SCM-Manager instance. If the redirect to the base URL is forced, access via www.scm-manager.io/scm is redirected directly to www.scm-manager.com/scm.
|
||||
|
||||
**Warning:** If the base URL is set to a faulty value and "Force Base URL" is activated, the SCM-Manager instance is no longer accessible.
|
||||
|
||||
#### Proxy Settings
|
||||
If the SCM-Manager instance is behind a proxy server, the connection can be configured here.
|
||||
|
||||

|
||||
|
||||
### Mercurial
|
||||
The global settings for the source code management tool "Mercurial", hg for short, can be configured here.
|
||||
|
||||
### Git
|
||||
The global settings for the source code management tool "Git", can be configured here.
|
||||
|
||||
### Subversion
|
||||
The global settings for the source code management tool "Subversion", svn for short, can be configured here.
|
||||
BIN
docs/en/user/group/assets/create-group.png
Normal file
|
After Width: | Height: | Size: 151 KiB |
BIN
docs/en/user/group/assets/external-cas-group.png
Normal file
|
After Width: | Height: | Size: 146 KiB |
BIN
docs/en/user/group/assets/groups-information.png
Normal file
|
After Width: | Height: | Size: 148 KiB |
BIN
docs/en/user/group/assets/groups-overview.png
Normal file
|
After Width: | Height: | Size: 154 KiB |
BIN
docs/en/user/group/assets/groups-settings-general.png
Normal file
|
After Width: | Height: | Size: 153 KiB |
BIN
docs/en/user/group/assets/groups-settings-permissions.png
Normal file
|
After Width: | Height: | Size: 187 KiB |