Deployment Guide

Pre-deployment Preparation

Important Note

Before deployment, please create a configuration folder on your NAS, otherwise, you may encounter registration issues.

For example, if you plan to use /docker/leelaa-nav/config as your configuration directory:

mkdir -p /docker/leelaa-nav/config

TerraMaster NAS Deployment (Recommended)

1. Open the Docker application on your TerraMaster NAS

2. Click "Local Images" then click the "Add Image" button in the top right

3. Enter leedaisen/leelaa-nav in the "Image" field, then click "OK" If there's an issue here, it's likely a network problem. You should use a better quality repository. If not available, try registy.n-guangzhou.aliyuncs.com/leedaisen/leelaa-nav

4. Find leedaisen/leelaa-nav in "Local Images", click "Create Container"

5. Configure the container:

   • Name: Any name you like, e.g., leelaa-nav
   • Port mapping:
     • Container port: 8676
     • Host port: 8676 (or another unused port)
   • Directory mapping:
     • Container directory: /app/config
     • Host directory: Choose a local directory, e.g., /docker/leelaa-nav/config

6. Click "Create" to complete deployment

Access http://your-nas-ip:8676 to use the navigation page

Deploy with Docker Compose

1. Create a docker-compose.yml file:

   version: '3'
   services:
     leelaa-nav:
       image: leedaisen/leelaa-nav
       container_name: leelaa-nav
       volumes:
         - <path to app data>:/app/config # Modify this line to your actual NAS path
       ports:
         - 8676:8676
       restart: always

2. Start the container:

   docker-compose up -d

Manual Deployment

1. Clone the repository:

   git clone https://github.com/admin8756/leelaa-nav.git
   cd leelaa-nav

2. Install dependencies:

   pnpm install

3. Build the project:

   pnpm build

4. Start the server:

   pnpm start

Configuration Options

Environment Variables

Create a .env file in the project root:

# Server port (default: 8676)
PORT=8676

# Data storage path (default: ./config)
CONFIG_PATH=/path/to/config

# Disable registration (default: false)
VITE_DISABLE_REGISTER=true

Nginx Configuration

If you want to use Nginx as a reverse proxy:

server {
    listen 80;
    server_name your-domain.com;

    location / {
        proxy_pass http://localhost:8676;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Troubleshooting

Common Issues

1. Cannot access the navigation page:

   • Check if the container is running: docker ps
   • Verify port mapping is correct
   • Check firewall settings

2. Cannot register:

   • Ensure the config directory exists and has proper permissions
   • Check if registration is disabled in environment variables

3. Icons not loading:

   • Check network connectivity to icon sources
   • Try using a different icon source in settings

Logs

View container logs:

docker logs leelaa-nav

Updates

Update to the latest version:

docker pull leedaisen/leelaa-nav
docker-compose up -d