Skip to content

Commit ddbca8b

Browse files
authored
Merge pull request #1088 from dizzzz/improvements
[doc] basic-installation doc improvements
2 parents a48d589 + 3152e79 commit ddbca8b

File tree

5 files changed

+34
-53
lines changed

5 files changed

+34
-53
lines changed
-33.3 KB
Loading
272 KB
Loading
344 KB
Loading

src/main/xar-resources/data/basic-installation/basic-installation.xml

Lines changed: 31 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml-model href="http://docbook.org/xml/5.0/rng/docbook.rng"
22
schematypens="http://relaxng.org/ns/structure/1.0"?><?xml-model href="http://docbook.org/xml/5.0/rng/docbook.rng" type="application/xml"
33
schematypens="http://purl.oclc.org/dsdl/schematron"?>
4-
<article version="5.0" xmlns="http://docbook.org/ns/docbook"
5-
xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
65
<info>
76
<title>Basic Installation</title>
8-
<date>2Q19</date>
7+
<date>2Q25</date>
98
<keywordset>
109
<keyword>installation</keyword>
1110
<keyword>getting-started</keyword>
@@ -29,10 +28,11 @@
2928
<itemizedlist>
3029

3130
<listitem>
32-
<para>At least Java version 8 (since eXist-db 3.0)</para>
31+
<para>Java version 8 (eXist-db 3.x - 6.x)</para>
32+
<para>Java version 21 (eXist-db 7.x)</para>
3333
</listitem>
3434
<listitem>
35-
<para>About 200Mb of disk space for the installation</para>
35+
<para>About 500Mb of disk space for the installation</para>
3636
</listitem>
3737
<listitem>
3838
<para>At least 512Mb memory to run</para>
@@ -47,10 +47,8 @@
4747
<para>eXist-db is built on Java, a free, cross-platform software development
4848
environment. Java comes in a number of versions, so it is important that you use the
4949
version that eXist-db requires: Java 8 (since eXist-db 3.0). For instructions about
50-
running Java on your operating system, see Oracle's <link condition="_blank"
51-
xlink:href="https://www.java.com/en/download/help/index_installing.xml">Installing
52-
Java</link> page. <link condition="_blank" xlink:href="https://openjdk.java.net"
53-
>OpenJDK</link> is a good open source alternative to the Oracle JVM and known to
50+
running Java on your operating system, see Oracle's <link condition="_blank" xlink:href="https://www.java.com/en/download/help/index_installing.xml">Installing
51+
Java</link> page. <link condition="_blank" xlink:href="https://openjdk.java.net">OpenJDK</link> is a good open source alternative to the Oracle JVM and known to
5452
work well with eXist-db.</para>
5553
<para>eXist-db runs with both the Java JRE (Java Runtime Environment) and the JDK (Java
5654
Development Kit). The JRE usually suffices. You only need the JDK to compile
@@ -63,13 +61,7 @@
6361
<para>For Linux users: Unfortunately, Oracle's own pages (such as the link above) focus
6462
on commercial Linux distributions. Users of other distributions are better served by
6563
distribution-specific instructions. More information for specific versions of Linux
66-
can be found at <link condition="_blank"
67-
xlink:href="https://livingtao.blogspot.com/2012/01/few-easy-steps-to-install-sunoracle-jdk.html"
68-
>Amazon Linux</link>, <link condition="_blank"
69-
xlink:href="http://www.webupd8.org/2012/01/install-oracle-java-jdk-7-in-ubuntu-via.html"
70-
>Ubuntu</link> and <link condition="_blank"
71-
xlink:href="http://www.webupd8.org/2012/06/how-to-install-oracle-java-7-in-debian.html"
72-
>Debian</link>.</para>
64+
can be found at <link condition="_blank" xlink:href="https://livingtao.blogspot.com/2012/01/few-easy-steps-to-install-sunoracle-jdk.html">Amazon Linux</link>, <link condition="_blank" xlink:href="http://www.webupd8.org/2012/01/install-oracle-java-jdk-7-in-ubuntu-via.html">Ubuntu</link> and <link condition="_blank" xlink:href="http://www.webupd8.org/2012/06/how-to-install-oracle-java-7-in-debian.html">Debian</link>.</para>
7365

7466

7567
<para>Note for pre eXist-db v2.2 versions: Due to compatibility issues it is NOT
@@ -94,12 +86,12 @@
9486
up:</para>
9587
<itemizedlist>
9688
<listitem>
97-
<para>Download the installer by following the download link on the <link
98-
xlink:href="https://exist-db.org/">eXist-db homepage</link> page. We recommend
89+
<para>Download the installer by following the download link on the
90+
<link xlink:href="https://exist-db.org/">eXist-db homepage</link> page. We recommend
9991
that you download the latest stable release.</para>
10092
<para>The installer is a single file called
101-
<literal>eXist-db-setup-[version].jar</literal> (for instance
102-
<literal>eXist-db-setup-3.6.1.jar</literal>). </para>
93+
<literal>exist-installer-[version].jar</literal> (for instance
94+
<literal>exist-installer-6.3.0.jar</literal>). </para>
10395
</listitem>
10496
<listitem>
10597
<para>Launch the eXist-db installer:</para>
@@ -108,8 +100,8 @@
108100
<para>On Mac and Windows, simply double-click the downloaded
109101
<code>.jar</code> file.</para>
110102
<note>
111-
<para>On Mac OS X 10.7 and higher, a security feature called <link
112-
xlink:href="https://support.apple.com/kb/HT5290">Gatekeeper</link>
103+
<para>On Mac OS X 10.7 and higher, a security feature called
104+
<link xlink:href="https://support.apple.com/kb/HT5290">Gatekeeper</link>
113105
may prevent the installer from running since eXist-db is not
114106
registered with Apple. To circumvent the warning dialog and allow
115107
the installer to run, right-click or control-click the file and
@@ -125,7 +117,7 @@
125117
<listitem>
126118
<para>If necessary you can launch the installer from the command line with
127119
the following command:</para>
128-
<programlisting>java -jar eXist-db-setup-[version].jar</programlisting>
120+
<programlisting>java -jar exist-installer-[version].jar</programlisting>
129121
</listitem>
130122
</itemizedlist>
131123
</listitem>
@@ -134,7 +126,8 @@
134126
described in the <link xlink:href="advanced-installation#headless">Advanced
135127
Installation</link> article. If you wish to compile and run exist from source
136128
please see the article on <link xlink:href="exist-building.xml">building
137-
eXist</link></para>
129+
eXist</link>
130+
</para>
138131
</listitem>
139132
</itemizedlist>
140133

@@ -160,7 +153,7 @@
160153
</listitem>
161154
</varlistentry>
162155
<varlistentry>
163-
<term>Admin Password and Memory Settings:</term>
156+
<term>Admin Password:</term>
164157
<listitem>
165158
<informalfigure>
166159
<mediaobject>
@@ -178,9 +171,9 @@
178171
users on your local network (be it in your home or office, or at a cafe or
179172
on a train). So, securing your administrator's account on eXist-db is a good
180173
way to protect your data and prevent others from abusing the account.</para>
181-
<para>Configure the maximum amount of memory which will be available to Java
174+
<!--para>Configure the maximum amount of memory which will be available to Java
182175
(and eXist-db) and the portion of it which will be reserved for internal
183-
caches.</para>
176+
caches.</para-->
184177
</listitem>
185178
</varlistentry>
186179
<varlistentry>
@@ -195,18 +188,13 @@
195188
</informalfigure>
196189
<itemizedlist>
197190
<listitem>
198-
<para>The "core" package is required to run eXist-db.</para>
191+
<para>The "Server" package is required to run eXist-db.</para>
199192
</listitem>
200193
<listitem>
201-
<para>The "sources" package is optional. Removing "sources" cuts the
202-
installation size considerably, but best to install everything
203-
unless you are starved for disk space.</para>
204-
</listitem>
205-
<listitem>
206-
<para>The "apps" package allows you to select or deselect a number of
194+
<para>The "Apps" package allows you to select or deselect a number of
207195
applications which will be installed into eXist-db when it starts
208-
the first time. If you are new to eXist-db, we recommend to at least
209-
select "dashboard", "demo", "doc", "eXide" and "fundocs". You'll
196+
the first time. If you are new to eXist-db, we recommend to install
197+
all applications. You'll
210198
need those to make your first steps in XQuery development.</para>
211199
</listitem>
212200
</itemizedlist>
@@ -317,15 +305,12 @@
317305
<para>If you want to launch eXist-db without a GUI, use the shell scripts in the
318306
<literal>bin/</literal> sub-directory. On Linux or Mac, enter
319307
<code>bin/startup.sh</code>, on Windows <code>bin\startup.bat</code>. More
320-
information about these start-up scripts in the <link
321-
xlink:href="advanced-installation#headless">Advanced Installation</link>
308+
information about these start-up scripts in the <link xlink:href="advanced-installation#headless">Advanced Installation</link>
322309
article.</para>
323310

324311
<note>
325312
<title>Having trouble?</title>
326-
<para>If you're having trouble launching eXist-db, see our articles on <link
327-
xlink:href="troubleshooting">Troubleshooting</link> and <link
328-
xlink:href="advanced-installation#headless">Advanced
313+
<para>If you're having trouble launching eXist-db, see our articles on <link xlink:href="troubleshooting">Troubleshooting</link> and <link xlink:href="advanced-installation#headless">Advanced
329314
Installation</link>.</para>
330315
</note>
331316
</sect2>
@@ -336,12 +321,10 @@
336321
<sect1 xml:id="diving-in">
337322
<title>Diving In</title>
338323

339-
<para>After a successful installation and launch, access eXist-db's <link
340-
xlink:href="{dashboard}/">Dashboard</link>, the central administration and application
324+
<para>After a successful installation and launch, access eXist-db's <link xlink:href="{dashboard}/">Dashboard</link>, the central administration and application
341325
hub of eXist-db. If the system tray icon works on your system, select <guimenuitem>Open
342326
Dashboard</guimenuitem> from the pop-up menu. Or just open a web browser and enter the
343-
following URL: <link xlink:href="http://localhost:8080/exist/"
344-
>http://localhost:8080/exist/</link> </para>
327+
following URL: <link xlink:href="http://localhost:8080/exist/">http://localhost:8080/exist/</link> </para>
345328
<para>The following page appears:</para>
346329
<informalfigure>
347330
<mediaobject>
@@ -350,12 +333,10 @@
350333
</imageobject>
351334
</mediaobject>
352335
</informalfigure>
353-
<para>Seeing it? Congratulations! (Not seeing it? See our article on <link
354-
xlink:href="troubleshooting">Troubleshooting</link>).</para>
336+
<para>Seeing it? Congratulations! (Not seeing it? See our article on <link xlink:href="troubleshooting">Troubleshooting</link>).</para>
355337

356338
<para>All right, ready to dive in! Your local installation includes everything you need.
357-
Access is easy, through the applications on the <link xlink:href="{dashboard}/"
358-
>Dashboard</link> (see also the <link xlink:href="dashboard">article on the
339+
Access is easy, through the applications on the <link xlink:href="{dashboard}/">Dashboard</link> (see also the <link xlink:href="dashboard">article on the
359340
Dashboard</link>).</para>
360341

361342
</sect1>
@@ -392,4 +373,4 @@
392373
</listitem>
393374
</itemizedlist>
394375
</sect1>
395-
</article>
376+
</article>
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
…> java -version
2-
java version ""1.8.0_60-ea""
3-
Java(TM) SE Runtime Environment (build 1.8.0_60-ea-b19)
4-
Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
2+
openjdk version "1.8.0_442"
3+
OpenJDK Runtime Environment (build 1.8.0_442-b07)
4+
OpenJDK 64-Bit Server VM (build 25.442-b07, mixed mode)

0 commit comments

Comments
 (0)