Odyssey Dashboard

Odyssey Dashboard — это легкая и быстрая стартовая страница для вашего сервера. Она позволяет организовать ссылки на ваши сервисы, веб-сайты и инструменты в удобном и минималистичном интерфейсе. Вся конфигурация управляется одним простым JSON-файлом.

🚀 Особенности

• Минимализм: Чистый интерфейс без лишних элементов.
• Простая настройка: Конфигурация через понятный json файл.
• Docker-first: Легкое развертывание через Docker Compose.
• Кастомизация: Поддержка групп сервисов и собственных иконок.

🛠 Установка и запуск

Для запуска рекомендуется использовать Docker Compose.

1. Подготовка директорий

Создайте папку для проекта и необходимую структуру:

mkdir -p odyssey-dashboard/public/icons
cd odyssey-dashboard

2. Создание docker-compose.yml

Создайте файл docker-compose.yml со следующим содержимым:

services:
  odyssey-dashboard:
    image: sterrist/odyssey-dashboard:latest
    container_name: odyssey-dashboard
    restart: unless-stopped
    ports:
      - "3000:3000"
    volumes:
      - ./public:/app/public
    environment:
      - NODE_ENV=production

3. Создание конфигурации

В папке public создайте файл config.json. Вы можете использовать этот пример как шаблон:

{
    "title": "Odyssey Dashboard",
    "subtitle": "Home",
    "services": [
        {
        "groupName": "// Git",
        "items": [
            {
            "name": "GitHub",
            "externalUrl": "https://github.com/Sterrist/OdysseyDashboard",
            "logo": "/icons/icon.jpg"
            }
        ]
        }
    ]
}

4. Запуск

Запустите контейнер:

docker compose up -d

Дашборд будет доступен по адресу: http://localhost:3000 (или IP вашего сервера).

---

⚙️ Конфигурация

Все настройки хранятся в файле public/config.json. Изменения в этом файле применяются мгновенно после обновления страницы в браузере.

Структура config.json

Поле	Тип	Описание
title	string	Заголовок вкладки браузера и страницы.
subtitle	string	Подзаголовок (например, название сервера или "Home").
services	array	Массив групп сервисов.

Объект сервиса (внутри массива services)

Поле	Тип	Описание
groupName	string	Название категории (группы) сервисов.
items	array	Список ссылок внутри этой группы.

Объект элемента (внутри массива items)

Поле	Тип	Описание
name	string	Отображаемое имя сервиса.
externalUrl	string	Ссылка на сервис (http/https).
logo	string	Путь к иконке. Должен начинаться с /.

📂 Структура проекта

После настройки ваша директория должна выглядеть так:

.
├── docker-compose.yml
└── public/
    ├── config.json
    └── icons/
        ├── icon.jpg
        └── ...