navigation/README_EN.md at main · ponycool/navigation

Cool Code Navigation

A simple and easy-to-use website navigation

Leveraging the mature Codeigniter4 and React technology stacks, combining the efficient data processing capabilities of the backend framework with the excellent interactive experience of the frontend framework, ensures the stable operation of the system.

Cool Code Navigation

A simple and easy-to-use website navigation based on Codeigniter4 and React

Official Website

Preview

Preview created by PicRoll

Installation

System Requirements

We recommend running PHP 8.3 or higher on your server; the default database software is SQLite3, but you can also use MySQL 5.7 or higher, or MariaDB 10.3 or higher. We also recommend Apache or Nginx as reliable options for running Cool Code Navigation, but you can choose other HTTP server software.

Running with Docker

sudo docker run -d --restart=unless-stopped -p 80:80 ponycool/navigation:latest
# Domestic source
sudo docker run -d --restart=unless-stopped -p 80:80 registry.cn-qingdao.aliyuncs.com/ponycool/navigation:latest

# Data persistence. Please use named volume mounting.
docker run -d -p 80:80 -v navigation-data:/opt/navigation/writable/data --name navigation ponycool/navigation:latest
# Domestic source
docker run -d -p 80:80 -v navigation-data:/opt/navigation/writable/data --name navigation registry.cn-qingdao.aliyuncs.com/ponycool/navigation:latest

Usage

Access

After successful installation, access Cool Code Navigation through your browser.

# Frontend
Address: http://<Server IP Address>:<Service Port>
# Backend
Address: http://<Server IP Address>:<Service Port>/admin/
Username: admin
Password: admin123!

Configuration

The JWT secret key must be a 32-character random string. An example is as follows:

jwt.secret = 0W************IZAa

Build Image

# Build image
make build
# Build a specific version of the image
# make -e version=1.0.0 build
# Manually build the image locally
# docker build -t ponycool/navigation:latest .
# Check installed PHP modules. Execute inside the container.
# php -m
# Test the image on port 8080
# docker run -it --rm -p 9000:8080 --name navigation ponycool/navigation:latest