Ver Fonte

Updated readme

Tim Jones há 1 mês atrás
pai
commit
dcdcda2360
3 ficheiros alterados com 40 adições e 0 exclusões
  1. 24 0
      README.md
  2. 4 0
      RackPeek.Web/Dockerfile
  3. 12 0
      notes.md

+ 24 - 0
README.md

@@ -21,6 +21,30 @@ RackPeek is not a CMDB replacement. It’s a clean framework for understanding a
 [![RackPeek demo](./vhs/rpk-demo.gif)](./rpk-demo.gif)
 [![RackPeek demo](./vhs/webui_screenshots/output.gif)](./rpk-webui-demo.gif)
 
+
+## Running RackPeek with Docker
+```text
+
+# Named volume
+docker volume create rackpeek-config
+docker run -d \
+  --name rackpeek \
+  -p 8080:8080 \
+  -v rackpeek-config:/app/config \
+  aptacode/rackpeek:latest
+
+# Bind mount
+docker run -d \
+  --name rackpeek \
+  -p 8080:8080 \
+  -v $(pwd)/config:/app/config \
+  aptacode/rackpeek:latest
+
+# Note - RackPeek stores its state in YAML
+config/
+└── config.yaml
+```
+
 ## Core Values
 
 **Simplicity**  

+ 4 - 0
RackPeek.Web/Dockerfile

@@ -21,5 +21,9 @@ RUN dotnet publish "./RackPeek.Web.csproj" -c $BUILD_CONFIGURATION -o /app/publi
 
 FROM base AS final
 WORKDIR /app
+
+# Directory expected to be mounted by the user
+VOLUME ["/app/config"]
+
 COPY --from=publish /app/publish .
 ENTRYPOINT ["dotnet", "RackPeek.Web.dll"]

+ 12 - 0
notes.md

@@ -21,4 +21,16 @@ chmod +x webui_capture.sh
 
 
 
+```
+
+```bash
+# Manually build / push
+docker buildx build \
+  --platform linux/amd64,linux/arm64 \
+  -f ./Dockerfile \
+  -t aptacode/rackpeek:v0.0.1 \
+  -t aptacode/rackpeek:latest \
+  --push ..
+
+
 ```