Page History

...

The modern web technologies that power Mirage 2 include a precompiler (Compass), a package manager (Bower) and a task runner (Grunt). These tools can only be installed when some prerequisites are present on the system. DSpace's Maven build process is capable of making a temporary installation of these dependencies just so the theme can be built. However the overall build time will be significantly shortened if these dependencies are manually installed on the system (see below for more info).

All of the Mirage 2 builds require git. Make sure to install git before starting any of the Mirage 2 builds.

• By default, DSpace does not build the Mirage 2 theme (as it lengthens the normal build process).  However, you can easily tell DSpace to build Mirage 2 by running the following from your [dspace-source] directory: 

  Code Block
  mvn package -Dmirage2.on=true

   

  • If you wish to speed up the Mirage 2 build process, you can do so by pre-installing all of the Mirage 2 dependencies on your system (by default they will be downloaded each time you rebuild Mirage 2).  This will significantly shorten the build process for Mirage 2.  More information on installing these prerequisites can be found in the Developer Documentation for Mirage 2.  Once these prerequisites have been installed on your local server, you can then build Mirage 2 more rapidly by running:
    

    Code Block
    # WARNING: This command will only work if you've manually installed *all* the prerequisites for Mirage 2 mvn package -Dmirage2.on=true -Dmirage2.deps.included=false

• After building Mirage 2, you can install this theme into your DSpace by simply re-running Ant from [dspace-source]/dspace/target/dspace-installer/ : 

  Code Block
  ant update

  
  

• To enable Mirage 2, add the following to the <themes> section of your xmlui.xconf, replacing the currently active theme: 

  Code Block
  <theme name="Mirage 2" regex=".*" path="Mirage2/" />

• Finally, restart your Tomcat or servlet container, and you should see the Mirage 2 theme.

...

• Running the Mirage 2 build (mvn package -Dmirage.on=true) as the "root" user (or via sudo) will result in the following error from "Bower". This will result in a broken Mirage 2 build. The fix is to ensure you are building DSpace as a non-root user account. For more information on this Bower error, see: http://serverfault.com/questions/548537/cant-get-bower-working-bower-esudo-cannot-be-run-with-sudo

  Code Block
  bower ESUDO Cannot be run with sudo   Additional error details: Since bower is a user command, there is no need to execute it with superuser permissions.

• The Mirage 2 build requires git. Ensure that git is installed before you launch the Mirage 2 build.

Configuration options

Mirage 2 adds two configuration options to dspace.cfg that affect the rendering of bitstream labels on item pages:

...