Wiki source code of Fill a local Maven repository with the default user interface extensions
Last modified by Clemens Robbenhaar on 2018/07/16
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
3.1 | 1 | {{warning}} |
| 2 | This should only be used if the server in which to install XWiki has no network access, and no other means to install the user interface is available. | ||
 |
1.1 | 3 | {{/warning}} |
| 4 | |||
| |
4.1 | 5 | {{error}} |
| 6 | This only works if you want to install extensions via the extension manager, and you know how to use the "extended search". It will not work when installing the main UI with the Distribution wizard, as it will not find the available flavors. For this, you must use an alternative method, like the [[XIP package>>doc:Documentation.AdminGuide.Installation.||anchor="HXIPpackage"]]. | ||
| 7 | {{/error}} | ||
| 8 | |||
| |
1.1 | 9 | === Prerequisites === |
| |
3.1 | 10 | |
| |
1.1 | 11 | * a staging / development server which has access to the internet, to collect the necessary resources from there |
| 12 | * a minimal development environment on the staging server including the ##mvn## tool, as if you want to [[build XWiki from Source>>doc:dev:Community.Building]] | ||
| 13 | * a way to copy the resources from the staging to the production server | ||
| 14 | * write access to the ##xwiki.properties## on the server | ||
| 15 | |||
| 16 | === Download the UI resources === | ||
| 17 | |||
| 18 | First make sure that you have the right ##settings.xml## on the staging server, which has the XWiki repositories enabled. | ||
| 19 | You also might want to move away your current ##$HOME/.m2/repository## temporarily to mimimize the amount of files to be transferred to production later. | ||
| 20 | |||
| 21 | Create an empty directory and place the following file as ##pom.xml## in it: | ||
| 22 | |||
| 23 | {{code}} | ||
| 24 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> | ||
| 25 | <modelVersion>4.0.0</modelVersion> | ||
| 26 | <parent> | ||
| 27 | <groupId>org.xwiki.commons</groupId> | ||
| 28 | <artifactId>xwiki-commons-pom</artifactId> | ||
| 29 | <version>7.4</version> | ||
| 30 | </parent> | ||
| 31 | <groupId>never-mind</groupId> | ||
| 32 | <artifactId>never-mind</artifactId> | ||
| 33 | <version>0.0</version> | ||
| 34 | <name>dummy download package</name> | ||
| 35 | <packaging>pom</packaging> | ||
| 36 | <dependencies> | ||
| 37 | <dependency> | ||
| 38 | <groupId>org.xwiki.enterprise</groupId> | ||
| 39 | <artifactId>xwiki-enterprise-ui-mainwiki</artifactId> | ||
| 40 | <version>7.4</version> | ||
| 41 | <type>xar</type> | ||
| 42 | </dependency> | ||
| |
4.1 | 43 | [... add the extensions that you want to install here ...] |
| |
1.1 | 44 | </dependencies> |
| 45 | </project> | ||
| 46 | {{/code}} | ||
| 47 | |||
| 48 | Make sure to update the version numbers (here ##7.4##) in both the ##<parent>## and the ##<dependencies>##. | ||
| 49 | |||
| 50 | Open a command line, change to the directory created in the previous step and issue the command: | ||
| 51 | |||
| |
3.1 | 52 | {{code}} |
| 53 | mvn clean org.apache.maven.plugins:maven-dependency-plugin:go-offline | ||
| 54 | {{/code}} | ||
| |
1.1 | 55 | |
| |
2.1 | 56 | This should download all the required resources and dependencies. |
| |
1.1 | 57 | |
| 58 | === Install the resources on the server === | ||
| 59 | |||
| |
3.1 | 60 | As the next step, copy the complete ##/.m2/repository## to a directory on the production server where the user running the XWiki webapp can read it. |
| 61 | (**TODO:** figure out if only parts of the directory are sufficient, i.e. ##/.m2/repository/org/xwiki##) | ||
| |
1.1 | 62 | |
| 63 | Configure in the ##xwiki.properties## the destination directory on the server as the "main xwiki" repository: | ||
| 64 | |||
| 65 | {{code}} | ||
| 66 | extension.repositories=maven-xwiki:maven:file:/path/to/copy/of/the/.m2/repository | ||
| 67 | {{/code}} | ||
| 68 | |||
| |
4.1 | 69 | You now can install the extension offline by typing in the ##groupId:artifactId## as extension id (e.g. ##org.xwiki.contrib:xwiki-application-admintools## for the [[Admin Tools Application>>doc:extensions:Extension.Admin Tools Application]] and then the version number. (Searching for the extension by name will not work, because a file system maven repo does not support this.) |
