Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

🐳 Docker ignore unnecessary meta files

Alicia Sykese1d5a2d0f53f
diff --git a/.dockerignore b/.dockerignore
index 083b416d..56f65341 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -1,9 +1,15 @@
-# Files specified here are not required for Docker
-# so ignoring them helps to reduce the container size
-# The Docker container MUST have the following files:
-# package.json yarn.lock server.js vite.config.mjs src/ services/
-
-node_modules
-docs
-.git
-.github
+# Files specified here are not required for Docker
+# Excluding them helps keep the build context lite
+node_modules
+docs
+tests
+dist
+.git
+.github
+
+# The only things needed to build the Dockerfile are:
+# Depens: package.json, yarn.lock
+# Setup: tsconfig.json, vite.config.mjs
+# Client: index.html, src/, public/
+# Server: services/, server.js
+# Config: user-data/conf.yml
diff --git a/README.md b/README.md
index f1813cad..a5201ef7 100644
--- a/README.md
+++ b/README.md
@@ -129,16 +129,23 @@ Or
```docker
docker run -d \
-p 4000:8080 \
- -v /root/my-local-conf.yml:/app/user-data/conf.yml \
+ -v /path/to/your/user-data:/app/user-data \
--name my-dashboard \
--restart=always \
lissy93/dashy:latest
```
+
[![Dashy on Docker Hub](https://dockeri.co/image/lissy93/dashy)](https://hub.docker.com/r/lissy93/dashy)
-See also: [examples with Docker Compose](./docs/deployment.md#using-docker-compose). Dashy is also available via GHCR, and tags for other architectures (`arm32v7`, `arm64v8`, etc.) and set versions are supported
+The mounted `/app/user-data` directory **must** contain at least a `conf.yml`.
+It can also hold sub-config files, item icons, fonts, custom CSS, or anything else you want served from the web root.
+
+Dashy is also available via GHCR (`ghcr.io/lissy93/dashy`).
+To use with compose, see our sample [`docker-compose.yml`](https://github.com/lissy93/dashy/blob/master/docker-compose.yml).
+You can either use `:latest` or pin to specific versions (like `4.0.0`).
+All images are multi-arch (works on amd64, arm64, and arm/v7).
-> Once you've got Dashy running, see [App Management Docs](./docs/management.md) for info on using health checks, updating, backups, web-server configs, logs, performance, security, and more.
+> Once you've got Dashy running, see [the docs](https://dashy.to/docs/) for configuration references and usage guides.
### Deploying from Source πŸ”¨