Dashwise Deployment and Usage Guide

This guide provides comprehensive instructions for deploying and using Dashwise, an all-in-one homelab dashboard.

1. Prerequisites

Before you begin, ensure you have the following installed on your system:

• Docker & Docker Compose: Dashwise is designed to be deployed using Docker.
  • Install Docker Engine
  • Install Docker Compose
• Git: For cloning the repository.
  • Install Git

2. Installation

Dashwise is deployed using Docker Compose.

1. Clone the Repository:

   git clone https://github.com/andreasmolnardev/dashwise.git
   cd dashwise
   

2. Download Docker Compose File: Obtain the docker-compose.yaml file from the repository. You can do this by navigating to the repository on GitHub and downloading the file directly, or by copying its content into a new file named docker-compose.yaml in your dashwise directory.

3. Configuration

Dashwise relies on environment variables for both the main application and the jobs runner.

3.1. Main Application Configuration

Edit the docker-compose.yaml file and set the following environment variables for the dashwise service. It's recommended to create a .env file in the same directory as your docker-compose.yaml to manage these variables.

| Name | Required | Default Value | Description PBNEXT_PUBLIC_PB_URLPB_ADMIN_EMAILPB_ADMIN_PASSWORDNEXT_PUBLIC_APP_URLNEXT_PUBLIC_ENABLE_SSO_NEXT_PUBLIC_DEFAULT_BG_URLNEXT_PUBLIC_JOBS_WEBHOOK_ENABLENEXT_PUBLIC_JOBS_URLtrue | http://pocketbase:8090 | default@dashwise.local | DashwiseIsAwesome | http://localhost:3000 | false | /dashboard-wallpaper.png | false | http://127.0.0.1:3001 | URL of the PocketBase instance. | Email of the PocketBase admin user. Crucial for initial setup. | Password of the PocketBase admin user. Crucial for initial setup. | The public URL where the Dashwise application is accessible. | Set to true to enable Single Sign-On (SSO) via OIDC. | The default background image URL for new users. | Explicitly enable the jobs webhook. Set to 1 or true to force-enable. | URL of the jobs webhook endpoint. If set, jobs webhook is automatically enabled.

3.2. Jobs Runner Configuration

These environment variables configure the dashwise-jobs service.

| Name | Required | Default Value | Description