aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcodecrafters-bot <hello@codecrafters.io>2024-06-02 20:04:15 +0000
committercodecrafters-bot <hello@codecrafters.io>2024-06-02 20:04:15 +0000
commitbab5e32bd62071304ec1cd865859e685bf6d9b23 (patch)
treecb07d921130962c3887f3570ed70e45553879f83 /README.md
downloaddocker-go-bab5e32bd62071304ec1cd865859e685bf6d9b23.tar.gz
docker-go-bab5e32bd62071304ec1cd865859e685bf6d9b23.zip
init [skip ci]
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7e543ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+[![progress-banner](https://backend.codecrafters.io/progress/docker/f7cecf9e-c40b-4dc9-b7d5-206bb7c9e509)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)
+
+This is a starting point for Go solutions to the
+["Build Your Own Docker" Challenge](https://codecrafters.io/challenges/docker).
+
+In this challenge, you'll build a program that can pull an image from
+[Docker Hub](https://hub.docker.com/) and execute commands in it. Along the way,
+we'll learn about [chroot](https://en.wikipedia.org/wiki/Chroot),
+[kernel namespaces](https://en.wikipedia.org/wiki/Linux_namespaces), the
+[docker registry API](https://docs.docker.com/registry/spec/api/) and much more.
+
+**Note**: If you're viewing this repo on GitHub, head over to
+[codecrafters.io](https://codecrafters.io) to try the challenge.
+
+# Passing the first stage
+
+The entry point for your Docker implementation is `app/main.go`. Study and
+uncomment the relevant code, and push your changes to pass the first stage:
+
+```sh
+git add .
+git commit -m "pass 1st stage" # any msg
+git push origin master
+```
+
+That's all!
+
+# Stage 2 & beyond
+
+Note: This section is for stages 2 and beyond.
+
+You'll use linux-specific syscalls in this challenge. so we'll run your code
+_inside_ a Docker container.
+
+Please ensure you have [Docker installed](https://docs.docker.com/get-docker/)
+locally.
+
+Next, add a [shell alias](https://shapeshed.com/unix-alias/):
+
+```sh
+alias mydocker='docker build -t mydocker . && docker run --cap-add="SYS_ADMIN" mydocker'
+```
+
+(The `--cap-add="SYS_ADMIN"` flag is required to create
+[PID Namespaces](https://man7.org/linux/man-pages/man7/pid_namespaces.7.html))
+
+You can now execute your program like this:
+
+```sh
+mydocker run alpine:latest /usr/local/bin/docker-explorer echo hey
+```