Wiki source code of Extension Repositories

Last modified by Thomas Mortagne on 2021/04/07 09:13

Show last authors
1 Extension Manager support the following repositories:
2
3 * [[Maven]]: generic Maven repositories
4 * [[XWiki]]: own XWiki repository REST API
5
6 Contrib connectors:
7
8 * [[Bintray>>doc:Extension.Extension Repository Connector - Bintray.WebHome]]: search and resolve extensions coming from Bintray repositories like [[JCenter>>https://bintray.com/bintray/jcenter]]
9 * [[PyPi>>doc:Extension.Extension Repository Connector - Pypi.WebHome]]: search, resolve and install Python extension located on https://pypi.org
10 * [[Npm registry>>doc:Extension.Extension Repository Connector - NPM.WebHome]]: search, resolve and install (as webjars) Javascript packages coming from https://www.npmjs.com
11
12 = Configuring Extension Repositories =
13
14 You can control the list of Repositories to use by setting the ##extension.repositories## property in your ##xwiki.properties## file. Here's the documentation you'll find when editing ##xwiki.properties##:
15
16 {{code language="properties"}}
17 #-# Repositories to use when searching and downloading extensions.
18 #-# Repositories will be checked in the same order they have in this configuration file.
19 #-#
20 #-# The format is <id>:<type>:<url> where
21 #-# * id can be anything as long as there is only one
22 #-# * type is the type of the repository (maven, xwiki, etc.)
23 #-# * url is the URL or the root of the repository
24 #-#
25 #-# [Since 4.3] It's also possible to associate various properties to each repository.
26 #-# Here are the standard properties:
27 #-# * user: the user to use to authenticate to the repository
28 #-# * password: the password to use to authenticate to the repository
29 #-#
30 #-# And here those for "maven" repositories:
31 #-# * [Since 10.7RC1] checksumPolicy: what to do when checksum validation fail. Possible values are "fail", "warn"
32 #-# (the default) and "ignore"
33 #-# * [Since 13.0RC1] http.headers: Custom HTTP headers to be used when connecting to the maven repository.
34 #-#
35 #-# Here is an example:
36 # extension.repositories = privatemavenid:maven:http://host.com/private/maven/
37 # extension.repositories.privatemavenid.auth.user = someuser
38 # extension.repositories.privatemavenid.auth.password = thepassword
39 # extension.repositories.privatemavenid.http.headers.headername = headervalue
40 #-#
41 #-# Here's an example to add your local Maven Repository
42 ## Note: Since this file is parsed by Velocity in the Maven Remote Resource plugin we need to escape the
43 ## Apache Commons Configuration syntax for specifying the user.home system property!
44 #set ($userHome = '${sys:user.home}')
45 # extension.repositories = maven-local:maven:file://${userHome}/.m2/repository
46 #-#
47 #-# And an example to add the XWiki Maven Snapshot Repository
48 # extension.repositories = maven-xwiki-snapshot:maven:https://nexus.xwiki.org/nexus/content/groups/public-snapshots
49 #-#
50 #-# When not set the following is taken (in this order):
51 # extension.repositories = maven-xwiki:maven:https://nexus.xwiki.org/nexus/content/groups/public
52 # extension.repositories = store.xwiki.com:xwiki:https://store.xwiki.com/xwiki/rest/
53 # extension.repositories = extensions.xwiki.org:xwiki:https://extensions.xwiki.org/xwiki/rest/
54 #-#
55 #-# To not have any repository enabled (including disabling default repositories) you can explicitly make this list
56 #-# empty:
57 # extension.repositories=
58 {{/code}}
59
60 If you have installed the [[Repository Application>>Extension.Repository Application]] and you wish to add it as a repository you'd add:
61
62 {{code language="properties"}}
63 extension.repositories=localxr:xwiki:http://localhost:8080/xwiki/rest/
64 {{/code}}
65
66 {{warning}}
67 If your wiki runs behind proxy server, you'd need to make additional configurations in order for extension manager to work properly as described in [[Installation Guide>>http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation#HRunningXWikibehindproxy-server]].
68 {{/warning}}

Get Connected