{"id":19584780,"url":"https://github.com/oracle-samples/ocifs-fuse","last_synced_at":"2026-06-13T11:33:07.019Z","repository":{"id":184235020,"uuid":"633879867","full_name":"oracle-samples/ocifs-fuse","owner":"oracle-samples","description":"OCIFS is a filesystem to mount OCI Object Storage buckets","archived":false,"fork":false,"pushed_at":"2023-07-27T14:43:03.000Z","size":136,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-18T01:46:04.256Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.oracle.com/en-us/iaas/oracle-linux/ocifs/index.htm","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null}},"created_at":"2023-04-28T13:48:18.000Z","updated_at":"2025-05-27T01:44:53.000Z","dependencies_parsed_at":"2023-07-27T15:51:46.634Z","dependency_job_id":null,"html_url":"https://github.com/oracle-samples/ocifs-fuse","commit_stats":null,"previous_names":["oracle-samples/ocifs-fuse"],"tags_count":0,"template":false,"template_full_name":"oracle/template-repo","purl":"pkg:github/oracle-samples/ocifs-fuse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-samples%2Focifs-fuse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-samples%2Focifs-fuse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-samples%2Focifs-fuse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-samples%2Focifs-fuse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle-samples","download_url":"https://codeload.github.com/oracle-samples/ocifs-fuse/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-samples%2Focifs-fuse/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34283390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-11T07:49:42.634Z","updated_at":"2026-06-13T11:33:06.998Z","avatar_url":"https://github.com/oracle-samples.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OCIFS - a filesystem to mount OCI Object Storage buckets\n\nThe ocifs command provides the ability to mount an\n[Oracle Cloud Infrastructure (OCI)](https://www.oracle.com/cloud/)\nObject Storage bucket as a filesystem. This makes\nOCI Object Storage objects accessible as regular files or directories.\nOCIFS is implemented as a FUSE filesystem.\n\n## Installation\n\n### From RPM\n\nFor Oracle Cloud instances running Oracle Linux 8 or 9, OCIFS is\navailable as a RPM package in the oci_included repository.\n\n```\n# yum install ocifs\n```\n\nFor more information about the oci_included repository, see\n[Installing Software on Oracle Linux Instances](https://docs.oracle.com/iaas/oracle-linux/getting-started/install-software-on-instance.htm)\n\n### From Source\n\nTo build the ocifs command from the source, use the following sequence:\n\n```\n$ autoreconf --install\n$ ./configure\n$ make\n```\n\nThe ocifs command is then available as src/ocifs/ocifs, and it can be\ninstalled with the following command:\n\n```\n# make install\n```\n\n## Documentation\n\nThe OCIFS documentation is available in the Oracle Cloud Infrastructure\nDocumentation:\n[OCIFS Utility](https://docs.oracle.com/en-us/iaas/oracle-linux/ocifs/index.htm).\n\nThe capability and usage of OCIFS are also documented in the ocifs man\npage.\n\nIf ocifs is already installed then you can access the man page with:\n```\n$ man ocifs\n```\notherwise, you can view it from the source repository with:\n```\n$ man doc/ocifs.1\n```\n\nThe following is a quick and simple overview on how to mount/unmount\nan OCI Object Storage bucket with ocifs.\n\n### Authentication\n\nTo mount an OCI Object Storage bucket with ocifs, you must authenticate\nwith OCI. A simple way to authenticate is to use the API key-based\nauthentication. To do so, you need to create an OCI SDK and CLI\nconfiguration file (~/.oci/config) as defined in the OCI documentation:\n\n  https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm\n\nThe configuration file must have the following entries: user, fingerprint,\ntenancy, region, key_file. OCIFS uses the entries defined in the DEFAULT\nprofile.\n\nFor other authentication methods, refer the ocifs man page.\n\n### Mounting an OCI Object Storage Bucket\n\nTo mount an OCI Object Storage bucket, do either:\n\n```\n$ ocifs \u003coci-object-storage-bucket-name\u003e \u003cdir\u003e\n```\n\nor:\n\n```\n# mount -t fuse.ocifs \u003coci-object-storage-bucket-name\u003e \u003cdir\u003e\n```\nOnce an OCI Object Storage bucket is mounted, objects from that bucket are\naccessible as regular files, and ocifs simulates a directory structure from\nprefix strings present in object names that includes one or more forward\nslashes (/).\n\n### Unmounting an OCI Object Storage Bucket\n\nTo mount an OCI Object Storage bucket, do either:\n\n```\n$ fusermount -u \u003cdir\u003e\n```\n\nor:\n\n```\n# umount \u003cdir\u003e\n```\n\n## Examples\n\nThe following examples use the API Key-Based authentication:\n\n### Configuration\n\nConfiguration file example:\n\n```\n$ cat ~/.oci/config\n[DEFAULT]\nuser=ocid1.user.oc1..\u003cunique_ID\u003e\nfingerprint=12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef\ntenancy=ocid1.tenancy.oc1..\u003cunique_ID\u003e\nregion=us-ashburn-1\nkey_file=~/.oci/oci_api_key_public.pem\n```\n\n### Mounting an OCI Object Storage bucket\n\nWith the ocifs command:\n\n```\n$ ocifs my-bucket ~/mnt\n```\n\nWith the mount command:\n\n```\n# mount -t fuse.ocifs my-bucket /mnt\n```\n\n### Unmount an OCI Object Storage bucket path\n\nWith the ocifs command:\n\n```\n$ fusermount -u ~/mnt\n```\n\nWith the mount command:\n\n```\n# umount /mnt\n```\n\n## Contributing\n\nThis project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)\n\n## Security\n\nPlease consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process\n\n## License\n\nCopyright (c) 2023 Oracle and/or its affiliates.\n\nReleased under the Universal Permissive License v1.0 as shown at\n\u003chttps://oss.oracle.com/licenses/upl/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle-samples%2Focifs-fuse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle-samples%2Focifs-fuse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle-samples%2Focifs-fuse/lists"}