Files
ironmount/README.md
Nicolas Meienberger a511a9ebc1 docs: update README
2025-10-01 21:36:45 +02:00

2.9 KiB

Ironmount

Keep your volumes in check!
One interface to manage all your storage


Demo

Volume details view with usage statistics and health check status


Intro

Ironmount is an easy to use web interface to manage your remote storage and mount them as local volumes on your server. Docker as a first class citizen, Ironmount allows you to easily mount your remote storage directly into your containers with few lines of code.

Features

https://github.com/nicotsx/ironmount/blob/main/screenshots/volume-creation.png?raw=true

  •   Support for multiple protocols: NFS, SMB, FTP, Directory
  • 📡  Mount your remote storage as local folders
  • 🐳  Docker integration: mount your remote storage directly into your containers via a docker volume syntax
  • 🔍  Keep an eye on your mounts with health checks and automatic remounting on error
  • 📊  Monitor your mounts usage with detailed statistics and graphs

Coming soon

  • 🔐  User authentication and role management
  • 💾  Automated backups and snapshots with encryption, strategies and retention policies
  • 🔄  Re-exporting your mounts to other protocols (e.g. mount an FTP server as an SMB share with fine-grained permissions)
  • ☁️  Integration with cloud storage providers (e.g. AWS S3, Google Drive, Dropbox)
  • 🔀  Storage sharding and replication for high availability and performance

Installation

In order to run Ironmount, you need to have Docker and Docker Compose installed on your server. Then, you can use the provided docker-compose.yml file to start the application.

services:
  ironmount:
    image: nicotsx/ironmount:v0.0.1
    container_name: ironmount
    restart: unless-stopped
    cap_add:
      - SYS_ADMIN
    ports:
      - "4096:4096"
    devices:
      - /dev/fuse:/dev/fuse
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /run/docker/plugins:/run/docker/plugins
      - /var/lib/docker/volumes/:/var/lib/docker/volumes:rshared
      - ironmount_data:/data

volumes:
  ironmount_data:
    driver: local

Then, run the following command to start Ironmount:

docker-compose up -d

Once the container is running, you can access the web interface at http://<your-server-ip>:4096.

Docker volume usage

Preview

Volume creation

Preview