Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion source/mainnet/how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Step-by-step guides for completing specific tasks on Concordium. Browse all guid

- :doc:`Run a node using Docker <nodes/run-node-docker-image/index>`
- :doc:`Run a node on Ubuntu (deprecated) <nodes/run-node-ubuntu/index>`
- :doc:`Run a node on macOS <nodes/run-node-macos/index>`
- :doc:`Run a node on macOS (deprecated) <nodes/run-node-macos/index>`
- :doc:`Run a node on Windows <nodes/run-node-windows/index>`
- :doc:`Network-specific Docker images (deprecated) <nodes/run-node-docker/index>`
- :doc:`Run a node on AWS <nodes/run-node-aws/index>`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,14 @@ Select your platform below to configure your node with validator keys.

$sudo systemctl status concordium-testnet-node.service

.. dropdown:: macOS
.. dropdown:: macOS (deprecated)

.. warning::

The macOS package distribution is deprecated. To migrate an existing
validator to Docker Desktop, follow :ref:`migrate-macos-to-docker`.
Reuse existing keys and registration. The instructions below apply only
to existing macOS package installations.

**Prerequisites**

Expand Down
190 changes: 134 additions & 56 deletions source/mainnet/how-to/nodes/run-node-docker-image/run-node-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Install and manage a node on Docker

.. admonition:: At a glance

Use Docker Compose to run a mainnet or testnet node on Linux.
Use Docker Compose to run a mainnet or testnet node on Linux or macOS.
You need Docker Engine and the Compose plugin.
After this procedure, your node runs in a Docker container.

Expand All @@ -17,16 +17,34 @@ If you are running a node already, avoid catching up from scratch using the matc

- :ref:`Ubuntu package migration guide<migrate-debian-to-docker>`.
- :ref:`Network-specific docker image migration guide<migrate-network-specific-images>`.
- TODO MacOS
- :ref:`macOS package migration guide<migrate-macos-to-docker>` (Docker Desktop).
- TODO Windows

Prerequisites
=============

- Meet the :ref:`node requirements <node-requirements>`.
- Make sure that the selected image is available for your host platform.
- Install `Docker Engine <https://docs.docker.com/engine/install/>`_ and the
`Compose plugin <https://docs.docker.com/compose/install/>`_.

.. tabs::

.. group-tab:: Linux

Install `Docker Engine <https://docs.docker.com/engine/install/>`_ and the
`Compose plugin <https://docs.docker.com/compose/install/>`_.

.. group-tab:: macOS

Install and start `Docker Desktop for Mac
<https://docs.docker.com/desktop/setup/install/mac-install/>`_.
Allocate resources that meet the node requirements. Keep Docker Desktop
running while the node runs; container restart policies do not start
Docker Desktop itself after a reboot.

.. group-tab:: Windows

Docker Desktop instructions for Windows have not been written yet.
Do not assume the Linux or macOS procedures apply unchanged.

.. _configure-docker-image:

Expand All @@ -37,56 +55,115 @@ Configure a node
2. In the directory, create ``compose.yaml`` from one the network-configuration examples below.
3. Replace the collector name with your desired node's dashboard name, :emphasis:`note this name will be publicly visible`.

.. dropdown:: Mainnet ``mainnet-node/compose.yaml`` example

Example of Concordium node configuration for running a node on Concordium Mainnet.

.. code-block:: yaml

services:
node:
image: concordium/node:latest
container_name: mainnet-node
restart: unless-stopped
stop_grace_period: 5m
ports:
- "8888:8888"
- "127.0.0.1:20000:20000"
volumes:
- ./data:/mnt/data
environment:
CONCORDIUM_NODE_CONSENSUS_GENESIS_DATA_FILE: /genesis/mainnet-genesis.dat
CONCORDIUM_NODE_CONNECTION_BOOTSTRAP_NODES: bootstrap.mainnet.concordium.software:8888
CONCORDIUM_NODE_CONSENSUS_DOWNLOAD_BLOCKS_FROM: https://catchup.mainnet.concordium.software/blocks.idx
CONCORDIUM_NODE_COLLECTOR_ENABLED: "true"
CONCORDIUM_NODE_COLLECTOR_NODE_NAME: my-mainnet-node
CONCORDIUM_NODE_COLLECTOR_URL: https://dashboard.mainnet.concordium.software/nodes/post

.. dropdown:: Testnet ``testnet-node/compose.yaml`` example

Example of Concordium node configuration for running a node on Concordium Testnet.

.. code-block:: yaml

services:
node:
image: concordium/node:latest
container_name: testnet-node
restart: unless-stopped
stop_grace_period: 5m
ports:
- "8889:8889"
- "127.0.0.1:20001:20000"
volumes:
- ./data:/mnt/data
environment:
CONCORDIUM_NODE_CONSENSUS_GENESIS_DATA_FILE: /genesis/testnet-genesis.dat
CONCORDIUM_NODE_CONNECTION_BOOTSTRAP_NODES: bootstrap.testnet.concordium.com:8888
CONCORDIUM_NODE_CONSENSUS_DOWNLOAD_BLOCKS_FROM: https://catchup.testnet.concordium.com/blocks.idx
CONCORDIUM_NODE_LISTEN_PORT: "8889"
CONCORDIUM_NODE_COLLECTOR_ENABLED: "true"
CONCORDIUM_NODE_COLLECTOR_NODE_NAME: my-testnet-node
CONCORDIUM_NODE_COLLECTOR_URL: https://dashboard.testnet.concordium.com/nodes/post
.. tabs::

.. group-tab:: Linux

.. dropdown:: Mainnet ``mainnet-node/compose.yaml`` example

.. code-block:: yaml

services:
node:
image: concordium/node:latest
container_name: mainnet-node
restart: unless-stopped
stop_grace_period: 5m
ports:
- "8888:8888"
- "127.0.0.1:20000:20000"
volumes:
- ./data:/mnt/data
environment:
CONCORDIUM_NODE_CONSENSUS_GENESIS_DATA_FILE: /genesis/mainnet-genesis.dat
CONCORDIUM_NODE_CONNECTION_BOOTSTRAP_NODES: bootstrap.mainnet.concordium.software:8888
CONCORDIUM_NODE_CONSENSUS_DOWNLOAD_BLOCKS_FROM: https://catchup.mainnet.concordium.software/blocks.idx
CONCORDIUM_NODE_COLLECTOR_ENABLED: "true"
CONCORDIUM_NODE_COLLECTOR_NODE_NAME: my-mainnet-node
CONCORDIUM_NODE_COLLECTOR_URL: https://dashboard.mainnet.concordium.software/nodes/post

.. dropdown:: Testnet ``testnet-node/compose.yaml`` example

.. code-block:: yaml

services:
node:
image: concordium/node:latest
container_name: testnet-node
restart: unless-stopped
stop_grace_period: 5m
ports:
- "8889:8889"
- "127.0.0.1:20001:20000"
volumes:
- ./data:/mnt/data
environment:
CONCORDIUM_NODE_CONSENSUS_GENESIS_DATA_FILE: /genesis/testnet-genesis.dat
CONCORDIUM_NODE_CONNECTION_BOOTSTRAP_NODES: bootstrap.testnet.concordium.com:8888
CONCORDIUM_NODE_CONSENSUS_DOWNLOAD_BLOCKS_FROM: https://catchup.testnet.concordium.com/blocks.idx
CONCORDIUM_NODE_LISTEN_PORT: "8889"
CONCORDIUM_NODE_COLLECTOR_ENABLED: "true"
CONCORDIUM_NODE_COLLECTOR_NODE_NAME: my-testnet-node
CONCORDIUM_NODE_COLLECTOR_URL: https://dashboard.testnet.concordium.com/nodes/post

.. group-tab:: macOS

The current image uses AMD64. ``platform`` selects that architecture;
Apple Silicon Macs require emulation. Check the selected image tag's
architecture and verify that your node keeps up with the network.

.. dropdown:: Mainnet ``mainnet-node/compose.yaml`` example

.. code-block:: yaml

services:
node:
image: concordium/node:latest
platform: linux/amd64
container_name: mainnet-node
restart: unless-stopped
stop_grace_period: 5m
ports:
- "8888:8888"
- "127.0.0.1:20000:20000"
volumes:
- ./data:/mnt/data
environment:
CONCORDIUM_NODE_CONSENSUS_GENESIS_DATA_FILE: /genesis/mainnet-genesis.dat
CONCORDIUM_NODE_CONNECTION_BOOTSTRAP_NODES: bootstrap.mainnet.concordium.software:8888
CONCORDIUM_NODE_CONSENSUS_DOWNLOAD_BLOCKS_FROM: https://catchup.mainnet.concordium.software/blocks.idx
CONCORDIUM_NODE_COLLECTOR_ENABLED: "true"
CONCORDIUM_NODE_COLLECTOR_NODE_NAME: my-mainnet-node
CONCORDIUM_NODE_COLLECTOR_URL: https://dashboard.mainnet.concordium.software/nodes/post

.. dropdown:: Testnet ``testnet-node/compose.yaml`` example

.. code-block:: yaml

services:
node:
image: concordium/node:latest
platform: linux/amd64
container_name: testnet-node
restart: unless-stopped
stop_grace_period: 5m
ports:
- "8889:8889"
- "127.0.0.1:20001:20000"
volumes:
- ./data:/mnt/data
environment:
CONCORDIUM_NODE_CONSENSUS_GENESIS_DATA_FILE: /genesis/testnet-genesis.dat
CONCORDIUM_NODE_CONNECTION_BOOTSTRAP_NODES: bootstrap.testnet.concordium.com:8888
CONCORDIUM_NODE_CONSENSUS_DOWNLOAD_BLOCKS_FROM: https://catchup.testnet.concordium.com/blocks.idx
CONCORDIUM_NODE_LISTEN_PORT: "8889"
CONCORDIUM_NODE_COLLECTOR_ENABLED: "true"
CONCORDIUM_NODE_COLLECTOR_NODE_NAME: my-testnet-node
CONCORDIUM_NODE_COLLECTOR_URL: https://dashboard.testnet.concordium.com/nodes/post

.. group-tab:: Windows

Configuration examples for Windows have not been written yet.

The examples mount a local ``./data`` directory beside the ``compose.yaml`` ensuring the node data and configurations are persisted across restart and updates.

Expand Down Expand Up @@ -155,8 +232,8 @@ To stop and take down the node run:

.. code-block:: console

$docker compose stop
$docker compose down
$ docker compose stop
$ docker compose down

The example configurations use 5 minute shutdown grace period for the node to stop.
Check the logs for a clean shutdown.
Expand All @@ -175,4 +252,5 @@ Run a validator node

For a new validator, see :ref:`Import validator keys <import-validator-keys>`.
For an existing Debian validator, follow :ref:`migrate-debian-to-docker`.
For an existing macOS validator, follow :ref:`migrate-macos-to-docker`.
Use the existing validator keys. Do not generate new keys or register them again.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Advanced node configuration on macOS

This page covers advanced configuration options for a Concordium node running on macOS, including verifying the node is running, enabling inbound connections, and TLS setup. You will need a running macOS node. Use this page when you need to go beyond the default setup.

.. warning::

The macOS package distribution is deprecated. Existing users should follow
:ref:`migrate-macos-to-docker`. Keep node data and validator keys during
migration. These instructions apply only to existing package installations.

.. Note::
If the node is `configured with TLS <https://github.com/Concordium/concordium-node/blob/main/docs/grpc2.md#grpc-api-v2>`_, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate, for example, ``CONCORDIUM_NODE_COLLECTOR_GRPC_HOST=https://example.concordium-node.io:20000``.

Expand Down
20 changes: 15 additions & 5 deletions source/mainnet/how-to/nodes/run-node-macos/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
Run a Node on macOS
===================
Run a node on macOS (deprecated)
================================

.. admonition:: At a glance

This section covers installing and configuring a Concordium node on macOS. Choose a guide below based on what you need to do.

.. warning::

The macOS package distribution is deprecated. For existing installations,
follow :ref:`migrate-macos-to-docker` to move to Docker Desktop.
Keep existing node data and validator keys during migration.
The guides below remain available for existing package installations.
For new installations, use the macOS tabs in
:ref:`install-node-docker-image`.

Choose a topic below to learn how to install, configure, or troubleshoot your Concordium node on macOS.

.. toctree::
:maxdepth: 1

run-node-macos
advanced-node-configuration-on-macos
troubleshoot-macos
migrate-to-docker-image
Install and manage a node on macOS (deprecated) <run-node-macos>
Advanced node configuration on macOS (deprecated) <advanced-node-configuration-on-macos>
Troubleshoot a node on macOS (deprecated) <troubleshoot-macos>
Loading
Loading