octoleo/s3fs-fuse
1
0
Fork 0
mirror of https://github.com/s3fs-fuse/s3fs-fuse.git synced 2024-11-14 08:24:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
7a7c7572ea
s3fs-fuse/README

68 lines
3.5 KiB
Plaintext
Raw Normal View History

Implemented max_stat_cache_size as an option Resolves issue #157 git-svn-id: http://s3fs.googlecode.com/svn/trunk@316 df820570-a93a-0410-bd06-b72b767a4274
2011-02-12 16:48:23 +00:00
THIS README CONTAINS OUTDATED INFORMATION - please refer to the wiki or --help
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
S3FS-Fuse
S3FS is FUSE (File System in User Space) based solution to mount/unmount an Amazon S3 storage buckets and use system commands with S3 just like it was another Hard Disk.
In order to compile s3fs, You'll need the following requirements:
* Kernel-devel packages (or kernel source) installed that is the SAME version of your running kernel
* LibXML2-devel packages
* CURL-devel packages (or compile curl from sources at: curl.haxx.se/ use 7.15.X)
* GCC, GCC-C++
* pkgconfig
Cleaned up compile time warnings as reported by -Wall Beginning of s3fs "utility" mode - initially -u option just reports in progress multipart uploads for the bucket. Eventually this mode could be used for other S3 tasks not accessible through typical file system operations For multipart upload, use safer mkstemp() instead of tmpnam() for temporary file Increased the curl connect and readwrite timeouts to 10 and 30 seconds respectively. Autodetect when a big file is being uploaded, increase the readwrite timeout to 120 seconds. This was found through experimentation. When uploading a big file, it is suspected that time is needed for S3 to assemble the file before it is available for access. It was found that when a large file was uploaded via rsync, the final mtime and chmod modifications were timing out, even though the upload itself was successful. Multipart upload is ready for use. A couple of error checks are still needed in the function and some cleanup. Need some feedback on how it is working though. git-svn-id: http://s3fs.googlecode.com/svn/trunk@298 df820570-a93a-0410-bd06-b72b767a4274
2010-12-30 03:13:21 +00:00
* FUSE (>= 2.8.4)
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
* FUSE Kernel module installed and running (RHEL 4.x/CentOS 4.x users - read below)
* OpenSSL-devel (0.9.8)
Cleaned up codes for next packaging.
2014-09-07 15:08:27 +00:00
GnuTLS(gcrypt and nettle)
NSS
changed for version v1.77 and fixed man page
2014-04-19 16:08:10 +00:00
* Git
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
If you're using YUM or APT to install those packages, then it might require additional packaging, allow it to be installed.
Downloading & Compiling:
------------------------
changed for version v1.77 and fixed man page
2014-04-19 16:08:10 +00:00
In order to download s3fs, download from following url:
https://github.com/s3fs-fuse/s3fs-fuse/archive/master.zip
Or clone the following command:
git clone git://github.com/s3fs-fuse/s3fs-fuse.git
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
changed for version v1.77 and fixed man page
2014-04-19 16:08:10 +00:00
Go inside the directory that has been created (s3fs-fuse) and run: ./autogen.sh
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
This will generate a number of scripts in the project directory, including a configure script which you should run with: ./configure
If configure succeeded, you can now run: make. If it didn't, make sure you meet the dependencies above.
This should compile the code. If everything goes OK, you'll be greated with "ok!" at the end and you'll have a binary file called "s3fs"
in the src/ directory.
Cleaned up compile time warnings as reported by -Wall Beginning of s3fs "utility" mode - initially -u option just reports in progress multipart uploads for the bucket. Eventually this mode could be used for other S3 tasks not accessible through typical file system operations For multipart upload, use safer mkstemp() instead of tmpnam() for temporary file Increased the curl connect and readwrite timeouts to 10 and 30 seconds respectively. Autodetect when a big file is being uploaded, increase the readwrite timeout to 120 seconds. This was found through experimentation. When uploading a big file, it is suspected that time is needed for S3 to assemble the file before it is available for access. It was found that when a large file was uploaded via rsync, the final mtime and chmod modifications were timing out, even though the upload itself was successful. Multipart upload is ready for use. A couple of error checks are still needed in the function and some cleanup. Need some feedback on how it is working though. git-svn-id: http://s3fs.googlecode.com/svn/trunk@298 df820570-a93a-0410-bd06-b72b767a4274
2010-12-30 03:13:21 +00:00
As root (you can use su, su -, sudo) do: "make install" -this will copy the "s3fs" binary to /usr/local/bin.
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
Congratulations. S3fs is now compiled and installed.
Usage:
------
Implemented max_stat_cache_size as an option Resolves issue #157 git-svn-id: http://s3fs.googlecode.com/svn/trunk@316 df820570-a93a-0410-bd06-b72b767a4274
2011-02-12 16:48:23 +00:00
In order to use s3fs, make sure you have the Access Key and the Secret Key handy. (refer to the wiki)
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
First, create a directory where to mount the S3 bucket you want to use.
Example (as root): mkdir -p /mnt/s3
Support for mounting a remote directory (issue #7). - fixed a bug in the file cache, it was attempting to set the mtime on symlinks - general code cleanup; moved some string functions to string_util.cpp git-svn-id: http://s3fs.googlecode.com/svn/trunk@345 df820570-a93a-0410-bd06-b72b767a4274
2011-06-26 00:37:52 +00:00
Then run: s3fs mybucket[:path] /mnt/s3
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
This will mount your bucket to /mnt/s3. You can do a simple "ls -l /mnt/s3" to see the content of your bucket.
changed for version v1.77 and fixed man page
2014-04-19 16:08:10 +00:00
If you want to allow other people access the same bucket in the same machine, you can add "-o allow_other" to read/write/delete content of the bucket.
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
You can add a fixed mount point in /etc/fstab, here's an example:
Cleaned up compile time warnings as reported by -Wall Beginning of s3fs "utility" mode - initially -u option just reports in progress multipart uploads for the bucket. Eventually this mode could be used for other S3 tasks not accessible through typical file system operations For multipart upload, use safer mkstemp() instead of tmpnam() for temporary file Increased the curl connect and readwrite timeouts to 10 and 30 seconds respectively. Autodetect when a big file is being uploaded, increase the readwrite timeout to 120 seconds. This was found through experimentation. When uploading a big file, it is suspected that time is needed for S3 to assemble the file before it is available for access. It was found that when a large file was uploaded via rsync, the final mtime and chmod modifications were timing out, even though the upload itself was successful. Multipart upload is ready for use. A couple of error checks are still needed in the function and some cleanup. Need some feedback on how it is working though. git-svn-id: http://s3fs.googlecode.com/svn/trunk@298 df820570-a93a-0410-bd06-b72b767a4274
2010-12-30 03:13:21 +00:00
s3fs#mybucket /mnt/s3 fuse allow_other 0 0
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
This will mount upon reboot (or by launching: mount -a) your bucket on your machine.
changed for version v1.77 and fixed man page
2014-04-19 16:08:10 +00:00
If that does not work, probably you should specify with "_netdev" option in fstab.
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
changed for version v1.77 and fixed man page
2014-04-19 16:08:10 +00:00
All other options can be read at: https://github.com/s3fs-fuse/s3fs-fuse/wiki/Fuse-Over-Amazon
In preparation to remove the unnecessary "s3fs" directory from the trunk directory. First do a svn cp of all of the source up to trunk. This is supposed to preserve change history -- we'll see. The source remains untouched until this gets worked out. Also in preparation of bringing in the source collateral for the debian package into the repository. I expect that the top level will look like this: svn/ s3fs/ trunk/ tags/ branches/ dpkg/ trunk/ tags/ branches/ So far that's how it is looking. I'll be very careful to ensure integrity of the data. As a result this may be a multistep process. git-svn-id: http://s3fs.googlecode.com/svn/trunk@236 df820570-a93a-0410-bd06-b72b767a4274
2010-11-13 23:59:23 +00:00
Known Issues:
-------------
s3fs should be working fine with S3 storage. However, There are couple of limitations:
* Currently s3fs could hang the CPU if you have lots of time-outs. This is *NOT* a fault of s3fs but rather libcurl. This happends when you try to copy thousands of files in 1 session, it doesn't happend when you upload hundreds of files or less.
* CentOS 4.x/RHEL 4.x users - if you use the kernel that shipped with your distribution and didn't upgrade to the latest kernel RedHat/CentOS gives, you might have a problem loading the "fuse" kernel. Please upgrade to the latest kernel (2.6.16 or above) and make sure "fuse" kernel module is compiled and loadable since FUSE requires this kernel module and s3fs requires it as well.
* Moving/renaming/erasing files takes time since the whole file needs to be accessed first. A workaround could be to use s3fs's cache support with the use_cache option.
Reference in New Issue Copy Permalink