From 4baa457497267a3dceccd4cd54459e0a1824434b Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sat, 21 Aug 2021 23:27:32 +0100 Subject: [PATCH] :pencil2: Fixes typos in the readme --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 23e8227b..93238799 100644 --- a/README.md +++ b/README.md @@ -243,7 +243,7 @@ You can also specify an time interval in seconds under `appConfig.statusCheckInt > For full authentication documentation, see: [**Authentication**](./docs/authentication.md) -Dashy has full support for [Keycloak](https://www.keycloak.org/), for securing your dashboard. +Dashy now has full support for [Keycloak](https://www.keycloak.org/)! There is also a simple login feature for basic access control, which doesn't require any additional setup. To enable this feature, add an `auth` attribute under `appConfig`, containing an array of `users`, each with a username, SHA-256 hashed password and optional user type. @@ -258,7 +258,7 @@ appConfig: **Guest Access**: By default, when authentication is configured no user can access your dashboard without first logging in. If you would like to allow for read-only access by unauthenticated users, then you can enable guest mode, by setting `appConfig.auth.enableGuestAccess: true`. -**Note**: Using the above method involved access control being handled on the frontend, and therefore in security-critical situations, it is recommended to use an alternate method for authentication. Keycloak is [natively supported](docs/authentication.md#keycloak), but you could also use [Authelia](https://www.authelia.com/), a VPN or web server and firewall rules. Instructions for all of these can be found [in the docs](docs/authentication.md#alternative-authentication-methods). +**Note**: Using the above method involves access control being handled on the frontend, and therefore in security-critical situations, it is recommended to use an alternate method for authentication. Keycloak is [natively supported](docs/authentication.md#keycloak), but you could also use [Authelia](https://www.authelia.com/), a VPN or web server and firewall rules. Instructions for all of these can be found [in the docs](docs/authentication.md#alternative-authentication-methods).

For full docs, see: **[Documentation Contents](./docs/readme.md)** #### Running Dashy -- 🚀 [Deployment](/docs/deployment.md) - Getting Dashy up and running +- 💨 [Quick Start](/docs/quick-start.md) - TDLR guide on getting Dashy up and running in under 5 minutes +- 🚀 [Deployment](/docs/deployment.md) - Full guide on setting up Dashy on various different environments - 🔧 [Configuring](/docs/configuring.md) - Complete list of all available options in the config file - 💻 [Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc - 🚒 [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them @@ -564,6 +565,7 @@ If you're new to web development, I've put together a short [list of resources]( #### Feature Docs - 🛡️ [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard +- 🧿 [Alternate Views](/docs/alternate-views.md) - Outline of available pages / views and item opening methods - 💾 [Backup & Restore](/docs/backup-restore.md) - Guide to Dashy's cloud sync feature - 🚦 [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps - 🧸 [Icons](/docs/icons.md) - Outline of all available icon types for sections and items