Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install: Clarify tarball installation on macOS #111

Merged
merged 2 commits into from
Aug 1, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions docs/install/tarball.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,37 @@ This section of the documentation outlines how to use the release archives to
install CrateDB. The walkthrough is suitable to install and run CrateDB on
`Unix-like`_ systems, for example Linux and macOS.

#. Download the latest `CrateDB release archive`_. Please make sure to select
1. Download the latest `CrateDB release archive`_. Please make sure to select
the right release archive matching your system.

#. Once downloaded, extract the archive either using your favorite terminal or
2. Once downloaded, extract the archive either using your favorite terminal or
command line shell or by using a GUI tool like `7-Zip`_::

# Extract tarball on Unix-like systems
tar -xzf crate-*.tar.gz

#. On the terminal, change into the extracted ``crate`` directory::
3. On the terminal, change into the extracted ``crate`` directory::

cd crate-*

#. Run a CrateDB single-node instance on the local network interface::
4. Run a CrateDB single-node instance on the local network interface::

./bin/crate

#. In order to stop CrateDB again, use :kbd:`ctrl-c`.
.. NOTE::

When installing a specific version of CrateDB from tarball on a macOS
system for the first time, it is possible that you will encounter an error like:
**"java" cannot be openeded because developer cannot be verified.**

This is expected and can be fixed in your system settings:
- Navigate to **System Preferences** -> **Security and Privacy**
- On the page you will see an **Allow Anyway** button for "java"
- After confirming, run the ``/bin/crate`` command again. You will be
asked to confirm once more with **Open** button. After that CrateDB
will run as expected.

5. In order to stop CrateDB again, use :kbd:`ctrl-c`.

.. SEEALSO::

Expand Down