nbarrett36/ngx-ramblers

NGX-Ramblers 镜像文档

1. 镜像概述

NGX-Ramblers是一款专为本地漫步者团体设计的开源网站构建框架，旨在帮助小型户外组织快速搭建和部署功能完善的官方网站。该框架集成了基础网站所需的核心功能，提供简洁的配置方式和可定制化选项，降低技术门槛，使非专业开发者也能轻松维护团体在线平台。

2. 核心功能与特性

• 开源免费：基于开源协议发布，允许自由使用、修改和二次开发
• 团体专属功能：内置漫步者团体所需的活动发布、路线分享、成员互动等模块
• 响应式设计：自动适配桌面端、移动端等多种设备显示需求
• 轻量化架构：资源占用低，部署简单，适合小型服务器或共享主机环境
• 可定制主题：支持通过配置文件自定义网站颜色、布局和品牌元素
• 内容管理：提供简易的后台管理界面，支持文章、图片、活动信息的发布与维护

3. 使用场景与适用范围

• 本地漫步者/徒步爱好者团体官方网站建设
• 小型户外俱乐部（如登山、健走、骑行团体）的在线活动平台
• 社区级户外组织的信息展示与成员互动网站
• 学校、企业内部徒步兴趣小组的活动管理系统

4. 使用方法与配置说明

4.1 快速启动（Docker Run）

通过以下命令可快速启动基础版本实例：

bash
docker run -d \
  --name ngx-ramblers \
  -p 80:80 \
  -e SITE_NAME="本地漫步者团体" \
  -e ADMIN_EMAIL="admin@example.com" \
  ngx-ramblers:latest

4.2 Docker Compose 配置（推荐）

使用Docker Compose可更方便地管理依赖服务（如数据库），创建docker-compose.yml文件：

yaml
version: '3.8'

services:
  web:
    image: ngx-ramblers:latest
    container_name: ngx-ramblers-web
    ports:
      - "80:80"
    environment:
      - SITE_NAME="青山漫步者协会"
      - ADMIN_EMAIL="admin@qingshan-ramblers.org"
      - DB_TYPE=sqlite  # 可选：sqlite/mysql/postgresql
      - DB_FILE=/data/site.db
    volumes:
      - ./data:/data  # 持久化存储网站数据
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

4.3 核心配置参数

通过环境变量进行配置，主要参数说明：

4.4 数据持久化

为防止容器重启导致数据丢失，需挂载数据卷存储用户上传内容、数据库文件和配置：

bash
docker run -d \
  --name ngx-ramblers \
  -p 80:80 \
  -v /path/to/local/data:/data \  # 本地目录映射到容器内/data
  ngx-ramblers:latest

5. 初始化与访问

1. 容器启动后，访问 http://服务器IP 即可打开网站前台
2. 后台管理地址：http://服务器IP/admin
3. 首次登录：使用配置的ADMIN_EMAIL，初始密码为admin123（登录后需立即修改）

6. 注意事项

• 生产环境中建议修改默认管理员密码，并启用HTTPS（可配合Nginx反向代理实现）
• 定期备份挂载的/data目录，防止数据丢失
• 如需自定义主题，可将主题文件挂载到/app/themes/custom目录
• 升级镜像时，需确保数据卷正确挂载，避免配置和用户数据丢失