Skip to content

Commit 1a42967

Browse files
duncdrumjoewiz
authored andcommitted
MacOS quicker start (#89)
* gitignore * updated the macOS installation guide see eXist-db/exist#1274, eXist-db/exist#1275 * made the JRE extension note more general * Minor edits
1 parent 077a71d commit 1a42967

File tree

2 files changed

+35
-27
lines changed

2 files changed

+35
-27
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
build/
22
expath-pkg.xml
3-
*.xpr
3+
*.xpr

data/quickstart.xml

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<title>Quick Start</title>
1010
<section id="overview">
1111
<title>Overview</title>
12-
<para>Installing eXist-db on your computer is quick and easy. First, confirm that your
12+
<para>Installing eXist-db on your computer should be quick and easy. First, confirm that your
1313
system meets the requirements. Next, download the installer and follow the
1414
installation instructions here. Before you know it you'll be up and running with
1515
eXist-db.</para>
@@ -22,7 +22,7 @@
2222
certain installation procedures are not possible without administrative privileges.
2323
The critical requirement is that Java be installed.</para>
2424
<note id="since-3.0">
25-
<title>Java requirements</title>
25+
<title>Java requirements</title>
2626
<para>Since eXistdb 3.0 Java 8 is required.</para>
2727
</note>
2828
<note id="about-java">
@@ -35,13 +35,15 @@
3535
you intend to compile eXist-db from its source code. For instructions about
3636
running Java on your operating system, see Oracle's <ulink url="http://www.java.com/en/download/help/index_installing.xml">Installing
3737
Java</ulink> page.</para>
38+
<para><emph>Warning:</emph> If you have installed Saxon as a JRE extension (via the extensions folder), this can cause a critical error during installation. To avoid this error user need to either
39+
remove the JRE extension, or install a second JRE which you use just for eXist-db and set the JAVA_HOME to that when running eXist-db.</para>
3840
<para>Linux users: Unfortunately, Oracle's own pages (such as the link above) focus
3941
on commercial Linux distributions. Users of other distributions are better
4042
served by distribution-specific instructions. Instructions that eXist-db users
41-
have found useful include: <ulink url="http://livingtao.blogspot.com/2012/01/few-easy-steps-to-install-sunoracle-jdk.html">Amazon Linux</ulink>, <ulink url="http://www.webupd8.org/2012/01/install-oracle-java-jdk-7-in-ubuntu-via.html">Ubuntu</ulink> and <ulink url="http://www.webupd8.org/2012/06/how-to-install-oracle-java-7-in-debian.html">Debian</ulink>.</para>
43+
have found useful include: <ulink url="http://livingtao.blogspot.com/2012/01/few-easy-steps-to-install-sunoracle-jdk.html">Amazon Linux</ulink>, <ulink url="http://www.webupd8.org/2012/01/install-oracle-java-jdk-7-in-ubuntu-via.html">Ubuntu</ulink> and <ulink url="http://www.webupd8.org/2012/06/how-to-install-oracle-java-7-in-debian.html">Debian</ulink>.</para>
4244
<para>Special note: In general it recommended to use the Oracle Java VM, this is the safest choice. The OpenJDK 7 is a good open source alternative for the Oracle JVM.</para>
4345
<para>Details of the Java VM can be obtained via the following command (two results displayed):
44-
<synopsis format="java">java -version
46+
<synopsis format="java">java -version
4547
java version ""1.8.0_60-ea""
4648
Java(TM) SE Runtime Environment (build 1.8.0_60-ea-b19)
4749
Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
@@ -76,30 +78,36 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
7678
<step>
7779
<para>
7880
<emphasis>Choose the Installation Directory</emphasis>: You will be
79-
asked where to install eXist-db on your hard disk. The installer will
80-
suggest an appropriate directory, but if you want, you can install
81-
eXist-db anywhere on your system.</para>
81+
asked where to install eXist-db on your hard disk. The installer will
82+
suggest an appropriate directory, but if you want, you can install
83+
eXist-db anywhere on your system.</para>
8284
</step>
8385
<step>
8486
<para>
8587
<emphasis>Choose the Data Directory</emphasis>: The data directory is where
8688
eXist-db keeps its data files. The installer will suggest keeping the data
8789
files inside the application directory, but you can select a different
8890
location if you want.</para>
91+
<para>For macOS users installing via disk image the default data directory will be:
92+
<code>/Users/$username$/Library/Application Support/org.exist</code>
93+
</para>
8994
</step>
9095
<step>
9196
<para>
9297
<emphasis>Choose the Admin Password</emphasis>: The Admin Password is a
93-
password for the eXist-db administrator account, or more commonly, the
94-
"admin" account. This admin account belongs to you, and certain key
95-
functions in eXist-db can only be performed by the admin. While you can
96-
leave the admin password blank, we strongly recommend setting the
97-
password in order to secure access your installation of eXist-db. Why?
98-
Keep in mind that while eXist-db is running, it can be accessed by other
99-
users on your local network (be it in your home or office, or at a cafe
100-
or on a train). So, securing your administrator's account on eXist-db is
101-
a good way to protect your data and prevent others from abusing the
102-
account. Best to choose a unique password.</para>
98+
password for the eXist-db administrator account, or more commonly, the
99+
"admin" account. This admin account belongs to you, and certain key
100+
functions in eXist-db can only be performed by the admin. While you can
101+
leave the admin password blank, we strongly recommend setting the
102+
password in order to secure access your installation of eXist-db. Why?
103+
Keep in mind that while eXist-db is running, it can be accessed by other
104+
users on your local network (be it in your home or office, or at a cafe
105+
or on a train). So, securing your administrator's account on eXist-db is
106+
a good way to protect your data and prevent others from abusing the
107+
account. Best to choose a unique password.</para>
108+
<para>macOS users installing via disk image can change the default (empty) password via the <guimenuitem>Open dashboard</guimenuitem> option from the menubar icon once installation has finished.
109+
<emphasis>special note:</emphasis> during the intial run of eXist-db its Dock icon may remain active even after eXist-db has been shut down. Simply right-click on the eXist-db Dock icon and select <guimenuitem>Quit</guimenuitem>. On subsequent runs the dock icon should behave as expected.
110+
</para>
103111
<para>
104112
<emphasis>Memory Settings</emphasis>: Configure the maximum amount of
105113
memory which will be available to Java (and eXist-db) and the portion of it
@@ -131,9 +139,9 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
131139
</step>
132140
<step>
133141
<para>(Windows and Linux only) <emphasis>Start Menu and/or Desktop Shortcut
134-
Options</emphasis>: The installer can create convenient desktop
135-
shortcuts and Start Menu entries for starting and accessing
136-
eXist-db.</para>
142+
Options</emphasis>: The installer can create convenient desktop
143+
shortcuts and Start Menu entries for starting and accessing
144+
eXist-db.</para>
137145
</step>
138146
</procedure>
139147
<para>When the installer is finished installing eXist-db, click Quit to close it.</para>
@@ -144,7 +152,7 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
144152
On Linux or Windows, select the <emphasis>eXist-db Database Startup</emphasis>
145153
desktop shortcut icon or Start Menu entry you created at the end of the
146154
installation. (To run eXist as a background service, see <ulink url="advanced-installation.xml#service">Running eXist-db as a
147-
Service</ulink>.)</para>
155+
Service</ulink>.)</para>
148156
<para>You'll see a splash screen appear showing the eXist-db logo. Upon first startup,
149157
eXist-db will upload the applications you selected in the installer into the
150158
database. This may take a while and is only done the first time.</para>
@@ -167,7 +175,7 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
167175
<para>Also, the desktop integration does not work properly on all versions of Linux. When using the desktop
168176
launcher, your mileage may vary. However, you may always use the provided shell scripts (<filename>bin/startup.sh</filename>)
169177
to launch eXist-db in the normal way without desktop integration.
170-
</para>
178+
</para>
171179
</note>
172180
<para>You can also start eXist-db manually if you feel comfortable with the command
173181
line:</para>
@@ -192,7 +200,7 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
192200
</step>
193201
</procedure>
194202
<para>For more information about these startup scripts, see <ulink url="advanced-installation.xml#bin-executables">About the Scripts in the bin
195-
Directory</ulink>.</para>
203+
Directory</ulink>.</para>
196204
<note>
197205
<title>Having trouble?</title>
198206
<para>If you suspect you have had a problem launching eXist-db, see our article on
@@ -236,8 +244,8 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
236244
<procedure>
237245
<step>
238246
<para>The system tray popup menu has an option <guimenuitem>Stop server</guimenuitem>.
239-
You may also choose <guimenuitem>Quit (and stop server)</guimenuitem> to shut down
240-
eXist-db and the system tray launcher at the same time.</para>
247+
You may also choose <guimenuitem>Quit (and stop server)</guimenuitem> to shut down
248+
eXist-db and the system tray launcher at the same time.</para>
241249
</step>
242250
<step>
243251
<para>From the <ulink url="{dashboard}">Dashboard App</ulink>: select
@@ -262,4 +270,4 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b19, mixed mode)
262270
</procedure>
263271
</section>
264272
</chapter>
265-
</book>
273+
</book>

0 commit comments

Comments
 (0)