Community
Project Info
Z1 is an open-source project, licensed under GNU AGPLv3.
| Resource | URL |
|---|---|
| Gitee Repo | https://gitee.com/gitdogcat/nas |
| Website Repo | https://gitee.com/gitdogcat/nas-website |
| Issues | https://gitee.com/gitdogcat/nas/issues |
| Architecture Doc | Architecture v1.0 |
| Product Manual | Manual |
| Changelog | CHANGELOG |
| Roadmap | TODO |
Contributing
File an Issue
Found a bug or have a feature suggestion?
- Search for existing issues first
- Describe clearly: environment, reproduction steps, expected vs actual behavior
- Attach logs/screenshots if possible
Submit a PR
bash
# 1. Fork the repo
# 2. Clone your fork
git clone https://gitee.com/your-username/nas.git
# 3. Create branch
git checkout -b feat/your-feature
# 4. Commit
git add -A
git commit -m "feat: your feature description"
# 5. Push and create PR
git push origin feat/your-featureContribution Areas
| Area | Needs |
|---|---|
| 🔧 Development | See TODO.md open items |
| 🐛 Bug Fixes | Check Issues list |
| 📖 Documentation | Manuals, guides, FAQ |
| 🎨 UI/UX | Design System component improvements |
| 🌐 i18n | Translation help for other languages |
| 🧪 Testing | Unit/integration/hardware compatibility tests |
Tech Stack
| Component | Technology | Version |
|---|---|---|
| Backend | Go | 1.25 |
| Frontend | Alpine.js | 3.x |
| OS | Debian | 13 (trixie) |
| File Sharing | Samba | 4.x |
| RAID | mdadm | latest |
| Logical Volume | LVM2 | latest |
| Firewall | UFW + Fail2ban | latest |
| Remote Sync | rclone | 1.74+ |
| File Manager | FileBrowser | latest |
| Site Builder | VitePress | 1.6+ |
Third-Party Dependencies
| Component | Purpose | License |
|---|---|---|
| Samba | SMB file sharing | GPL |
| NFS | Linux file sharing | GPL |
| vsftpd | FTP service | GPL |
| rclone | Remote sync/S3/WebDAV | MIT |
| mdadm | RAID management | GPL |
| LVM2 | Logical volume management | GPL |
| UFW | Firewall | GPL |
| Fail2ban | Intrusion protection | GPL |
| FileBrowser | Web file manager | MIT |
| Alpine.js | Frontend framework | MIT |