Skip to content

Installation instructions v 1.x

Jump to bottom
Anca Luca edited this page Aug 16, 2018 · 1 revision

The following installation instructions explain how to install the project from the code of this repository. This project is built to run on top of XWiki Standard , version 9.11.3 - see http://www.xwiki.org .

Build

Build the code of this repo using maven (set up as explained in http://dev.xwiki.org/xwiki/bin/view/Community/Building/#HInstallingMaven ), with

mvn clean install

then use the built artefacts to install as described under.

Installation

WAR setup

XWiki standard war, version 9.11.3, which can be downloaded from here: http://maven.xwiki.org/releases/org/xwiki/platform/xwiki-platform-web/9.11.3/ .

The following additional settings are required by the project:

  • Deploy XWiki to the webapps/ROOT instead of webapps/xwiki and modify WEB-INF/xwiki.cfg

    • Uncomment xwiki.webapppath=
    • Uncomment xwiki.defaultweb=Main
    • Configure xwiki.showviewaction=0
    • Configure xwiki.usepath=0
    • Configure xwiki.authentication.cookiedomains=wikidemarches.xwiki.com,jenotemademarche.gouv.fr
    • Install urlrewrite.xml in WEB-INF

  • Deploy xwiki-platform-legacy-oldcore-DINSICDEMA9.11.3-b55fe5c5c2fb453bb4154999f94de7e014b7fa58.jar as follows:

    • Checkout xwiki-platform-legacy-oldcore-DINSICDEMA9.11.3-b55fe5c5c2fb453bb4154999f94de7e014b7fa58.jar from the bin folder of the wikidemarches git repository
    • Copy and paste this jar into the WEB-INF/lib folder of the webapp
    • Remove xwiki-platform-legacy-oldcore-9.11.3.jar from the same folder
    • Restart the server (once the operation below is done as well)

  • Deploy the excel plugin in WEB-INF/lib as follows:

  • Deploy application publication jar in WEB-INF/lib, as follows:

    • Deploy the JAR built by the module application-publication/application-publication-api (version 1.0-SNAPSHOT) in WEB-INF/lib
    • make sure the server is restarted after this operation

Wikis (initial creation of wikis)

Main wiki

  • Install the XWiki Standard Flavor on the main wiki on first launch of the war. Create an administrator account called "Admin" during this installation.

Subwikis

Demat wiki

Create a new subwiki, with the following parameters:

  • Pretty name: Wiki Dématérialisation
  • Wiki id: wikidemat
  • Description: empty
  • Flavor / template: XWiki Standard Flavor Sub Wiki, v 9.11.3
  • Owner: the Admin user created during the creation of the main wiki
  • User scope: Only global users
  • Membership type: Only an admin can invite users
  • Members: empty
  • SSL: yes

Wikidemarches

Create a new subwiki, with the following parameters:

  • Pretty name: Wiki Démarches
  • Wiki id: wikidemarches
  • Description: empty
  • Flavor / template: XWiki Standard Flavor Sub Wiki, v 9.11.3
  • Owner: the Admin user created during the creation of the main wiki
  • User scope: Only global users
  • Membership type: Only an admin can invite users
  • Members: empty
  • SSL: yes

Wikis (installation of the project)

Main wiki

First install:

  • Using Administration->Content->Import, import the artifact xwiki-dinsic-wikidemarches-wikis-xwiki-<version>.xar

Wikidemat wiki

Required extensions (to install from Administration -> Extensions):

  • XWiki Livetable Excel Export Macro, version 2.0 (extension id: org.xwiki.contrib:xwiki-livetable-excel-export-macro)
  • Navigation block macro, version 1.0 (extension id: ludovic:navigation-block-macro)
  • UIN Script Service (for creating new identifiers from the Demarches creation form): org.xwiki.contrib:api-uin-scriptservice version 1.1
  • Job macro: org.xwiki.contrib:macro-job version 1.1.1
  • Cookie Disclaimer extension
  • Menu extension (don't use a global MenuMacro extension as the global wiki is not necessarily accessible with the same security level): flaviusolaru:navigation-menu-wiki-macro version 1.2
  • Menu application: org.xwiki.platform:xwiki-platform-menu-ui version 9.11.3

Deactivate Homepage Tour or it will issue an additional request on the home page.

Custom code

First install:

  • Using Administration->Content->Import, import the artifact xwiki-dinsic-wikidemarches-wikis-wikidemat-<version>.xar

Upgrade from a previous version of this project:

  • Using Administration->Content->Import, import the artifact xwiki-dinsic-wikidemarches-wikis-wikidemat-<version>.xar
  • Manually remove from the wiki the pages that were deleted from the repo since the last install

Wikidemarches wiki

  • XWiki Livetable Excel Export Macro, version 2.0 (extension id: org.xwiki.contrib:xwiki-livetable-excel-export-macro) TODO: check it's ok to let any user download the list of procedures (demarches)
  • UIN Script Service (for creating new Avis): org.xwiki.contrib:api-uin-scriptservice version 1.1
  • Open Sans font as webjar: Using advanced search, install the following extension org.webjars.bower:open-sans version 1.1.0
  • Query Generator and Query Macro, version 1.4.1 (extension id: org.xwiki.contrib:application-querygenerator )
    • edit rights on page Macros.QueryGenerator and give 'view' right only to Admin group (local admin group)
  • AppWithin Minutes Charts and Data, version 1.2.1 (extension id: org.xwiki.contrib:appwithinminutes-charts )
  • GitHub application, version 1.3.2 (extension id: org.xwiki.contrib:application-github-app)

Custom code

First install:

  • Delete the french translation of the Main.WebHome page, as follows:
    • Go to wiki administration
    • Enable multilanguage, setup english and french as available languages
    • Save
    • Go on the main page, in french language, and manually change the url the delete action URL with parameter ?language=fr (/xwiki/bin/delete/Main/WebHome?language=fr)
    • Confirm delete, accept to delete pages from default extensions
  • Using Administration->Content->Import, import the artifact xwiki-dinsic-wikidemarches-wikis-wikidemarches-<version>.xar

Upgrade from a previous version of this project:

  • Using Administration->Content->Import, import the artifact xwiki-dinsic-wikidemarches-wikis-wikidemarches-<version>.xar
  • Manually remove from the wiki the pages that were deleted from the repo since the last install
  • Check what's the biggest existing ID for Avis pages, and copy/paste that value to the UIN administration page.

Then see the data import instructions.

Clone this wiki locally