Rename project to MicroNAS

This commit is contained in:
Honey committed 2026-06-19 21:06:15 +02:00
1 parent f2aca2e3ea
commit 10a1e24420
5 files changed
+23 -23

No files matched your search

+12 -12
View File
@@ -1,4 +1,4 @@
# Fileshare Web
# MicroNAS
Lightweight web GUI to manage SMB shares, NFS exports, and quotas on a single home server (Proxmox LXC/VM). Runs directly on the host as a systemd service.
@@ -12,23 +12,23 @@ apt install samba nfs-kernel-server quota python3 python3-venv
```bash
# Copy files
cp -r . /opt/fileshare-web
cp -r . /opt/micronas
# Create virtualenv and install deps
python3 -m venv /opt/fileshare-web/venv
/opt/fileshare-web/venv/bin/pip install flask gunicorn
python3 -m venv /opt/micronas/venv
/opt/micronas/venv/bin/pip install flask gunicorn
# Create environment file with your credentials
cat > /etc/fileshare-web.env <<EOF
FILESHARE_USER=admin
FILESHARE_PASS=changeme
cat > /etc/micronas.env <<EOF
MICRONAS_USER=admin
MICRONAS_PASS=changeme
EOF
chmod 600 /etc/fileshare-web.env
chmod 600 /etc/micronas.env
# Install and enable the systemd service
cp /opt/fileshare-web/fileshare-web.service /etc/systemd/system/
cp /opt/micronas/micronas.service /etc/systemd/system/
systemctl daemon-reload
systemctl enable --now fileshare-web
systemctl enable --now micronas
```
The app listens on `127.0.0.1:5000`. Put a reverse proxy (nginx) in front if you want HTTPS, or reach it directly on the LAN by binding to `0.0.0.0:5000` (change `-b` in the unit file).
@@ -36,11 +36,11 @@ The app listens on `127.0.0.1:5000`. Put a reverse proxy (nginx) in front if you
## Dev / test
```bash
FILESHARE_USER=admin FILESHARE_PASS=secret flask --app app run --debug
MICRONAS_USER=admin MICRONAS_PASS=secret flask --app app run --debug
# or with docker-compose for a sandbox:
docker compose up
```
## Auth
Set `FILESHARE_USER` and `FILESHARE_PASS` in the environment (or `EnvironmentFile`). All routes require HTTP Basic Auth. Never expose this to the internet — LAN or Tailscale only.
Set `MICRONAS_USER` and `MICRONAS_PASS` in the environment (or `EnvironmentFile`). All routes require HTTP Basic Auth. Never expose this to the internet — LAN or Tailscale only.