mirrors/nextcloud-documentation
3
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-10-26 11:18:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update admin_manual/configuration/custom_mount_config.rst

Browse Source 
added descriptions of the already supported and popular file storage backends AmazonS3, Dropbox, and Google Drive.
This commit is contained in:
j-ed 2013-02-12 19:05:17 +01:00
parent 26bbc1dd08
commit c2818cf5aa
1 changed files with 170 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

257
admin_manual/configuration/custom_mount_config.rst
View File

@ -2,7 +2,8 @@ Custom Mount Configuration
==========================
Since ownCloud 4.0 it is possible to configure the filesystem to mount external
storage providers into ownCloud's virtual file system. You can configure the
file system by creating and editing :file:`config/mount.php`, the configuration file holds a PHP array configuring 2 types of entries:
file system by creating and editing :file:`config/mount.php`, the configuration
file holds a PHP array configuring 2 types of entries:
- **Group mounts:** each entry configures a mount for each user in group.
- **User mounts:** each entry configures a mount for a single user or for all
@ -16,38 +17,42 @@ following storage backends are available for use:
- Local file system
- FTP
- WebDAV
- `OpenStack Swift`_
- SMB
- WebDAV
- `Amazon S3`_
- `Dropbox`_
- `Google Drive`_
- `OpenStack Swift`_
Example
-------
.. code-block:: php
<?php
return array(
<?php
return array(
'group'=>array(
'admin'=>array(
'/$user/files/Admin_Stuff'=>array(
'class'=>'OC_Filestorage_Local',
'options'=>array(...)
),
),
'admin'=>array(
'/$user/files/Admin_Stuff'=>array(
'class'=>'OC_Filestorage_Local',
'options'=>array(...)
),
),
),
'user'=>array(
'all'=>array(
'/$user/files/Pictures'=>array(
'class'=>'OC_Filestorage_DAV',
'options'=>array(...)
),
),
'someuser'=>array(
'/someuser/files/Music'=>array(
'class'=>'OC_Filestorage_FTP',
'options'=>array(...)
),
),
'all'=>array(
'/$user/files/Pictures'=>array(
'class'=>'OC_Filestorage_DAV',
'options'=>array(...)
),
),
),
'someuser'=>array(
'/someuser/files/Music'=>array(
'class'=>'OC_Filestorage_FTP',
'options'=>array(...)
),
),
)
);
@ -61,7 +66,7 @@ The local filesystem backend mounts a folder on the server into the
virtual filesystem, the class to be used is **OC_Filestorage_Local** and
takes the following options:
- **datadir** : the path to the local directory to be mounted.
- **datadir** : the path to the local directory to be mounted
Example
@ -69,12 +74,11 @@ Example
.. code-block:: php
<?php
<?php
array(
'class' => 'OC_Filestorage_Local',
'options' => array( 'datadir'=>'/mnt/additional_storage' )
);
array( 'class' => 'OC_Filestorage_Local',
'options' => array( 'datadir'=>'/mnt/additional_storage' )
);
.. note:: You must ensure that the web server has sufficient permissions on the folder.
@ -85,9 +89,9 @@ The FTP backend mounts a folder on a remote FTP server into the virtual
filesystem and is part of the ‘External storage support’ app, the class
to be used is **OC_Filestorage_FTP** and takes the following options:
- **host**: the hostname of the ftp server.
- **user**:the username used to login on the ftp server
- **password**: the passwordt to login on the ftp server
- **host**: the hostname of the ftp server
- **user**: the username used to login on the ftp server
- **password**: the password to login on the ftp server
- **secure**: whether to use ftps:// to connect to the ftp server instead
of ftp:// (optional, defaults to false)
- **root**: the folder inside the ftp server to mount (optional, defaults
@ -98,20 +102,52 @@ Example
.. code-block:: php
<?php
<?php
array(
'class'=>'OC_Filestorage_FTP',
'options'=>array (
'host'=>'ftp.myhost.com',
'user'=>'johndoe',
'password'=> 'secret',
'root'=>'/Videos'
)
);
array( 'class'=>'OC_Filestorage_FTP',
'options'=>array (
'host'=>'ftp.myhost.com',
'user'=>'johndoe',
'password'=> 'secret',
'root'=>'/Videos'
)
);
.. note:: PHP needs to be build with FTP support for this backend to work.
SMB
~~~
The SMB backend mounts a folder on a remote Samba server, a NAS appliance or
a Windows machine into the virtual file system. It is part of the ‘External
storage support’ app, the class to be used is **OC_Filestorage_SMB**\ and
takes the following options:
- **host**: the host name of the samba server
- **user**: the user name used to login on the samba server
- **password**: the password to login on the samba server
- **share**: the share on the samba server to mount
- **root**: the folder inside the samba share to mount (optional, defaults
to ‘/’)
.. note:: The SMB backend requires **smbclient** to be installed on the server.
Example
^^^^^^^
.. code-block:: php
<?php
array( 'class'=>'OC_Filestorage_SMB',
'options'=>array (
'host'=>'myhost.com',
'user'=>'johndoe',
'password'=> 'secret',
'share'=>'/test',
'/Pictures'
)
);
WebDAV
~~~~~~
@ -122,7 +158,7 @@ options:
- **host**: the hostname of the webdav server.
- **user**: the username used to login on the webdav server
- **password**: the passwordt to login on the webdav server
- **password**: the password to login on the webdav server
- **secure**: whether to use https:// to connect to the webdav server
instead of http:// (optional, defaults to false)
- **root**: the folder inside the webdav server to mount (optional,
@ -131,18 +167,93 @@ options:
Example
^^^^^^^
.. code-block:: php
<?php
array( 'class'=>'OC_Filestorage_DAV',
'options'=>array(
'host'=>'myhost.com/webdav.php',
'user'=>'johndoe',
'password'=>'secret',
'secure'=>true
)
);
Amazon S3
~~~~~~~~~
The Amazon S3 backend mounts a bucket in the Amazon cloud into the virtual
filesystem and is part of the ‘External storage support’ app, the class to
be used is **OC_Filestorage_AmazonS3**\ and takes the following options:
- **key**: the key to login to the Amazon cloud
- **secret**: the secret to login to the Amazon cloud
- **bucket**: the bucket in the Amazon cloud to mount
Example
^^^^^^^
.. code-block:: php
<?php
array( 'class'=>'OC_Filestorage_AmazonS3',
'options'=>array(
'key'=>'key',
'secret'=>'secret',
'bucket'=>'bucket'
)
);
Dropbox
~~~~~~~
The Dropbox backend mounts a dropbox in the Dropbox cloud into the virtual
filesystem and is part of the ‘External storage support’ app, the class to
be used is **OC_Filestorage_Dropbox**\ and takes the following options:
- **app_key**: the app key to login to your Dropbox
- **app_secret**: the app secret to login to your Dropbox
Example
^^^^^^^
.. code-block:: php
<?php
array( 'class'=>'OC_Filestorage_DAV',
array( 'class'=>'OC_Filestorage_Dropbox',
'options'=>array(
'host'=>'myhost.com/webdav.php',
'user'=>'johndoe',
'password'=>'secret',
'secure'=>true
)
)
'configured'=>'#configured',
'app_key'=>'key',
'app_secret'=>'secret',
'token'=>'#token',
'token_secret'=>'#token_secret'
)
);
Google Drive
~~~~~~~~~~~~
The Google Drive backend mounts a share in the Google cloud into the virtual
filesystem and is part of the ‘External storage support’ app, the class to
be used is **OC_Filestorage_Google**\ and is done via an OAuth request.
Example
^^^^^^^
.. code-block:: php
<?php
array( 'class'=>'OC_Filestorage_Google',
'options'=>array(
'configured'=>'#configured',
'token'=>'#token',
'token_secret'=>'#token secret'
)
);
OpenStack Swift
~~~~~~~~~~~~~~~
@ -166,48 +277,20 @@ Example
.. code-block:: php
<?php
<?php
array( 'class'=>'OC_Filestorage_SWIFT',
'options'=>array(
array( 'class'=>'OC_Filestorage_SWIFT',
'options'=>array(
'host'=>'swift.myhost.com/auth',
'user'=>'johndoe',
'token'=>'secret',
'root'=>'/Videos',
'secure'=>true )
)
'secure'=>true
)
);
SMB
~~~
The SMB backend mounts a folder on a remote Samba server, a NAS appliance or a
Windows machine into the virtual file system. It is part of the ‘External
storage support’ app, the class to be used is **OC_Filestorage_SMB**\ and
takes the following options:
- **host**: the host name of the samba server.
- **user**: the user name used to login on the samba server
- **password**: the password to login on the samba server
- **share**: the share on the samba server to mount
- **root**: the folder inside the samba share to mount (optional, defaults
to ‘/’)
.. note:: The SMB backend requires **smbclient** to be installed on the server.
Example
^^^^^^^
.. code-block:: php
<?php
array( 'class'=>'OC_Filestorage_SMB',
'options'=>array (
'host'=>'myhost.com',
'user'=>'johndoe',
'password'=> 'secret',
'share'=>'/test',
'/Pictures'
)
)
.. _Amazon S3: http://aws.amazon.com/de/s3/
.. _Dropbox: https://www.dropbox.com/
.. _Google Drive: https://drive.google.com/start
.. _OpenStack Swift: http://openstack.org/projects/storage/