s3fs
s3fs is a utility that lets Linux and macOS mount Object Storage buckets via FUSE.
Note
We recommend using s3fs version 1.84 or higher.
If you have any questions, see the official documentation of the project, in particular, the FAQs. There you can learn how to fix issues that occur when using s3fs.
S3fs performance depends on the speed of your local disk. Use high-speed disks, especially if you store a lot of small files, such as a few hundred kilobytes each or smaller. To increase s3fs performance, you can enable caching through the --use_cache <directory> key. As the s3fs cache can increase in size without limits, make sure to clear it regularly. You can read more in the s3fs documentation.
Getting started
- Create a service account.
- Assign the service account the roles required for your project. For more information about roles, see the Identity and Access Management documentation.
- Create a static access key.
Note
A service account is only allowed to view a list of buckets in the folder it was created in.
A service account can perform actions with objects in buckets that are created in folders different from the service account folder. To enable this, assign the service account roles for the appropriate folder or its bucket.
Installing
To install s3fs, follow the guide in the project repository.
Setup
To configure s3fs, save the key ID and the secret key to the ~/.passwd-s3fs file in <key_ID>:<secret_key> format and restrict access to the ~/.passwd-s3fs file in the following way:
echo <key_ID>:<secret_key> > ~/.passwd-s3fs
chmod 600 ~/.passwd-s3fs
Mounting a bucket
-
Select the folder where you want to mount your bucket and make sure you have permissions to perform the mounting operation.
-
Run this command:
s3fs <bucket_name> /mount/<folder_path> -o passwd_file=$HOME/.passwd-s3fs \ -o url=https://storage.yandexcloud.net -o use_path_request_styleTo allow other PC users to access the folder, specify the
-o allow_otheroption.To set access permissions to the folder you are going to mount the bucket to, specify the
-o mp_umask=<required_permissions>option.
You can configure mounting a bucket at system startup. To do this, open the /etc/fstab file and add a line in the following format:
s3fs#<bucket_name> /mount/<folder_path> fuse _netdev,allow_other,use_path_request_style,url=https://storage.yandexcloud.net,passwd_file=/home/<username>/.passwd-s3fs 0 0
For descriptions of all s3fs parameters, see the project's wiki page on GitHub.