+ Some configuration features have been disabled by your administrator +
+{{ jsonParser(config) }}
+ {{ yamlConfig }}
+ diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md index 1dcd2157..10d57bc3 100644 --- a/.github/CHANGELOG.md +++ b/.github/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## 🐛 2.0.3 - Bug Fixes [PR #488](https://github.com/Lissy93/dashy/pull/488) +- Press enter to submit login form (Re: #483) +- Allow disabling write to local storage and disk (Re: #485) +- Fix malformed YAML from export config (Re: #482) +- Allow global option for useProxy (Re: #486) +- Look into arrow key navigation error (Re: #463) +- Disallow displaying config (Re: #455) +- Round values in Glances Alerts widget (Re: #454) +- Create a CPU temp widget (Re: #452) +- Add to docs: Keycloak in Kubernetes (Re: #479) +- Add a widget for displaying images (Re: #487) + ## ⬆️ 2.0.2 - Dependency Updates [PR #471](https://github.com/Lissy93/dashy/pull/471) - Updates Alpine version for main Dockerfile - Updates node_modules to latest stable versions diff --git a/.github/workflows/docker-build-publish.yml b/.github/workflows/docker-build-publish.yml index 076f2621..e35048c6 100644 --- a/.github/workflows/docker-build-publish.yml +++ b/.github/workflows/docker-build-publish.yml @@ -1,5 +1,4 @@ -# Builds, scans and tests the multi-architecture docker image -# Then releases it to the DockerHub, GHCR and Quay registries +# Scans, builds and releases a multi-architecture docker image name: 🐳 Build + Publish Multi-Platform Image on: @@ -77,6 +76,9 @@ jobs: username: ${{ secrets.ACR_USERNAME }} password: ${{ secrets.ACR_PASSWORD }} + - name: 🚦 Check Registry Status + uses: crazy-max/ghaction-docker-status@v1 + - name: ⚒️ Build and push uses: docker/build-push-action@v2 with: @@ -87,11 +89,12 @@ jobs: labels: ${{ steps.meta.outputs.labels }} push: true - # - name: 💬 Set Docker Hub Description - # uses: peter-evans/dockerhub-description@v2 - # with: - # repository: lissy93/dashy - # readme-filepath: ./README.md - # short-description: Dashy - A self-hosted start page for your server - # username: ${{ secrets.DOCKER_USERNAME }} - # password: ${{ secrets.DOCKER_PASSWORD }} + - name: 💬 Set Docker Hub Description + uses: peter-evans/dockerhub-description@v2 + with: + repository: lissy93/dashy + readme-filepath: ./docker/docker-readme.md + short-description: Dashy - A self-hosted start page for your server + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + diff --git a/Dockerfile b/Dockerfile index 86ae3f75..ebb6f41c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,9 +1,10 @@ FROM node:16.13.2-alpine AS BUILD_IMAGE +# Set the platform to build image for ARG TARGETPLATFORM ENV TARGETPLATFORM=${TARGETPLATFORM:-linux/amd64} -# Install additional tools needed on arm64 and armv7 +# Install additional tools needed if on arm64 / armv7 RUN \ case "${TARGETPLATFORM}" in \ 'linux/arm64') apk add --no-cache python3 make g++ ;; \ @@ -23,7 +24,7 @@ COPY . ./ # Build initial app for production RUN yarn build -# Build the final image +# Production stage FROM node:16.13.2-alpine # Define some ENV Vars @@ -44,8 +45,8 @@ COPY --from=BUILD_IMAGE /app ./ ENTRYPOINT [ "/sbin/tini", "--" ] CMD [ "yarn", "build-and-start" ] -# Expose given port +# Expose the port EXPOSE ${PORT} -# Run simple healthchecks every 5 mins, to check the Dashy's everythings great +# Run simple healthchecks every 5 mins, to check that everythings still great HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check diff --git a/docker/docker-readme.md b/docker/docker-readme.md new file mode 100644 index 00000000..cab89e30 --- /dev/null +++ b/docker/docker-readme.md @@ -0,0 +1,136 @@ +
+ Dashy helps you organize your self-hosted services by making them accessible from a single place
+
+
+
+ User Showcase | Live Demo | Getting Started | Documentation | GitHub
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + +**[⬆️ Back to Top](#dashy)** + +--- + +## Getting Started 🛫 + +To deploy Dashy with Docker, just run `docker run -p 8080:80 lissy93/dashy`, then open `http://localhost:8080` + +For full list of options and a Docker compose file, see the [Deployment Docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md). + +Dashy can also be run on bare metal using Node.js, or deployed to a cloud service, using the 1-Click deploy script. + +--- + +## Documentation 📝 + +#### Running Dashy +- **[Quick Start](https://github.com/Lissy93/dashy/blob/master/docs/quick-start.md)** - TDLR guide on getting Dashy up and running +- **[Deployment](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md)** - Full guide on deploying Dashy either locally or online +- **[Configuring](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md)** - Complete list of all available options in the config file +- **[App Management](https://github.com/Lissy93/dashy/blob/master/docs/management.md)** - Managing your app, updating, security, web server configuration, etc +- **[Troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md)** - Common errors and problems, and how to fix them + +#### Feature Docs +- **[Authentication](https://github.com/Lissy93/dashy/blob/master/docs/authentication.md)** - Guide to setting up authentication to protect your dashboard +- **[Alternate Views](https://github.com/Lissy93/dashy/blob/master/docs/alternate-views.md)** - Outline of available pages / views and item opening methods +- **[Backup & Restore](https://github.com/Lissy93/dashy/blob/master/docs/backup-restore.md)** - Guide to backing up config with Dashy's cloud sync feature +- **[Icons](https://github.com/Lissy93/dashy/blob/master/docs/icons.md)** - Outline of all available icon types for sections and items, with examples +- **[Language Switching](https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md)** - Details on how to switch language, or add a new locale +- **[Status Indicators](https://github.com/Lissy93/dashy/blob/master/docs/status-indicators.md)** - Using Dashy to monitor uptime and status of your apps +- **[Searching & Shortcuts](https://github.com/Lissy93/dashy/blob/master/docs/searching.md)** - Searching, launching methods + keyboard shortcuts +- **[Theming](https://github.com/Lissy93/dashy/blob/master/docs/theming.md)** - Complete guide to applying, writing and modifying themes + styles +- **[Widgets](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md)** - List of all dynamic content widgets, with usage guides and examples + +#### Development and Contributing +- **[Developing](https://github.com/Lissy93/dashy/blob/master/docs/developing.md)** - Running Dashy development server locally, and general workflow +- **[Development Guides](https://github.com/Lissy93/dashy/blob/master/docs/development-guides.md)** - Common development tasks, to help new contributors +- **[Contributing](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md)** - How you can help keep Dashy alive +- **[Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md)** - See how others are using Dashy, and share your dashboard +- **[Credits](https://github.com/Lissy93/dashy/blob/master/docs/credits.md)** - List of people and projects that have made Dashy possible +- **[Release Workflow](https://github.com/Lissy93/dashy/blob/master/docs/release-workflow.md)** - Info about releases, CI and automated tasks + +--- + +## License 📜 + +Dashy is Licensed under [MIT X11](https://en.wikipedia.org/wiki/MIT_License) + +``` +Copyright © 2021 Alicia Sykes+ Error: Configuration has been disabled on this instance. + Please contact your administrator for more information. +
+