CachyOS Repository Dashboard

The web dashboard for the CachyOS repositories provides a user-friendly interface to search and view packages.

Prerequisites

• Node.js (v20 or later)
• Bun (v1.2 or later)

Installation

1. Clone the repository:

   git clone https://github.com/cachyos/public-dashboard.git
   cd public-dashboard

2. Install the dependencies:

   bun --bun install

3. Start the development server:

   bun --bun run dev

The application will be available at http://localhost:3000.

Building for Production

To create a production-ready build, run the following command:

bun --bun run build

This will create an optimized build in the .next directory. To run the production server, use:

bun ./next/standalone/server.js

PS: Check https://nextjs.org/docs/app/api-reference/config/next-config-js/output#automatically-copying-traced-files for any additional steps such as copying static files.

Environment Variables

API URL

• NEXT_PUBLIC_ENDPOINT_URL : Set this environment variable to change the API endpoint URL (default: http://localhost:5862/api).

Redis Cache

• CACHE: Set to redis to enable Redis caching.
• REDIS_URL: Redis server URL (default: http://localhost:6379).
• REDIS_MASTER_NAME: Redis master name (default: shard_master0).
• REDIS_PASSWORD: Redis password (default: 1234).
• REDIS_SENTINEL_PASSWORD: Sentinel password (default: 1234).
• REDIS_KEY_PREFIX: Prefix for Redis keys (default: nextjs:).
• NEXT_PRIVATE_DEBUG_CACHE: (Optional) Enables verbose cache logging.

NB: If CACHE is not set to redis, only in-memory caching will be used.

Building and Running with Docker

You can also build and run the web dashboard using Docker.

Build the Docker Image

To build the Docker image, run the following command from the root directory:

docker build -t public-repo-dashboard .

An optional --build-arg NEXT_PUBLIC_APP_VERSION=$(git rev-parse --short HEAD) can be used to include the current Git commit in the dashboard's <meta> tag during the build.

Run the Docker Container

To run the Docker container, use the following command:

docker run -p 3000:3000 public-repo-dashboard

The application will be available at http://localhost:3000.