Skip to content

Latest commit

 

History

History
158 lines (104 loc) · 5.97 KB

File metadata and controls

158 lines (104 loc) · 5.97 KB

ElinksBoard

Telegram PHP MySQL License

Modern Panel System | Built on Laravel 11 | Integrated with Logto Authentication

English | 简体中文 | 繁體中文


📖 Introduction

ElinksBoard is a modern panel system built on Laravel 11, focusing on providing a clean and efficient user experience. The latest version is fully integrated with Logto authentication system, providing enterprise-grade identity authentication solutions.

✨ Features

  • 🚀 High Performance - Laravel 11 + Octane for significant performance gains
  • 🔐 Logto Authentication - Enterprise-grade OAuth2/OIDC authentication with SSO, MFA, and social login support
  • 🎨 Modern Interface - React + Shadcn UI admin panel, Vue3 + TypeScript user frontend
  • 📱 Responsive Design - Perfect adaptation to various devices
  • 🐳 Containerized Deployment - Ready-to-use Docker deployment solution
  • 💾 Redis Cache - Complete cache management system with backup, monitoring, and optimization tools
  • 🎯 Optimized Architecture - Better maintainability and scalability

🚀 Quick Start

# 1. Clone repository
git clone --depth 1 https://github.com/ElinksTeam/ElinksBoard
cd ElinksBoard

# 2. Copy Docker Compose configuration
cp compose.sample.yaml docker-compose.yml

# 3. Start services
docker compose up -d
  1. Redis configuration
  2. Logto authentication configuration (Required)
  3. System initialization

Access your site: http://SERVER_IP:7001

⚠️ Important: Complete the first login immediately after installation to obtain administrator privileges!


📋 Detailed Installation Guides

We provide multiple installation methods, choose the one that suits you best:

🐳 Docker Deployment (Recommended)

Method Difficulty Use Case Documentation
Docker Compose ⭐ Easy Beginners, Quick deployment View Tutorial
1Panel ⭐⭐ Medium Visual management View Tutorial
aaPanel + Docker ⭐⭐ Medium Panel users View Tutorial

🖥️ Traditional Deployment

Method Difficulty Use Case Documentation
aaPanel ⭐⭐⭐ Complex Traditional hosting View Tutorial
Manual Installation ⭐⭐⭐⭐ Advanced Custom environment View Tutorial

📖 Documentation

🔧 Installation & Configuration

🔄 Migration Guides

Migrate from other systems to ElinksBoard:

💾 Redis Cache Management

🐳 Docker Documentation

🛠️ Development Documentation

🏗️ Architecture Documentation

🔄 Upgrade Notice

🚨 Important: This version involves significant changes. Please strictly follow the upgrade documentation and backup your database before upgrading. Note that upgrading and migration are different processes, do not confuse them.

🛠️ Tech Stack

  • Backend: Laravel 11 + Octane
  • Admin Panel: React + Shadcn UI + TailwindCSS
  • User Frontend: Vue3 + TypeScript + NaiveUI
  • Deployment: Docker + Docker Compose
  • Caching: Redis + Octane Cache

📷 Preview

Admin Preview

User Preview

⚠️ Disclaimer

This project is for learning and communication purposes only. Users are responsible for any consequences of using this project.

🌟 Maintenance Notice

This project is currently under light maintenance. We will:

  • Fix critical bugs and security issues
  • Review and merge important pull requests
  • Provide necessary updates for compatibility

However, new feature development may be limited.

🔔 Important Notes

  1. Restart required after modifying admin path:
docker compose restart
  1. For aaPanel installations, restart the Octane daemon process

🤝 Contributing

Issues and Pull Requests are welcome to help improve the project.

📈 Star History

Stargazers over time