{"id":13551234,"url":"https://github.com/minio/minfs","last_synced_at":"2025-04-03T01:31:49.968Z","repository":{"id":40614147,"uuid":"65941875","full_name":"minio/minfs","owner":"minio","description":"A network filesystem client to connect to MinIO and Amazon S3 compatible cloud storage servers","archived":true,"fork":false,"pushed_at":"2022-09-06T02:15:38.000Z","size":5027,"stargazers_count":454,"open_issues_count":0,"forks_count":73,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-08-01T12:24:00.541Z","etag":null,"topics":["fuse-driver","fuse-filesystem","golang","mount","s3-bucket","storage","storage-servers"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-17T21:03:55.000Z","updated_at":"2024-07-25T00:57:34.000Z","dependencies_parsed_at":"2023-01-17T16:43:37.085Z","dependency_job_id":null,"html_url":"https://github.com/minio/minfs","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fminfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fminfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fminfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fminfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minio","download_url":"https://codeload.github.com/minio/minfs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222905742,"owners_count":17055817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fuse-driver","fuse-filesystem","golang","mount","s3-bucket","storage","storage-servers"],"created_at":"2024-08-01T12:01:44.554Z","updated_at":"2024-11-03T21:31:31.701Z","avatar_url":"https://github.com/minio.png","language":"Go","readme":"# MinFS Quickstart Guide [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) [![Go Report Card](https://goreportcard.com/badge/minio/minfs)](https://goreportcard.com/report/minio/minfs)\n\n\u003e NOTE:\tThis project is frozen and is not accepting any new features, feel free to send a [pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) for any such features.\n\nMinFS is a fuse driver for Amazon S3 compatible object storage server. MinFS lets you mount a remote bucket (from a S3 compatible object store), as if it were a local directory. This allows you to read and write from the remote bucket just by operating on the local mount directory.\n\nMinFS helps legacy applications use modern object stores with minimal config changes. MinFS uses [BoltDB](https://github.com/boltdb/bolt) for caching and saving metadata, list of files, permissions, owners etc.\n\n\u003e Be careful, it is always possible to remove boltdb cache. Cache will be recreated by MinFS synchronizing metadata from the server.\n\n# Architecture\n![architecture](https://raw.githubusercontent.com/minio/minfs/master/MinFS.svg?sanitize=true)\n\n## POSIX Compatibility\n\u003e MinFS is not a POSIX conformant filesystem and it does not intend to be one. MinFS is built for legacy applications that needs to access an object store but does not expect strict POSIX compatibility. Please use MinFS if this fits your needs.\n\nUse cases not suitable for MinFS use are:\n- Running a database on MinFS such as postgres, mysql etc.\n- Running virtual machines on MinFS such as qemu/kvm.\n- Running rich POSIX applications which rely on POSIX locks, Extended attribute operations etc.\n\nSome use cases suitable for MinFS are:\n- Serving a static web-content with NGINX, Apache2 web servers.\n- Serving as backup destination for legacy tools unable to speak S3 protocol.\n\n## MinFS RPMs\n### Minimum Requirements\n- [RPM Package Manager](http://rpm.org/)\n\n### Install\nDownload the pre-built RPMs from [here](https://github.com/minio/minfs/releases/tag/RELEASE.2017-02-26T20-20-56Z)\n```sh\nyum install minfs-0.0.20170226202056-1.x86_64.rpm\n```\n\n### Update `config.json`\nCreate a new `config.json` in /etc/minfs directory with your S3 server access and secret keys.\n\n\u003e This example uses [play.min.io](https://play.min.io)\n\n```json\n{\"version\":\"1\",\"accessKey\":\"Q3AM3UQ867SPQQA43P2F\",\"secretKey\":\"zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG\"}\n```\n\n### Mount `mybucket`\nCreate an `/etc/fstab` entry\n```\nhttps://play.min.io/mybucket /mnt/mounted/mybucket minfs defaults,cache=/tmp/mybucket 0 0\n```\n\nNow proceed to mount `fstab` entry.\n```sh\nmount /mnt/mounted/mybucket\n```\n\nVerify if `mybucket` is mounted and is accessible.\n```\nls -F /mnt/mounted/mybucket\netc/  issue\n```\n","funding_links":[],"categories":["Go","golang"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fminfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminio%2Fminfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fminfs/lists"}