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

Merge pull request #145 from j-ed/stable5

Browse Source 
changed syntax description from mount.php to mount.json and added sftp description
This commit is contained in:
Bernhard Posselt 2013-07-13 03:53:04 -07:00
commit f172371ccb
1 changed files with 176 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

316
admin_manual/configuration/custom_mount_config.rst
View File

@ -1,25 +1,26 @@
Custom Mount Configuration
==========================
.. todo:: This is outdated - since ownCloud 5.0 the data is stored in a JSON format and not anylonger as PHP array.
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:
storage providers into ownCloud's virtual file system. You can configure these
file systems by creating and editing :file:`data/mount.json`. This file contains
all settings in JSON (JavaScript Object Notation) format. At the moment two
different types of entries exist:
- **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
users.
For each type, there is an array with the user/group name as key, and an array
of configuration entries as value. Each entry consist of the class name of the
storage backend and an array of backend specific options. The template
**$user** can be used in the mount point or backend options. As of writing the
following storage backends are available for use:
For each type, there is a JSON array with the user/group name as key, and an
array of configuration entries as value. Each entry consist of the class name
of the storage backend and an array of backend specific options and will be
replaced by the user login. The template **$user** can be used in the mount
point or backend options. As of writing the following storage backends are
available for use:
- Local file system
- FTP
- FTP (or FTPS)
- SFTP
- SMB
- WebDAV
- `Amazon S3`_
@ -27,37 +28,41 @@ following storage backends are available for use:
- `Google Drive`_
- `OpenStack Swift`_
Please keep in mind that some formatting has been applied and carriage returns
have been added for better readability. In the :file:`data/mount.json` all
values need to be concatenated and written in a row without these modifications!
It is recommended to use the WebGUI in the administrator panel to add, remove
or modify mount options to prevent any problems!
Example
-------
.. code-block:: php
.. code-block:: json
<?php
return array(
'group'=>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(...)
),
),
)
);
{"group":{
"admin":{
"\/$user\/files\/Admin_Stuff":{
"class":"\\OC\\Files\\Storage\\Local",
"options":{ ... }
}
}
}
"user":{
"all":{
"\/$user\/files\/Pictures":{
"class":"\\OC\\Files\\Storage\\DAV",
"options":{ ... }
}
}
"someuser":{
"\/someuser\/files\/Music":{
"class":"\\OC\\Files\\Storage\\FTP",
"options":{ ... }
}
}
}
}
Backends
--------
@ -65,8 +70,8 @@ Backends
Local Filesystem
~~~~~~~~~~~~~~~~
The local filesystem backend mounts a folder on the server into the
virtual filesystem, the class to be used is **OC_Filestorage_Local** and
The local filesystem backend mounts a folder on the server into the virtual
filesystem, the class to be used is **\\OC\\Files\\Storage\\Local**\ and
takes the following options:
- **datadir** : the path to the local directory to be mounted
@ -75,54 +80,84 @@ takes the following options:
Example
^^^^^^^
.. code-block:: php
.. code-block:: json
<?php
array( 'class' => 'OC_Filestorage_Local',
'options' => array( 'datadir'=>'/mnt/additional_storage' )
);
{ "class":"\\OC\\Files\\Storage\\Local",
"options":{ "datadir":"\/mnt\/additional_storage" }
}
.. note:: You must ensure that the web server has sufficient permissions on the folder.
FTP
~~~
FTP (or FTPS)
~~~~~~~~~~~~~
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:
to be used is **\\OC\\Files\\Storage\\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 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)
- **secure**: whether to use ftps:// (FTP over TLS) to connect to the ftp
server instead of ftp:// (optional, defaults to false)
- **root**: the folder inside the ftp server to mount (optional, defaults
to ‘/’)
Example
^^^^^^^
.. code-block:: php
.. code-block:: json
<?php
array( 'class'=>'OC_Filestorage_FTP',
'options'=>array (
'host'=>'ftp.myhost.com',
'user'=>'johndoe',
'password'=> 'secret',
'root'=>'/Videos'
)
);
{ "class":"\\OC\\Files\\Storage\\FTP",
"options":{
"host":"ftp.myhost.com",
"user":"johndoe",
"password":"secret",
"root":"\/Videos",
"secure":"false"
}
}
.. note:: PHP needs to be build with FTP support for this backend to work.
SFTP
~~~~
The SFTP backend mounts a folder on a remote SSH server into the virtual
filesystem and is part of the ‘External storage support’ app. The class
to be used is **\\OC\\Files\\Storage\\SFTP**\ and takes the following
options:
- **host**: the hostname of the SSH server
- **user**: the username used to login to the SSH server
- **password**: the password to login on the SSH server
- **root**: the folder inside the SSH server to mount (optional, defaults
to ‘/’)
Example
^^^^^^^
.. code-block:: json
{ "class":"\\OC\\Files\\Storage\\SFTP",
"options":{
"host":"ssh.myhost.com",
"user":"johndoe",
"password":"secret",
"root":"\/Books"
}
}
.. note:: PHP needs to be build with SFTP 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
a Windows machine into the virtual file system. It is part of the ‘External
storage support’ app, the class to be used is **\\OC\\Files\\Storage\\SMB**\ and
takes the following options:
- **host**: the host name of the samba server
@ -137,27 +172,25 @@ takes the following options:
Example
^^^^^^^
.. code-block:: php
.. code-block:: json
<?php
array( 'class'=>'OC_Filestorage_SMB',
'options'=>array (
'host'=>'myhost.com',
'user'=>'johndoe',
'password'=> 'secret',
'share'=>'/test',
'root'=>'/Pictures'
)
);
{ "class":"\\OC\\Files\\Storage\\SMB",
"options":{
"host":"myhost.com",
"user":"johndoe",
"password":"secret",
"share":"\/test",
"root":"\/Pictures"
}
}
WebDAV
~~~~~~
The WebDAV backend mounts a folder on a remote WebDAV server into the
virtual filesystem and is part of the ‘External storage support’ app,
the class to be used is **OC_Filestorage_DAV**\ and takes the following
options:
the class to be used is **\\OC\\Files\\Storage\\DAV**\ and takes the
following options:
- **host**: the hostname of the webdav server.
- **user**: the username used to login on the webdav server
@ -167,104 +200,109 @@ options:
- **root**: the folder inside the webdav server to mount (optional,
defaults to ‘/’)
Example
^^^^^^^
.. code-block:: php
.. code-block:: json
<?php
array( 'class'=>'OC_Filestorage_DAV',
'options'=>array(
'host'=>'myhost.com/webdav.php',
'user'=>'johndoe',
'password'=>'secret',
'secure'=>true
)
);
{ "class":"\\OC\\Files\\Storage\\DAV",
"options":{
"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:
be used is **\\OC\\Files\\Storage\\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
.. code-block:: json
<?php
array( 'class'=>'OC_Filestorage_AmazonS3',
'options'=>array(
'key'=>'key',
'secret'=>'secret',
'bucket'=>'bucket'
)
);
{ "class":"\\OC\\Files\\Storage\\AmazonS3",
"options":{
"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:
be used is **\\OC\\Files\\Storage\\Dropbox**\ and takes the following options:
- **configured**: whether the drive has been configured or not (true or false)
- **app_key**: the app key to login to your Dropbox
- **app_secret**: the app secret to login to your Dropbox
- **token**: the OAuth token to login to your Dropbox
- **token_secret**: the OAuth secret to login to your Dropbox
Example
^^^^^^^
.. code-block:: php
.. code-block:: json
<?php
array( 'class'=>'OC_Filestorage_Dropbox',
'options'=>array(
'configured'=>'#configured',
'app_key'=>'key',
'app_secret'=>'secret',
'token'=>'#token',
'token_secret'=>'#token_secret'
)
);
{ "class":"\\OC\\Files\\Storage\\Dropbox",
"options":{
"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.
be used is **\\OC\\Files\\Storage\\Google**\ and is done via an OAuth request
and takes the following options:
- **configured**: whether the drive has been configured or not (true or false)
- **token**: the OAuth token to login to the Google drive
- **token_secret**: the OAuth secret to login to the Google drive
Example
^^^^^^^
.. code-block:: php
.. code-block:: json
<?php
array( 'class'=>'OC_Filestorage_Google',
'options'=>array(
'configured'=>'#configured',
'token'=>'#token',
'token_secret'=>'#token secret'
)
);
{ "class":"\\OC\\Files\\Storage\\Google",
"options":{
"configured":"#configured",
"token":"#token",
"token_secret":"#token secret"
}
}
OpenStack Swift
~~~~~~~~~~~~~~~
The Swift backend mounts a container on an OpenStack Object Storage
server into the virtual filesystem and is part of the ‘External storage
support’ app, the class to be used is **OC_Filestorage_SWIFT**\ and
takes the following options:
The Swift backend mounts a container on an OpenStack Object Storage server
into the virtual filesystem and is part of the ‘External storage support’
app, the class to be used is **\\OC\\Files\\Storage\\SWIFT**\ and takes
the following options:
- **host**: the hostname of the authentication server for the swift
storage.
@ -278,19 +316,17 @@ takes the following options:
Example
^^^^^^^
.. code-block:: php
.. code-block:: json
<?php
array( 'class'=>'OC_Filestorage_SWIFT',
'options'=>array(
'host'=>'swift.myhost.com/auth',
'user'=>'johndoe',
'token'=>'secret',
'root'=>'/Videos',
'secure'=>true
)
);
{ "class":"\\OC\\Files\\Storage\\SWIFT",
"options":{
"host":"swift.myhost.com\/auth",
"user":"johndoe",
"token":"secret",
"root":"\/Videos",
"secure":"true"
}
}
.. _Amazon S3: http://aws.amazon.com/de/s3/