marcandClaude Sonnet 4.6
96055e6375
app.py: - Remove 'raw' field from export dict entries (only comment/blank kinds need raw; export entries are always reconstructed from path/rest/enabled when writing back) - Remove extra blank line shares.js: - Remove unused pathJson variable in SMB row (was only needed for the quota button, which was removed) docker-compose.yml: - Deleted entirely: was missing templates/ and static/ mounts so the Flask app couldn't serve pages; SYS_ADMIN cap_add was only needed for quotas; deployment is systemd, not Docker README.md: - Remove quota package from apt install command - Remove quota setup section (feature removed) - Remove docker-compose from Dev section CLAUDE.md / PLANNING.md: - Remove docker-compose.yml references and quotas.js from file tree .gitignore: - Remove redundant micronas.env entry (already covered by *.env) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
90 lines
2.1 KiB
Markdown
90 lines
2.1 KiB
Markdown
# MicroNAS
|
|
|
|
Lightweight web GUI to manage SMB shares, NFS exports, quotas, and users on a single home server (Proxmox LXC/VM). Runs directly on the host as a systemd service.
|
|
|
|
## Proxmox LXC setup
|
|
|
|
Use a **privileged** Debian/Ubuntu container — required for the NFS server kernel module and quotas.
|
|
|
|
On the **Proxmox host**, load the NFS kernel module before starting the container:
|
|
|
|
```bash
|
|
modprobe nfsd
|
|
echo nfsd >> /etc/modules
|
|
```
|
|
|
|
## Install
|
|
|
|
Run everything below **inside the LXC container** as root.
|
|
|
|
### 1. System dependencies
|
|
|
|
```bash
|
|
apt update
|
|
apt install -y git samba nfs-kernel-server python3 python3-venv
|
|
```
|
|
|
|
### 2. Clone the repo
|
|
|
|
```bash
|
|
git clone https://gitea.honeyy.duckdns.org/Honey/MicroNAS.git /opt/micronas
|
|
```
|
|
|
|
### 3. Python environment
|
|
|
|
```bash
|
|
python3 -m venv /opt/micronas/venv
|
|
/opt/micronas/venv/bin/pip install flask gunicorn
|
|
```
|
|
|
|
### 4. Credentials
|
|
|
|
```bash
|
|
cat > /etc/micronas.env <<EOF
|
|
MICRONAS_USER=admin
|
|
MICRONAS_PASS=changeme
|
|
EOF
|
|
chmod 600 /etc/micronas.env
|
|
```
|
|
|
|
### 5. systemd service
|
|
|
|
```bash
|
|
cp /opt/micronas/micronas.service /etc/systemd/system/
|
|
systemctl daemon-reload
|
|
systemctl enable --now micronas
|
|
```
|
|
|
|
Open `http://<lxc-ip>:5000` in your browser.
|
|
|
|
---
|
|
|
|
## Updates
|
|
|
|
```bash
|
|
cd /opt/micronas
|
|
git pull
|
|
systemctl restart micronas
|
|
```
|
|
|
|
## Network
|
|
|
|
The service binds to `0.0.0.0:5000` — accessible from any LAN device at `http://<lxc-ip>:5000`.
|
|
|
|
For HTTPS, put nginx in front as a reverse proxy.
|
|
|
|
LAN or Tailscale only — never expose to the internet.
|
|
|
|
## Dev / test
|
|
|
|
```bash
|
|
# Quick local run (no gunicorn needed, must have flask installed):
|
|
MICRONAS_USER=admin MICRONAS_PASS=secret flask --app app.py run --debug --host=0.0.0.0
|
|
```
|
|
|
|
Note: SMB/NFS/user management calls require root and the relevant daemons — run on the actual LXC for full testing.
|
|
|
|
## Auth
|
|
|
|
All routes require a login session. Go to `http://<lxc-ip>:5000` — you will be redirected to the login page automatically. Credentials come from `MICRONAS_USER` / `MICRONAS_PASS` in `/etc/micronas.env`. If `MICRONAS_PASS` is not set the app starts unprotected and logs a warning — do not do this in production.
|