mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-11-10 07:25:44 +01:00
Structure navigation
This commit is contained in:
René Pfeuffer
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: SCM-Server and Apache mod\_jk
|
||||
title: SCM-Server and Apache mod_jk
|
||||
---
|
||||
|
||||
### Apache Configuration
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: SCM-Server and Apache mod\_proxy
|
||||
title: SCM-Server and Apache mod_proxy
|
||||
---
|
||||
|
||||
### Apache configuration
|
||||
|
||||
@@ -4,3 +4,6 @@ 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,7 +0,0 @@
|
||||
---
|
||||
title: Create a new plugin
|
||||
---
|
||||
|
||||
There is a service which is able to create a skeleton for a new plugin:
|
||||
|
||||
https://create-plugin.scm-manager.org/
|
||||
@@ -13,14 +13,9 @@ Be sure you have installed the following software:
|
||||
|
||||
# Create the plugin structure
|
||||
|
||||
Use the scm-manager plugin [archetype](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)
|
||||
to create the plugin structure.
|
||||
There is a service which is able to create a skeleton for a new plugin:
|
||||
|
||||
```bash
|
||||
mvn archetype:...
|
||||
```
|
||||
|
||||
Answer the questions of the archetype.
|
||||
https://create-plugin.scm-manager.org/
|
||||
|
||||
# Implement your plugin
|
||||
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: Plugin Creation
|
||||
---
|
||||
|
||||
### Software Requirements
|
||||
|
||||
- JDK 1.7 or higher
|
||||
([download](http://www.oracle.com/technetwork/java/index.html))
|
||||
- Maven 3 or higher ([download](http://maven.apache.org/))
|
||||
|
||||
### Create plugin
|
||||
|
||||
```bash
|
||||
mvn archetype:generate\
|
||||
-DarchetypeGroupId=sonia.scm.maven\
|
||||
-DarchetypeArtifactId=scm-plugin-archetype\
|
||||
-DarchetypeVersion=1.60\
|
||||
-DarchetypeRepository=http://maven.scm-manager.org/nexus/content/groups/public/
|
||||
```
|
||||
### Test the plugin
|
||||
|
||||
```bash
|
||||
mvn scmp:run
|
||||
```
|
||||
|
||||
### Samples
|
||||
|
||||
- [Hello World](https://bitbucket.org/sdorra/scm-manager/src/1.x/scm-samples/scm-sample-hello/)
|
||||
- [Authentication Plugin](https://bitbucket.org/sdorra/scm-manager/src/1.x/scm-samples/scm-sample-auth/)
|
||||
|
||||
### Further reading
|
||||
|
||||
- [Injection framework - Google Guice](http://code.google.com/p/google-guice/)
|
||||
- [Restful WebService - Jersey](http://jersey.java.net/nonav/documentation/latest/user-guide.html)
|
||||
- [ XML transformation - JAXB](http://jaxb.java.net/guide/)
|
||||
- [User interface - Ext JS](http://www.sencha.com/products/extjs3/)
|
||||
|
||||
### Questions/Help
|
||||
|
||||
If you have questions or you need help, please write to the mailing
|
||||
list: <https://groups.google.com/forum/#!forum/scmmanager>
|
||||
12
docs/en/development/plugins/index.md
Normal file
12
docs/en/development/plugins/index.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Plugin Development
|
||||
partiallyActive: true
|
||||
---
|
||||
|
||||
- [Create a plugin](create/)
|
||||
- [Migrate a plugin from 1.x](migrate-plugin-from-v1/)
|
||||
- [Extension points](extension-points/)
|
||||
- [i18n](i18n-for-plugins/)
|
||||
- [Plugin descriptor](plugin-descriptor/)
|
||||
- [Development](plugin-development/)
|
||||
- [How to publish](publish/)
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Migrate an v1 plugin
|
||||
title: Migrate a v1 plugin
|
||||
---
|
||||
|
||||
Before starting, make sure to read the [Plugin Development](docs/en/plugin-development.mdpment.md).
|
||||
@@ -168,6 +168,6 @@ Some more hints:
|
||||
|
||||
# Further reading
|
||||
|
||||
* [scm-manager/ui-extensions README](../../scm-ui/ui-extensions/README.md) - Extension Points within SCM-Manager
|
||||
* [scm-manager/ui-extensions README](scm-ui/ui-extensions/README.md) - Extension Points within SCM-Manager
|
||||
* [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
|
||||
@@ -5,9 +5,9 @@ subtitle: Publish your Plugin
|
||||
|
||||
If you want to share your plugin with SCM-Manager users, you can publish it to the SCM-Manager Plugin Center by following the steps below.
|
||||
|
||||
* Create a Mercurial or Git repository for your plugin
|
||||
* Develop your plugin as described in [Create a plugin](/docs/create)
|
||||
* Fork the [Plugin Center Repository](https://bitbucket.org/scm-manager/plugin-center)
|
||||
* 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.:
|
||||
|
||||
@@ -27,11 +27,11 @@ author: Cloudogu GmbH
|
||||
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://bitbucket.org/scm-manager/) and give your account write permissions
|
||||
* 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/)
|
||||
* At the end we will accept your pull request
|
||||
|
||||
From now on you can work with the repository in the [SCM-Manager Team](https://bitbucket.org/scm-manager/).
|
||||
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.
|
||||
|
||||
|
||||
|
||||
@@ -1,83 +0,0 @@
|
||||
---
|
||||
title: 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
|
||||
[here](http://www.scm-manager.org/download/), unpack the .zip
|
||||
or .tar.gz package and start SCM-Manager 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-rc6
|
||||
```
|
||||
|
||||
### First access
|
||||
|
||||
Your SCM-Manager should be running on port 8080. You can access it locally via <http://localhost:8080>.
|
||||
|
||||
| | |
|
||||
| ------------ | ----------------------- |
|
||||
| **URL** | <http://localhost:8080> |
|
||||
| **Username** | scmadmin |
|
||||
| **Password** | scmadmin |
|
||||
|
||||
### Mercurial
|
||||
|
||||
Subversion and Git will work out of the box, but if you want to use
|
||||
mercurial with SCM-Manager you have to install mercurial version
|
||||
**1.9** or newer.
|
||||
|
||||
#### Mercurial on Windows
|
||||
|
||||
The installation of mercurial for SCM-Manager is very complicated on
|
||||
windows, have a look at:
|
||||
|
||||
- [#1](https://bitbucket.org/sdorra/scm-manager/issues/1/no-ability-to-rename-repository)
|
||||
- [xeFcruG70s8J](https://groups.google.com/d/msg/scmmanager/zOigMIn2RiE/xeFcruG70s8J "Python/Hg Package Build Process")
|
||||
- [build-win-hg-packages](https://bitbucket.org/sdorra/build-win-hg-packages)
|
||||
|
||||
SCM-Manager comes with the option to install packages for windows to
|
||||
simplify this setup. To use such a package just login as Administrator,
|
||||
goto \"Repository Types\", click the \"Start Configuration Wizard\" and
|
||||
Choose \"Download and install\".
|
||||
|
||||
If you see an error like the following:
|
||||
|
||||
```text
|
||||
sonia.scm.repository.RepositoryException: command exit with error 14001 and message: 'The application has failed to start because its side-by-side configuration is incorrect. Please see the application event log or use the command-line sxstrace.exe tool for more detail.'
|
||||
```
|
||||
|
||||
Then you have to install [Microsoft Visual C++ 2008 SP1 Redistributable Package
|
||||
(x86)](http://www.microsoft.com/en-us/download/details.aspx?id=5582).
|
||||
Note you have to use the x86 package and not the x64 package, because we
|
||||
use 32bit python in SCM-Manager on Windows. For more informations have a
|
||||
look at
|
||||
[#522](https://bitbucket.org/sdorra/scm-manager/issue/552/hg-repo-creation-failed).
|
||||
@@ -3,7 +3,6 @@
|
||||
- /installation/
|
||||
- /configuration/
|
||||
- /migrate-scm-manager-from-v1/
|
||||
- /migrate-plugin-from-v1/
|
||||
- /faq/
|
||||
- /known-issues/
|
||||
|
||||
@@ -16,5 +15,11 @@
|
||||
|
||||
- section: Development
|
||||
entries:
|
||||
- /development/plugins
|
||||
- /development/intellij-idea-configuration/
|
||||
- /development/build-from-source/
|
||||
- /development/common-pitfall/
|
||||
- /development/error-handling/
|
||||
- /development/i18n/
|
||||
- /development/definition-of-done/
|
||||
- /development/ui-dod/
|
||||
- /development/plugins/
|
||||
|
||||
Reference in New Issue
Block a user