fabric-docs-i18n
fabric-docs-i18n copied to clipboard
hyperledger
[ja_JP] Contributions Welcome! / Setting up the development environment
Original HTML: https://hyperledger-fabric.readthedocs.io/en/release-2.5/dev-setup/devenv.html Original Source: https://github.com/hyperledger/fabric/blob/e1e8e2e52aa4fc543360d245fe6554a0eaf81183/docs/source/dev-setup/devenv.rst
diff --git a/docs/source/dev-setup/devenv.rst b/docs/source/dev-setup/devenv.rst
index 69a28b118..cc878004a 100644
--- a/docs/source/dev-setup/devenv.rst
+++ b/docs/source/dev-setup/devenv.rst
@@ -4,32 +4,46 @@ Setting up the development environment
Prerequisites
~~~~~~~~~~~~~
-- `Git client <https://git-scm.com/downloads>`__
-- `Go <https://golang.org/dl/>`__ version 1.15.x
-- `Docker <https://docs.docker.com/get-docker/>`__ version 18.03 or later
+In addition to the standard :doc:`../prereqs` for Fabric, the following prerequisites are also required:
+
- (macOS) `Xcode Command Line Tools <https://developer.apple.com/downloads/>`__
-- `SoftHSM <https://github.com/opendnssec/SoftHSMv2>`__
-- `jq <https://stedolan.github.io/jq/download/>`__
+- (All platforms) `SoftHSM <https://github.com/opendnssec/SoftHSMv2>`__ use version 2.5 as 2.6 is not operable in this environment
+- (All platforms) `jq <https://stedolan.github.io/jq/download/>`__
+For Linux platforms, including WSL2 on Windows, also required are various build tools such as gnu-make and
+C compiler. On ubuntu and it's derivatives you can install the required toolset by using the command
+``sudo apt install build-essential``. Other distributions may already have the appropriate tools installed
+or provide a convenient way to install the various build tools.
Steps
~~~~~
-Install the Prerequisites
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Installing SoftHSM
+^^^^^^^^^^^^^^^^^^
+Ensure you install ``2.5`` of softhsm, if you are using a distribution package manager such as ``apt`` on ubuntu
+or Homebrew on Mac OS, make sure that it offers this version otherwise you will need to install from source. Version 2.6
+of SoftHSM is known to have problems. Older versions than 2.5 may work however.
+
+When installing SoftHSM, you should note the path where the shared library ``libsofthsm2.so`` is installed
+you may need to have to provide this later in an environment variable to get the PKCS11 tests to pass.
+
+Install the Prerequisites using Homebrew on MacOS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-For macOS, we recommend using `Homebrew <https://brew.sh>`__ to manage the
-development prereqs. The Xcode command line tools will be installed as part of
-the Homebrew installation.
+For macOS, `Homebrew <https://brew.sh>`__ can be used to manage the
+development prereqs (assuming that you would like to install the latest versions).
+The Xcode command line tools will be installed as part of the Homebrew installation.
-Once Homebrew is ready, installing the necessary prerequisites is very easy:
+Once Homebrew is ready, installing the necessary prerequisites is very easy, for example:
::
- brew install git go jq softhsm
- brew cask install --appdir="/Applications" docker
+ brew install git jq
+ brew install --cask docker
-Docker Desktop must be launched to complete the installation so be sure to open
+Go and SoftHSM are also available from Homebrew, but make sure you install the appropriate versions
+
+Docker Desktop must be launched to complete the installation, so be sure to open
the application after installing it:
::
@@ -39,33 +53,7 @@ the application after installing it:
Developing on Windows
~~~~~~~~~~~~~~~~~~~~~
-On Windows 10 you should use the native Docker distribution and you
-may use the Windows PowerShell. However, for the ``binaries``
-command to succeed you will still need to have the ``uname`` command
-available. You can get it as part of Git but beware that only the
-64bit version is supported.
-
-Before running any ``git clone`` commands, run the following commands:
-
-::
-
- git config --global core.autocrlf false
- git config --global core.longpaths true
-
-You can check the setting of these parameters with the following commands:
-
-::
-
- git config --get core.autocrlf
- git config --get core.longpaths
-
-These need to be ``false`` and ``true`` respectively.
-
-The ``curl`` command that comes with Git and Docker Toolbox is old and
-does not handle properly the redirect used in
-:doc:`../getting_started`. Make sure you have and use a newer version
-which can be downloaded from the `cURL downloads page
-<https://curl.haxx.se/download.html>`__
+It is recommended that all development be done within your WSL2 Linux distribution.
Clone the Hyperledger Fabric source
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -80,21 +68,6 @@ the repository.
cd github.com/<your_github_userid>
git clone https://github.com/<your_github_userid>/fabric
-.. note::
- If you are running Windows, before cloning the repository, run the following
- command:
-
- ::
-
- git config --get core.autocrlf
-
- If ``core.autocrlf`` is set to ``true``, you must set it to ``false`` by
- running:
-
- ::
-
- git config --global core.autocrlf false
-
Configure SoftHSM
^^^^^^^^^^^^^^^^^
@@ -109,7 +82,8 @@ SoftHSM generally requires additional configuration before it can be used. For
example, the default configuration will attempt to store token data in a system
directory that unprivileged users are unable to write to.
-SoftHSM configuration typically involves copying ``/etc/softhsm2.conf`` to
+SoftHSM configuration typically involves copying ``/etc/softhsm/softhsm2.conf``
+(or ``/usr/local/etc/softhsm/softhsm2.conf`` for macOS) to
``$HOME/.config/softhsm2/softhsm2.conf`` and changing ``directories.tokendir``
to an appropriate location. Please see the man page for ``softhsm2.conf`` for
details.
@@ -119,11 +93,12 @@ initialize the token required by the unit tests:
::
- softhsm2-util --init-token --slot 0 --label "ForFabric" --so-pin 1234 --pin 98765432
+ softhsm2-util --init-token --slot 0 --label ForFabric --so-pin 1234 --pin 98765432
If tests are unable to locate the libsofthsm2.so library in your environment,
specify the library path, the PIN, and the label of your token in the
-appropriate environment variables. For example, on macOS:
+appropriate environment variables. For example, on macOS, depending on where the
+library has been installed:
::
@@ -131,6 +106,42 @@ appropriate environment variables. For example, on macOS:
export PKCS11_PIN=98765432
export PKCS11_LABEL="ForFabric"
+If you installed SoftHSM on ubuntu from source then the environment variables may look like
+
+::
+
+ export PKCS11_LIB="/usr/local/lib/softhsm/libsofthsm2.so"
+ export PKCS11_PIN=98765432
+ export PKCS11_LABEL="ForFabric"
+
+
+The tests don't always clean up after themselves and, over time, this causes
+the PKCS #11 tests to take a long time to run. The easiest way to recover from
+this is to delete and recreate the token.
+
+::
+
+ softhsm2-util --delete-token --token ForFabric
+ softhsm2-util --init-token --slot 0 --label ForFabric --so-pin 1234 --pin 98765432
+
+Debugging with ``pkcs11-spy``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The `OpenSC Project <https://github.com/OpenSC/OpenSC>`__ provides a shared
+library called ``pkcs11-spy`` that logs all interactions between an application
+and a PKCS #11 module. This library can be very useful when troubleshooting
+interactions with a cryptographic token device or service.
+
+Once the library has been installed, configure Fabric to use ``pkcs11-spy`` as
+the PKCS #11 library and set the ``PKCS11SPY`` environment variable to the real
+library. For example:
+
+::
+
+ export PKCS11SPY="/usr/lib/softhsm/libsofthsm2.so"
+ export PKCS11_LIB="/usr/lib/x86_64-linux-gnu/pkcs11/pkcs11-spy.so"
+
+
Install the development tools
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -153,7 +164,7 @@ few commands.
If those commands completely successfully, you're ready to Go!
-If you plan to use the Hyperledger Fabric application SDKs then be sure to check out their prerequisites in the Node.js SDK `README <https://github.com/hyperledger/fabric-sdk-node#build-and-test>`__ and Java SDK `README <https://github.com/hyperledger/fabric-gateway-java/blob/master/README.md>`__.
+If you plan to use the Hyperledger Fabric application SDKs then be sure to check out their prerequisites in the Node.js SDK `README <https://github.com/hyperledger/fabric-sdk-node#build-and-test>`__, Java SDK `README <https://github.com/hyperledger/fabric-gateway-java/blob/main/README.md>`__, and Go SDK `README <https://github.com/hyperledger/fabric-sdk-go/blob/main/README.md>`__.
.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
