development server readme and go.mod update

ipdr · Jan 31, 2023 · 6732ab4 · 6732ab4
1 parent bf538ae
commit 6732ab4
Show file tree

Hide file tree

Showing 3 changed files with 126 additions and 115 deletions.
diff --git a/README.md b/README.md
@@ -19,9 +19,9 @@
 
 IPDR is a [Docker Registry](https://docs.docker.com/registry/) tool that proxies Docker registry requests to IPFS for pushing and pulling images. IPDR allows you to store Docker images on IPFS instead of a central registry like Docker Hub or Google Container Registry. Docker images are referenced by their IPFS hash instead of the repo tag names.
 
-IPDR is compatabile with the *Docker Registry HTTP [API V2 Spec](https://docs.docker.com/registry/spec/api/)* for pulling images&ast;
+IPDR is compatabile with the _Docker Registry HTTP [API V2 Spec](https://docs.docker.com/registry/spec/api/)_ for pulling images\*
 
-<sup><sub>&ast;not fully 1:1 implemented yet</sub></sup>
+<sup><sub>\*not fully 1:1 implemented yet</sub></sup>
 
 High-level overview:
 
@@ -42,171 +42,172 @@ High-level overview:
 
 - Install with [Go](https://golang.org/doc/install):
 
-    ```bash
-    go get -u github.com/ipdr/ipdr/cmd/ipdr
-    ```
+  ```bash
+  go get -u github.com/ipdr/ipdr/cmd/ipdr
+  ```
 
 - Install from [release binaries](https://github.com/ipdr/ipdr/releases):
 
-    ```bash
-    # replace x.x.x with the latest version
-    wget https://github.com/ipdr/ipdr/releases/download/x.x.x/ipdr_x.x.x_linux_amd64.tar.gz
-    tar -xvzf ipdr_x.x.x_linux_amd64.tar.gz ipdr
-    ./ipdr --help
+  ```bash
+  # replace x.x.x with the latest version
+  wget https://github.com/ipdr/ipdr/releases/download/x.x.x/ipdr_x.x.x_linux_amd64.tar.gz
+  tar -xvzf ipdr_x.x.x_linux_amd64.tar.gz ipdr
+  ./ipdr --help
 
-    # move to bin path
-    sudo mv ipdr /usr/local/bin/ipdr
-    ```
+  # move to bin path
+  sudo mv ipdr /usr/local/bin/ipdr
+  ```
 
 ## Getting started
 
 ### Prerequisites
 
 - Start IPFS daemon ([Install instructions](https://docs.ipfs.io/introduction/install/)):
 
-    ```bash
-    $ ipfs daemon
-    Initializing daemon...
-    Swarm listening on /ip4/127.0.0.1/tcp/4001
-    Swarm listening on /ip4/192.168.86.90/tcp/4001
-    Swarm listening on /ip6/::1/tcp/4001
-    Swarm listening on /p2p-circuit/ipfs/QmR29wrbNv3WrMuodwuLiDwvskuZKKeTtcYDw7SwNffzCH
-    Swarm announcing /ip4/127.0.0.1/tcp/4001
-    Swarm announcing /ip4/192.168.0.21/tcp/43042
-    Swarm announcing /ip4/192.168.86.90/tcp/4001
-    Swarm announcing /ip6/::1/tcp/4001
-    API server listening on /ip4/0.0.0.0/tcp/5001
-    Gateway (readonly) server listening on /ip4/0.0.0.0/tcp/8080
-    Daemon is ready
-    ```
+  ```bash
+  $ ipfs daemon
+  Initializing daemon...
+  Swarm listening on /ip4/127.0.0.1/tcp/4001
+  Swarm listening on /ip4/192.168.86.90/tcp/4001
+  Swarm listening on /ip6/::1/tcp/4001
+  Swarm listening on /p2p-circuit/ipfs/QmR29wrbNv3WrMuodwuLiDwvskuZKKeTtcYDw7SwNffzCH
+  Swarm announcing /ip4/127.0.0.1/tcp/4001
+  Swarm announcing /ip4/192.168.0.21/tcp/43042
+  Swarm announcing /ip4/192.168.86.90/tcp/4001
+  Swarm announcing /ip6/::1/tcp/4001
+  API server listening on /ip4/0.0.0.0/tcp/5001
+  Gateway (readonly) server listening on /ip4/0.0.0.0/tcp/8080
+  Daemon is ready
+  ```
 
 - Add `docker.local` to `/etc/hosts`:
 
-    ```hosts
-    echo '127.0.0.1 docker.local' | sudo tee -a /etc/hosts
-    echo '::1       docker.local' | sudo tee -a /etc/hosts
-    ```
+  ```hosts
+  echo '127.0.0.1 docker.local' | sudo tee -a /etc/hosts
+  echo '::1       docker.local' | sudo tee -a /etc/hosts
+  ```
 
-    - Flush local DNS cache:
+  - Flush local DNS cache:
 
-      - on macOS:
+    - on macOS:
 
-          ```bash
-          dscacheutil -flushcache; sudo killall -HUP mDNSResponder
-          ```
+      ```bash
+      dscacheutil -flushcache; sudo killall -HUP mDNSResponder
+      ```
 
-      - on Ubuntu 18+:
+    - on Ubuntu 18+:
 
-          ```bash
-          sudo systemd-resolve --flush-caches
-          ```
+      ```bash
+      sudo systemd-resolve --flush-caches
+      ```
 
 ### Example flow
 
 - Create `Dockerfile`:
 
-    ```dockerfile
-    FROM busybox:latest
+  ```dockerfile
+  FROM busybox:latest
 
-    CMD echo 'hello world'
-    ```
+  CMD echo 'hello world'
+  ```
 
 - Build Docker image:
 
-    ```bash
-    docker build -t example/helloworld .
-    ```
+  ```bash
+  docker build -t example/helloworld .
+  ```
 
-    Test run:
+  Test run:
 
-    ```bash
-    $ docker run example/helloworld:latest
-    hello world
-    ```
+  ```bash
+  $ docker run example/helloworld:latest
+  hello world
+  ```
 
 - Use IPDR CLI to push to IPFS:
 
-    ```bash
-    $ ipdr push example/helloworld
-
-    INFO[0000] [registry] temp: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/205139235
-    INFO[0000] [registry] preparing image in: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/657143846
-    INFO[0000]
-    [registry] dist: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/657143846/default/blobs/sha256:305510b2c684403553fd8f383e8d109b147df2cfde60e40a85564532c383c8b8
-    INFO[0000] [registry] compressing layer: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/205139235/886f4bdfa483cc176e947c63d069579785c051793a9634f571fded7b9026cd3c/layer.tar
-    INFO[0000] [registry] root dir: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/657143846
-    INFO[0000] [registry] upload hash QmRxZ5Wffj6b1j8ckJLcr7yFrbHUhBYXsAMbj7Krwu1pp8
-    INFO[0000]
-    [registry] uploaded to /ipfs/Qmc2ot2NQadXmbvPbsidyjYDvPfPwKZmovzNpfRPKxXUrL
-    INFO[0000] [registry] docker image ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
-
-    Successfully pushed Docker image to IPFS:
-    /ipfs/Qmc2ot2NQadXmbvPbsidyjYDvPfPwKZmovzNpfRPKxXUrL
-    ```
+  ```bash
+  $ ipdr push example/helloworld
+
+  INFO[0000] [registry] temp: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/205139235
+  INFO[0000] [registry] preparing image in: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/657143846
+  INFO[0000]
+  [registry] dist: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/657143846/default/blobs/sha256:305510b2c684403553fd8f383e8d109b147df2cfde60e40a85564532c383c8b8
+  INFO[0000] [registry] compressing layer: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/205139235/886f4bdfa483cc176e947c63d069579785c051793a9634f571fded7b9026cd3c/layer.tar
+  INFO[0000] [registry] root dir: /var/folders/k1/m2rmftgd48q97pj0xf9csdb00000gn/T/657143846
+  INFO[0000] [registry] upload hash QmRxZ5Wffj6b1j8ckJLcr7yFrbHUhBYXsAMbj7Krwu1pp8
+  INFO[0000]
+  [registry] uploaded to /ipfs/Qmc2ot2NQadXmbvPbsidyjYDvPfPwKZmovzNpfRPKxXUrL
+  INFO[0000] [registry] docker image ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
+
+  Successfully pushed Docker image to IPFS:
+  /ipfs/Qmc2ot2NQadXmbvPbsidyjYDvPfPwKZmovzNpfRPKxXUrL
+  ```
 
 - Use IPDR CLI to pull from IPFS:
 
-    ```bash
-    $ ipdr pull QmagW4H1uE5rkm8A6iVS8WuiyjcWQzqXRHbM3KuUfzrCup
-
-    INFO[0000] [registry/server] port 5000
-    INFO[0000] [registry] attempting to pull docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
-    INFO[0000] [registry/server] /v2/
-    INFO[0000] [registry/server] /v2/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi/manifests/latest
-    INFO[0000] [registry/server] location http://127.0.0.1:8080/ipfs/Qmc2ot2NQadXmbvPbsidyjYDvPfPwKZmovzNpfRPKxXUrL/manifests/latest-v2
-    {"status":"Pulling from ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi","id":"latest"}
-    {"status":"Digest: sha256:1fb36e4704d6ebad5becdcfe996807de5f8db687da396330f112157c888c165b"}
-    {"status":"Status: Downloaded newer image for docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi:latest"}
-
-    Successfully pulled Docker image from IPFS:
-    docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
-    ```
+  ```bash
+  $ ipdr pull QmagW4H1uE5rkm8A6iVS8WuiyjcWQzqXRHbM3KuUfzrCup
+
+  INFO[0000] [registry/server] port 5000
+  INFO[0000] [registry] attempting to pull docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
+  INFO[0000] [registry/server] /v2/
+  INFO[0000] [registry/server] /v2/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi/manifests/latest
+  INFO[0000] [registry/server] location http://127.0.0.1:8080/ipfs/Qmc2ot2NQadXmbvPbsidyjYDvPfPwKZmovzNpfRPKxXUrL/manifests/latest-v2
+  {"status":"Pulling from ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi","id":"latest"}
+  {"status":"Digest: sha256:1fb36e4704d6ebad5becdcfe996807de5f8db687da396330f112157c888c165b"}
+  {"status":"Status: Downloaded newer image for docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi:latest"}
+
+  Successfully pulled Docker image from IPFS:
+  docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
+  ```
 
 - Run image pulled from IPFS:
 
-    ```bash
-    $ docker run docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
-    hello world
-    ```
+  ```bash
+  $ docker run docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi
+  hello world
+  ```
 
 - Retag Docker image:
 
-    ```bash
-    $ docker tag docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi example/helloworld:latest
-    ```
+  ```bash
+  $ docker tag docker.local:5000/ciqmw4mig2uwaygddjlutoywq43udutvdmuxkcxvetsjp2mjdde27wi example/helloworld:latest
+  ```
 
 - We can also pull the image using `docker pull`:
-    - First run the IPDR server in a seperate terminal:
 
-        ```bash
-        $ ipdr server -p 5000
-        INFO[0000] [registry/server] listening on [::]:5000
-        ```
+  - First run the IPDR server in a seperate terminal:
 
-    - Then convert the IPFS hash to a valid format docker allows:
+    ```bash
+    $ ipdr server -p 5000
+    INFO[0000] [registry/server] listening on [::]:5000
+    ```
 
-        ```bash
-        $ ipdr convert QmYMg6WAuvF5i5yFmjT8KkqewZ5Ngh4U9Mp1bGfdjraFVk --format=docker
+  - Then convert the IPFS hash to a valid format docker allows:
 
-        ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
-        ```
+    ```bash
+    $ ipdr convert QmYMg6WAuvF5i5yFmjT8KkqewZ5Ngh4U9Mp1bGfdjraFVk --format=docker
 
-    - Now we can `docker pull` the image from IPFS:
+    ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
+    ```
 
-        ```bash
-        $ docker pull docker.local:5000/ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
-        Using default tag: latest
-        latest: Pulling from ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
-        Digest: sha256:6b787c9e04c2038d4b3cb0392417abdddfcfd88e10005d970fc751cdcfd6d895
-        Status: Downloaded newer image for docker.local:5000/ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y:latest
-        ```
+  - Now we can `docker pull` the image from IPFS:
 
-        Test run:
+    ```bash
+    $ docker pull docker.local:5000/ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
+    Using default tag: latest
+    latest: Pulling from ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
+    Digest: sha256:6b787c9e04c2038d4b3cb0392417abdddfcfd88e10005d970fc751cdcfd6d895
+    Status: Downloaded newer image for docker.local:5000/ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y:latest
+    ```
+
+    Test run:
 
-        ```bash
-        $ docker run docker.local:5000/ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
-        hello world
-        ```
+    ```bash
+    $ docker run docker.local:5000/ciqjjwaeoszdgcaasxmlhjuqnhbctgwijqz64w564lrzeyjezcvbj4y
+    hello world
+    ```
 
 ### TLDR; example
 
@@ -330,6 +331,13 @@ docker run docker.local:5000/bafybeiakvswzlopeu573372p5xry47tkc2hhcg5q5rulmbfrnk
 make test
 ```
 
+## Development
+
+```bash
+CompileDaemon -command="./build/ipdr" --directory="./" --color=true --build="go build -o build/ipdr ./cmd/ipdr"
+./build/ipdr ...
+```
+
 ## FAQ
 
 - Q: How do I configure the local registry host or port that IPDR uses when pushing or pulling Docker images?

diff --git a/go.mod b/go.mod
@@ -15,4 +15,5 @@ require (
 	github.com/multiformats/go-multibase v0.0.3
 	github.com/sirupsen/logrus v1.6.0
 	github.com/spf13/cobra v1.0.0
+	golang.org/x/sys v0.4.0 // indirect
 )
diff --git a/go.sum b/go.sum
@@ -572,6 +572,8 @@ golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20200501052902-10377860bb8e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200523222454-059865788121 h1:rITEj+UZHYC927n8GT97eC3zrpzXdb/voyeOuVKS46o=
 golang.org/x/sys v0.0.0-20200523222454-059865788121/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18=
+golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/text v0.0.0-20160726164857-2910a502d2bf/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=