ExpressFS - Simple Static File Server

A modern, feature-rich static file server built with Express.js, featuring file upload, pagination, progress tracking, and an intuitive web interface.

Features

• 📤 Multiple File Upload - Upload single or multiple files with drag-and-drop support
• 📊 Real-time Progress Tracking - Individual progress bars for each file upload
• 📄 Pagination - Browse files with configurable pagination (10, 50, or 100 files per page)
• 💾 File Management - View, download, and delete files through a clean web interface
• 📈 Summary Dashboard - Real-time statistics showing total files and storage used
• 🔒 Input Validation - Built-in security and validation middleware
• 📝 Comprehensive Logging - Structured logging for all operations
• 🎨 Modern UI - Responsive design with smooth animations

Project Structure

expressfs/
├── app.js                  # Main application entry point
├── config/
│   └── config.js          # Application configuration
├── middleware/
│   ├── errorHandler.js    # Error handling middleware
│   └── validator.js       # Request validation middleware
├── routes/
│   └── fileRoutes.js      # File management API routes
├── utils/
│   ├── logger.js          # Logging utility
│   └── fileHelper.js      # File operations helper
├── public/
│   ├── index.html         # Main HTML page
│   ├── css/
│   │   └── styles.css     # Application styles
│   └── js/
│       └── app.js         # Frontend JavaScript
├── store/                 # File storage directory
├── package.json           # Dependencies and scripts
├── .env.example          # Environment variables example
└── README.md             # This file

Installation

Prerequisites

• Node.js (v14 or higher)
• npm or yarn

Local Installation

1. Clone the repository:

git clone <repository-url>
cd expressfs

2. Install dependencies:

npm install

3. Create environment file (optional):

cp .env.example .env
# Edit .env with your preferred settings

4. Start the server:

npm start

5. Open your browser and navigate to:

http://localhost:8080

Configuration

Configuration can be set via environment variables or by editing config/config.js.

Environment Variables

• PORT - Server port (default: 8080)
• HOST - Server host (default: 0.0.0.0)
• NODE_ENV - Environment mode (development/production)
• MAX_FILE_SIZE - Maximum file size in human-readable format (default: 5GB)
  • Supports: KB, MB, GB, TB (case-insensitive)
  • Examples: "5GB", "100MB", "1.5TB", "500KB"
• STORE_DIRECTORY - Directory for uploaded files (default: store)

Configuration Options

Edit config/config.js to customize:

• Server settings - Port, host
• Upload limits - Max file size, allowed extensions
• Pagination - Default items per page, allowed limits
• Logging - Enable/disable logging, timestamp format

API Endpoints

GET /api/files

Get paginated list of files with metadata.

Query Parameters:

• page - Page number (default: 1)
• limit - Items per page (10, 50, or 100)

Response:

{
  "files": [...],
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalFiles": 42,
    "totalSize": 1048576,
    "filesPerPage": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

POST /api/upload

Upload single or multiple files.

Request: multipart/form-data with target_file field

Response:

{
  "success": true,
  "message": "Successfully uploaded 3 file(s)",
  "results": [...]
}

POST /api/delete

Delete multiple files.

Request Body:

{
  "files": ["file1.txt", "file2.pdf"]
}

Response:

{
  "success": true,
  "message": "Files deleted successfully",
  "results": [...]
}

Docker Deployment

Build Docker Image

docker build -t expressfs:latest .

Run Container

docker run -d -p 8080:8080 --name expressfs expressfs:latest

Using Docker Compose

version: '3.8'
services:
  expressfs:
    image: expressfs:latest
    ports:
      - "8080:8080"
    volumes:
      - ./store:/app/store
    environment:
      - NODE_ENV=production
      - PORT=8080

OpenShift Deployment

Quick Deploy

Deploy ExpressFS to OpenShift with a single command:

oc apply -f openshift/expressfs-deployment.yaml

This creates:

• Deployment with health checks and resource limits
• Service for internal cluster communication
• Route for external access
• PersistentVolumeClaim (10Gi) for file storage

Access the Application

# Get the route URL
oc get route expressfs -o jsonpath='{"https://"}{.spec.host}{"\n"}'

Verify Deployment

# Check all resources
oc get all -l app=expressfs

# View logs
oc logs -l app=expressfs -f

Detailed Instructions

For comprehensive deployment instructions, troubleshooting, scaling, monitoring, and advanced configuration, see:

📖 OpenShift Deployment Guide

The guide includes:

• Step-by-step deployment instructions
• Configuration options
• Scaling and updates
• Troubleshooting tips
• Security best practices
• Backup and restore procedures
• Advanced configurations

Development

Running in Development Mode

NODE_ENV=development npm start

Project Scripts

• npm start - Start the server
• npm test - Run tests (to be implemented)

Security Considerations

• File upload size limits are enforced
• Filename validation prevents directory traversal attacks
• Input validation on all API endpoints
• CORS can be configured in app.js if needed
• Consider adding authentication for production use

Performance Optimization

• Static files are served with Express static middleware
• Pagination reduces memory usage for large file lists
• Async/await pattern for non-blocking operations
• Efficient file streaming for uploads

Troubleshooting

Port Already in Use

Change the port in .env or config/config.js

Upload Fails

• Check file size limits in configuration
• Ensure store directory has write permissions
• Check available disk space

Files Not Showing

• Verify store directory exists
• Check file permissions
• Review server logs for errors

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

License

ISC License

Author

Daniel Istrate

Version History

• 2.0.0 - Major refactor with modular architecture, pagination, multi-file upload
• 1.0.0 - Initial release with basic file upload/download functionality

Support

For issues and questions, please open an issue on the repository.