Skip to content

docs: clarify single-script local fabric setup #5449

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.

Sign up for GitHub

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

Open
malsomesh9 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify single-script local fabric setup #5449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions docs/source/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ The Fabric application stack has five layers:
* :doc:`Application APIs <sdk_chaincode>`: to develop your blockchain application.
* The Application: your blockchain application will utilize the Application SDKs to call smart contracts running on a Fabric network.

For a quick local setup, start with :doc:`Fabric and Fabric samples <install>`, which includes the
`install-fabric.sh` script for downloading Fabric binaries, container images, and the samples repository.
If you want to modify Fabric itself, continue afterwards with the
:doc:`development environment <dev-setup/devenv>`.


.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
12 changes: 12 additions & 0 deletions docs/source/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ The `install-fabric.sh` script introduced in the next section automates the proc
* `fabric-ca-client`,
* `fabric-ca-server`

## Which setup path should I use?

For most users who want a working local Fabric environment with a single script, the recommended path is:

1. Install the required software from [Prerequisites](./prereqs.html).
2. Run `install-fabric.sh` to download the Fabric binaries, Docker images, and optionally `fabric-samples`.
3. Use the `fabric-samples` test network and tutorials to start a local network and deploy chaincode.

If you want to contribute to Fabric itself, use this install flow first and then continue with the
[contributor development environment](./dev-setup/devenv.html), which adds the extra tools and steps
needed to build Fabric and run its test suites.

## Download Fabric samples, Docker images, and binaries

A working directory is required - for example, Go Developers use the `$HOME/go/src/github.com/<your_github_userid>` directory.  This is a Golang Community recommendation for Go projects.
Expand Down
⚡