Skip to content

Support

Deployment

Quick Deploy (10 Steps)

bash
# 1. Install Debian 13 (minimal install)
# 2. Get the project
git clone https://gitee.com/gitdogcat/nas.git ~/soft/nas

# 3. Configure password
cp ~/soft/nas/.env.example ~/soft/nas/.env
# Edit .env (min 12 chars)

# 4. Deploy
sudo bash ~/soft/nas/scripts/setup.sh

# 5. Access panel
# Open http://<NAS IP>:8090

setup.sh automates:

  • System update + tool installation
  • Samba/NFS/FTP/WebDAV service configuration
  • Firewall rules + Fail2ban
  • nas-panel binary + systemd service
  • FileBrowser installation
  • rclone download
  • Monitoring script + cron
  • Backup script + cron

Manual Panel Deploy (on existing NAS)

bash
git clone https://gitee.com/gitdogcat/nas.git ~/soft/nas
cp ~/soft/nas/.env.example ~/soft/nas/.env
# Edit .env

cd ~/soft/nas/web
export GOPROXY=https://goproxy.cn,direct
go build -o nas-panel .
sudo cp nas-panel /usr/local/bin/
sudo systemctl enable nas-panel

FAQ

Panel not accessible

  1. Check service: sudo systemctl status nas-panel
  2. Check port: sudo ss -tlnp | grep 8090
  3. Check firewall: sudo ufw status (need to allow 8090)
  4. Logs: sudo journalctl -u nas-panel -f

Samba connection failed

  1. Service running: sudo systemctl status smbd
  2. User exists: sudo smbpasswd -L -v <username>
  3. Firewall allows 139/445
  4. Windows: \\NAS_IP\share, Mac: smb://NAS_IP

Forgot panel password

bash
grep NAS_PASS ~/soft/nas/.env
sudo nano ~/soft/nas/.env  # Change NAS_PASS
sudo systemctl restart nas-panel

Disk not showing

  1. System recognizes it: lsblk
  2. SMART readable: sudo smartctl -a /dev/sdX
  3. Refresh panel: Storage → Refresh button
  4. LVM member not showing: verify sudo pvs output

RAID sync progress

bash
cat /proc/mdstat
# Or via panel: Storage → Pool → RAID status shows sync percentage

Developer Docs

DocContent
Architecture v1.0Architecture constitution, 20 recommendations review
Product ManualFull deployment/usage docs
CHANGELOGVersion history
TODORoadmap (26 items, 15 done)
CONTRIBUTING.mdContributor guide

Service Ports

PortServiceDescription
22SSHRemote management
21FTPvsftpd
80HTTPOptional, reverse proxy
139, 445SambaFile sharing
137-138NetBIOSName service
2049NFSLinux file sharing
8080WebDAVrclone serve webdav
8081FileBrowserWeb file manager
9000S3rclone serve s3
8090Z1 PanelManagement panel

Licensed under GNU AGPLv3