commit a72dfed8b2c8f38fa96e0f8833fc1cd9808eb04f
parent 740b2fffd1066db88ca7c016f4691f9caff0c4f4
Author: Antoine A <>
Date: Mon, 21 Jul 2025 12:30:27 +0200
depolymerization: add WIP nexus manual
Diffstat:
3 files changed, 118 insertions(+), 0 deletions(-)
diff --git a/depolymerization/bitcoin-manual.rst b/depolymerization/bitcoin-manual.rst
@@ -0,0 +1,88 @@
+..
+ This file is part of GNU TALER.
+ Copyright (C) 2025 Taler Systems SA
+
+ TALER is free software; you can redistribute it and/or modify it under the
+ terms of the GNU Affero General Public License as published by the Free Software
+ Foundation; either version 2.1, or (at your option) any later version.
+
+ TALER is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License along with
+ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
+
+ @author Antoine d'Aligny
+
+
+Bitcoin Depolymerizer Setup Manual
+##################################
+
+depolymerizer-bitcoin is a bitcoin blockhain Taler adapter.
+
+In this manual, we explain how to setup an adapter.
+
+.. contents:: Table of Contents
+ :local:
+
+Installing Bitcoin Depolymerizer
+================================
+
+Building from source
+--------------------
+
+Bitcoin Depolymerizer belongs to the Depolymerization project, and can be downloaded via Git:
+
+.. code-block:: console
+
+ $ git clone git://git.taler.net/depolymerization
+
+You will need the latest version of the rust stable toolchain:
+
+.. code-block:: console
+
+ $ sudo apt install rustup
+ $ rustup toolchain install stable
+
+Navigate into the *depolymerization* local repository, and from top-level run:
+
+.. code-block:: console
+
+ $ ./bootstrap
+ $ ./configure --prefix=$PREFIX
+ $ make install
+
+If the previous steps succeeded, the ``depolymerizer-bitcoin`` command should be found in the $PATH.
+
+
+Database setup
+==============
+
+The configuration file must include a connection string that
+tells Bitcoin Depolymerizer how it should connect to the database. The default
+is:
+
+.. code-block:: ini
+
+ [depolymerizer-bitcoindb-postgres]
+ config = postgres:///depolymerizer-bitcoin
+
+You must make sure that this database exists and is accessible to the user
+running Bitcoin Depolymerizer before continuing. Then, the Bitcoin
+Depolymerizer database schema must be created (or updated) to the current
+Bitcoin Depolymerizer version using the following command:
+
+.. code-block:: console
+
+ $ depolymerizer-bitcoin-dbinit -c "$CONFIG_FILE"
+
+where ``$CONFIG_FILE`` is again the path to a configuration that contains at
+least the above ``[depolymerizer-bitcoindb-postgres]`` section.
+
+Setting up a local bitcoin node
+===============================
+
+Note that bitcoind & bitcoin-cli should already be in $PATH.
+
+TODO
+\ No newline at end of file
diff --git a/depolymerization/index.rst b/depolymerization/index.rst
@@ -0,0 +1,28 @@
+..
+ This file is part of GNU TALER.
+ Copyright (C) 2025 Taler Systems SA
+
+ TALER is free software; you can redistribute it and/or modify it under the
+ terms of the GNU Affero General Public License as published by the Free Software
+ Foundation; either version 2.1, or (at your option) any later version.
+
+ TALER is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License along with
+ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
+
+ @author Antoine d'Aligny
+
+
+Depolymerization Manual
+#######################
+
+Depolymerization is a project providing free software tooling for blockchain.
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ bitcoin-manual
diff --git a/index.rst b/index.rst
@@ -64,6 +64,7 @@ Documentation Overview
taler-challenger-manual
taler-auditor-manual
libeufin/index
+ depolymerization/index
design-documents/index
taler-developer-manual
system-administration/index
