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>:8090setup.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-panelFAQ
Panel not accessible
- Check service:
sudo systemctl status nas-panel - Check port:
sudo ss -tlnp | grep 8090 - Check firewall:
sudo ufw status(need to allow 8090) - Logs:
sudo journalctl -u nas-panel -f
Samba connection failed
- Service running:
sudo systemctl status smbd - User exists:
sudo smbpasswd -L -v <username> - Firewall allows 139/445
- 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-panelDisk not showing
- System recognizes it:
lsblk - SMART readable:
sudo smartctl -a /dev/sdX - Refresh panel: Storage → Refresh button
- LVM member not showing: verify
sudo pvsoutput
RAID sync progress
bash
cat /proc/mdstat
# Or via panel: Storage → Pool → RAID status shows sync percentageDeveloper Docs
| Doc | Content |
|---|---|
| Architecture v1.0 | Architecture constitution, 20 recommendations review |
| Product Manual | Full deployment/usage docs |
| CHANGELOG | Version history |
| TODO | Roadmap (26 items, 15 done) |
| CONTRIBUTING.md | Contributor guide |
Service Ports
| Port | Service | Description |
|---|---|---|
| 22 | SSH | Remote management |
| 21 | FTP | vsftpd |
| 80 | HTTP | Optional, reverse proxy |
| 139, 445 | Samba | File sharing |
| 137-138 | NetBIOS | Name service |
| 2049 | NFS | Linux file sharing |
| 8080 | WebDAV | rclone serve webdav |
| 8081 | FileBrowser | Web file manager |
| 9000 | S3 | rclone serve s3 |
| 8090 | Z1 Panel | Management panel |