uuxo/hmac-file-server
1
1
Fork 0
Code Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Files
da403de11137800370faea689f9956fd8ea9ec43
hmac-file-server/QUICKINSTALL.md

312 lines
7.9 KiB
Markdown
Raw Blame History

# HMAC File Server 3.3.0 "Nexus Infinitum" - Quick Install Guide ⚡
**Get started in under 2 minutes!**
---
## 🚀 **Super Quick Start (30 seconds)**
```bash
# Option A: Use pre-built local binaries (if available)
cd hmac-file-server
./builds/hmac-file-server-linux-amd64 -genconfig > config.toml
./builds/hmac-file-server-linux-amd64 -config config.toml
# Option B: Download from releases (when available)
wget https://git.uuxo.net/uuxo/hmac-file-server/releases/download/v3.3.0/hmac-file-server-linux-amd64
chmod +x hmac-file-server-linux-amd64
./hmac-file-server-linux-amd64 -genconfig > config.toml
./hmac-file-server-linux-amd64 -config config.toml
```
**That's it!** Your server is running on `http://localhost:8080` 🎉
---
## 📦 **Choose Your Installation Method**
### 1. **Binary Download** (Recommended)
```bash
# Option A: Use local builds (if cloned from git)
cd hmac-file-server
./builds/hmac-file-server-linux-amd64 -genconfig > config.toml
# Available: builds/hmac-file-server-linux-{amd64,arm64,arm}
# Also: builds/hmac-file-server-darwin-{amd64,arm64}
# Option B: Download from releases
wget https://git.uuxo.net/uuxo/hmac-file-server/releases/download/v3.3.0/hmac-file-server-linux-amd64
# ARM64: hmac-file-server-linux-arm64
# ARM32: hmac-file-server-linux-arm
chmod +x hmac-file-server-linux-amd64
# Generate configuration
./hmac-file-server-linux-amd64 -genconfig > config.toml
# Edit these 3 essential settings in config.toml:
# bind_ip = "0.0.0.0" # Listen on all interfaces
# listenport = "8080" # Your desired port
# storage_path = "./uploads" # Where to store files
./hmac-file-server-linux-amd64 -config config.toml
```
### 2. **Docker** (Container Deployment)
```bash
# Pull and run
docker pull hmac-file-server:3.3.0
docker run -d --name hmac-server \
-p 8080:8080 \
-v ./uploads:/app/uploads \
hmac-file-server:3.3.0
```
### 3. **Automated Installer** (Full Setup)
```bash
# Download and run installer (when available)
wget https://git.uuxo.net/uuxo/hmac-file-server/raw/main/installer.sh
chmod +x installer.sh
sudo ./installer.sh
# Or use local installer if cloned
sudo ./installer.sh
```
### 4. **Build from Source** (Developers)
```bash
# Clone and build
git clone https://git.uuxo.net/uuxo/hmac-file-server.git
cd hmac-file-server
# Option A: Interactive multi-arch builder
./build-multi-arch.sh
# Then use: ./builds/hmac-file-server-linux-amd64
# Option B: Quick single build
go build -o hmac-file-server ./cmd/server/
./hmac-file-server -genconfig > config.toml
./hmac-file-server -config config.toml
```
---
## ⚙️ **Essential Configuration (2 minutes)**
### Minimal Configuration (Just Works!)
```toml
# config.toml - Only 2 lines needed!
[server]
storage_path = "./uploads"
```
### Basic Production Configuration
```toml
[server]
bind_ip = "0.0.0.0"
listenport = "8080"
storage_path = "/data/uploads"
hmac_secret = "your-secret-key-here"
max_upload_size = "100MB"
[security]
require_hmac = true
```
### Mobile-Optimized Configuration
```toml
[server]
bind_ip = "0.0.0.0"
listenport = "8080"
storage_path = "./uploads"
[network_resilience]
enable_network_resilience = true
grace_period_hours = 72
detect_network_changes = true
[client_network_support]
enable_client_network_support = true
mobile_grace_hours = 72
desktop_grace_hours = 48
```
---
## 🔧 **Quick Configuration Options**
### Using Pre-Built Binaries
If you cloned the repository, you'll find ready-to-use binaries in the `builds/` directory:
```bash
# List available architectures
ls builds/
# hmac-file-server-darwin-amd64 # macOS Intel
# hmac-file-server-darwin-arm64 # macOS Apple Silicon
# hmac-file-server-linux-386 # Linux 32-bit
# hmac-file-server-linux-amd64 # Linux 64-bit (most common)
# hmac-file-server-linux-arm # Linux ARM 32-bit (Raspberry Pi 3)
# hmac-file-server-linux-arm64 # Linux ARM 64-bit (Raspberry Pi 4+)
# Use the appropriate one for your system
./builds/hmac-file-server-linux-amd64 -genconfig > config.toml
```
### Build More Architectures
```bash
# Interactive builder for all platforms
./build-multi-arch.sh
# Quick Docker multi-arch build
./docker-multiarch-build.sh --local
```
### Generate Configuration Templates
```bash
# Using local builds
./builds/hmac-file-server-linux-amd64 -genconfig > config.toml # Basic config
./builds/hmac-file-server-linux-amd64 -genconfig-mobile > mobile.toml # Mobile-optimized
./builds/hmac-file-server-linux-amd64 -genconfig-enterprise > enterprise.toml # Enterprise config
# Or using downloaded binary
./hmac-file-server -genconfig > config.toml # Basic config
./hmac-file-server -genconfig-mobile > mobile.toml # Mobile-optimized
./hmac-file-server -genconfig-enterprise > enterprise.toml # Enterprise config
```
### Validate Configuration
```bash
./hmac-file-server -config config.toml --validate # Check configuration
./hmac-file-server -config config.toml --validate-quiet # Silent validation
```
### Test Configuration
```bash
./hmac-file-server -config config.toml --check # Dry run test
```
---
## 🌐 **Integration with XMPP**
### ejabberd Configuration
```yaml
# ejabberd.yml - Add to modules section
modules:
mod_http_upload:
put_url: "http://your-server:8080/upload"
get_url: "http://your-server:8080/file"
secret: "your-hmac-secret"
max_size: 104857600 # 100MB
```
### Prosody Configuration
```lua
-- prosody.cfg.lua
Component "upload.yourdomain.com" "http_upload"
http_upload_url = "http://your-server:8080/upload"
http_upload_file_size_limit = 100 * 1024 * 1024 -- 100MB
```
---
## 🔍 **Verify Installation**
### Check Server Status
```bash
# Test server is running
curl http://localhost:8080/health
# Check version (using local builds)
./builds/hmac-file-server-linux-amd64 -version
# Or using downloaded binary
./hmac-file-server -version
# View configuration
./hmac-file-server -config config.toml --validate
```
### Test Upload (with XMPP client)
1. **Configure your XMPP client** with the server URL
2. **Send a file** in any chat
3. **Verify upload** in the `uploads` directory
---
## 🆘 **Troubleshooting**
### Common Issues
**❌ Port already in use**
```bash
# Change port in config.toml
listenport = "8081" # Use different port
```
**❌ Permission denied**
```bash
# Create uploads directory with proper permissions
mkdir -p uploads
chmod 755 uploads
```
**❌ XMPP upload fails**
```bash
# Use the XMPP client fixing tool
./fix_xmpp_clients.sh
```
**❌ Network switching issues**
```bash
# Test network resilience
./verify_network_resilience.sh
```
### Get Help
- **Documentation**: [Complete WIKI](WIKI.MD)
- **Issues**: [Git Issues](https://git.uuxo.net/uuxo/hmac-file-server/issues)
- **Support**: [Git Repository](https://git.uuxo.net/uuxo/hmac-file-server/)
---
## 🎯 **Next Steps**
### Production Deployment
1. **Set up reverse proxy** (nginx/Apache)
2. **Configure SSL/TLS** certificates
3. **Set up systemd service** for auto-start
4. **Configure monitoring** and logging
5. **Set up backup** for uploads directory
### Advanced Features
- **Multi-architecture deployment** with `./build-multi-arch.sh`
- **Docker multi-platform** with `./docker-multiarch-build.sh`
- **Network resilience testing** with `./verify_network_resilience.sh`
- **Desktop client optimization** with `./fix_xmpp_clients.sh`
---
## 🚀 **You're Ready!**
Your HMAC File Server 3.3.0 "Nexus Infinitum" is now running and ready for infinite connectivity!
**What you get:**
- ✅ **Secure file uploads** with HMAC authentication
- ✅ **Multi-architecture support** (AMD64, ARM64, ARM32v7)
- ✅ **Network resilience** for mobile scenarios
- ✅ **Desktop XMPP client** optimization
- ✅ **Zero-downtime** network switching
- ✅ **Enterprise-grade** reliability
**Server URL**: `http://your-server:8080`
**Health Check**: `http://your-server:8080/health`
Enjoy boundless file sharing! 🌟
---
*HMAC File Server 3.3.0 "Nexus Infinitum" - Where Infinite Connectivity Meets Simplicity*
View Git Blame Copy Permalink