59 lines
1.7 KiB
Markdown
59 lines
1.7 KiB
Markdown
# Dashlio
|
|
|
|
A dynamic, YAML-driven dashboard application.
|
|
|
|
## Setup & Installation
|
|
|
|
### 1. Build the Docker Image
|
|
|
|
First, you need to build the Docker image for the project. You can do this by using the provided PowerShell script or manually via the Docker CLI.
|
|
|
|
**Option A: Using the build script (Windows/PowerShell)**
|
|
1. Set up the build script with your details. If you haven't already, copy the example script:
|
|
```powershell
|
|
cp docker-build.example.ps1 docker-build.ps1
|
|
```
|
|
2. Edit `docker-build.ps1` to include your correct image details and tags.
|
|
3. Run the script:
|
|
```powershell
|
|
.\docker-build.ps1
|
|
```
|
|
|
|
**Option B: Manual Build**
|
|
Alternatively, you can build the image manually using the Docker CLI:
|
|
```bash
|
|
docker build -t dashlio .
|
|
```
|
|
|
|
### 2. Run the Docker Container
|
|
|
|
Next, run the Docker container. Ensure you map the container to port `3000` and mount your `dashboard.yml` configuration file.
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name dashlio \
|
|
-p 3000:3000 \
|
|
-v ./app/dashboard.yml:/app/app/dashboard.yml \
|
|
dashlio
|
|
```
|
|
|
|
*(Note: If you are using `docker-compose.yml`, you can also bring up the stack with `docker compose up -d`)*
|
|
|
|
### 3. Configure Your Dashboard
|
|
|
|
With the container running (or before you start it), modify the `app/dashboard.yml` file. Set up your folders, links, and other module configurations exactly how you want your dashboard to look.
|
|
|
|
### 4. Restart to Rebuild
|
|
|
|
After you have modified `app/dashboard.yml`, you need to restart the Docker container. Restarting will trigger a rebuild of the Nuxt app inside the container to apply your changes.
|
|
|
|
```bash
|
|
docker restart dashlio
|
|
```
|
|
|
|
### 5. Access Your Dashboard
|
|
|
|
You're all set! Open your browser and access your shiny new dashboard at:
|
|
|
|
**[http://localhost:3000](http://localhost:3000)**
|