aboutsummaryrefslogtreecommitdiffstats
path: root/packages/verdaccio/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/verdaccio/README.md')
-rw-r--r--packages/verdaccio/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/packages/verdaccio/README.md b/packages/verdaccio/README.md
new file mode 100644
index 000000000..340cd5512
--- /dev/null
+++ b/packages/verdaccio/README.md
@@ -0,0 +1,18 @@
+## 0x Verdaccio
+
+This package contains a Dockerfile and conf.yaml file for configuring our own
+Docker image for Verdaccio.
+
+See https://verdaccio.org/docs/en/configuration for more information.
+
+## Build
+
+In the root directory for _this package_, run:
+
+`sudo docker build . -t 0x-verdaccio`
+
+## Run
+
+To start Verdaccio run:
+
+`sudo docker run --rm -i -p 4873:4873 0x-verdaccio`