From 9935863156671795966ab6f1e98602f8bf5a8f60 Mon Sep 17 00:00:00 2001 From: Gus Eggert Date: Mon, 11 Apr 2022 11:57:40 -0400 Subject: [PATCH] remove container init documentation from README There is already IPFS Docker documentation where this should live: https://docs.ipfs.io/how-to/run-ipfs-inside-docker/ --- README.md | 42 ------------------------------------------ 1 file changed, 42 deletions(-) diff --git a/README.md b/README.md index a78718b0a5f..f8d17ad20a3 100644 --- a/README.md +++ b/README.md @@ -366,48 +366,6 @@ Basic proof of 'ipfs working' locally: # QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o ipfs cat -To perform a custom initialization and configuration step, one can mount `.sh` scripts to a `/container-init.d` directory, or mount the entire directory. These scripts are executed if they have `+x` permission, otherwise they are just sourced. Executed scripts can exit with error and abort the initialization process. The scripts may also depend on environment variables set by the `docker run` command or in `docker-compose.yml`. The custom initialization step is **only** performed during IPFS initialization, **after** `ipfs init`, **after** after the swarm key is copied to the IPFS data directory, and **before** the daemon is started. This also enables custom containers to layer extra initialization steps to the base image by adding more scripts to `/container-init.d`. - -This example initializes a peer in a private network, without any communication with the default bootstrap nodes because it is performed before the daemon starts: - -```bash - -# This is the initialization script -TEST_NAME=00-test.sh -TEST_SCRIPT=`pwd`/$TEST_NAME - -# The script will add this node when creating the container -PRIV_PEER_IP=127.0.0.1 -PRIV_PEER_ID=QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ - -# For instructional purposes, create the initialization script here, -# but this may be part of a suite of scripts maintained by the IT team, -# or created inside a custom Dockerfile. -cat >$TEST_SCRIPT <