1 | # Installation
|
---|
2 |
|
---|
3 | This extension can be added to Greenstone3 by running
|
---|
4 |
|
---|
5 | cd web
|
---|
6 | ./INSTALL.sh
|
---|
7 | cd ..
|
---|
8 |
|
---|
9 |
|
---|
10 | # Compilation
|
---|
11 |
|
---|
12 | The extension ships with a ready-to-go JAR/WAR file, and so no
|
---|
13 | compilation is actually needed to install and use webswing
|
---|
14 |
|
---|
15 | However, if you do want to compile up theextension, then you need
|
---|
16 | Maven and NodeJS installed.
|
---|
17 |
|
---|
18 | For example, using version of these command-line tools that are known
|
---|
19 | to work:
|
---|
20 |
|
---|
21 | #
|
---|
22 | # Assuming
|
---|
23 | # ./get-selfcontained-jdk.sh
|
---|
24 | # already done, then ...
|
---|
25 | #
|
---|
26 | # One time only setup
|
---|
27 | #
|
---|
28 | pushd ../../ext-cli
|
---|
29 | ./get-selfcontained-mvn.sh
|
---|
30 | ./get-selfcontained-nodejs.sh
|
---|
31 | popd
|
---|
32 |
|
---|
33 | #
|
---|
34 | # When starting a new terminal
|
---|
35 | #
|
---|
36 | pushd ../..
|
---|
37 | . ./gs3-setup-cli.sh
|
---|
38 | popd
|
---|
39 |
|
---|
40 |
|
---|
41 | # Troubleshooting
|
---|
42 |
|
---|
43 | 1. JDK -- JAVA_HOME
|
---|
44 |
|
---|
45 | One of the 'mvn' tasks was found to need JAVA_HOME set. If using
|
---|
46 | ./get-selfcontained-jdk.sh to provide java/javac, then this is set for
|
---|
47 | you.
|
---|
48 |
|
---|
49 |
|
---|
50 | 2. Gnome/Freedesktop/XDG 'trash' command-line utility
|
---|
51 |
|
---|
52 | If you are compiling this up outside of your home directory (say
|
---|
53 | /opt/greenstone3-svn/ext/webswing) then you will need a a directory:
|
---|
54 |
|
---|
55 | /.Trash-$UID
|
---|
56 |
|
---|
57 | for the 'trash' command-line utility to function correctly.
|
---|
58 |
|
---|
59 | When the issue was enounctered, the particular trash folder that
|
---|
60 | yielded the error was:
|
---|
61 |
|
---|
62 | /.Trash-1000
|
---|
63 |
|
---|
64 | Explaniation: For one of the mvn stages for compiling, it looks to run
|
---|
65 | a npm 'clean' target, before compiling. The clean target uses
|
---|
66 | 'trash', which (if things have previously been run) there there is a
|
---|
67 | directory that needs to be moved to its 'trash folder'. When running
|
---|
68 | in a disk partition that does not contian your /home/<username>
|
---|
69 | account, then the XDG specification specifies this to be /.Trash-$UID
|
---|
70 |
|
---|
71 |
|
---|
72 |
|
---|
73 |
|
---|
74 |
|
---|
75 |
|
---|