# ownCloud Administrators Manual

# 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 `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 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:

- Local file system
- FTP
- SMB
- WebDAV
- Amazon S3
- Dropbox
- Google Drive
- OpenStack Swift

## Example

     <?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(...)
              ),
           ),
        )
    );

## 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 takes the following options:

- datadir : the path to the local directory to be mounted

#### Example

    <?php

    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.

### FTP

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 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 to ‘/’)

#### Example

    <?php

    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

    <?php

    array( 'class'=>'OC_Filestorage_SMB',
           'options'=>array (
                '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_DAVand takes the following options:

- host: the hostname of the webdav server.
- user: the username used 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, defaults to ‘/’)

#### Example

    <?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

    <?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

    <?php

      array( 'class'=>'OC_Filestorage_Dropbox',
             'options'=>array(
                 '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

    <?php

     array( 'class'=>'OC_Filestorage_Google',
            'options'=>array(
                 '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:

- host: the hostname of the authentication server for the swift storage.
- user: the username used to login on the swift server
- token: the authentication token to login on the swift server
- secure: whether to use ftps:// to connect to the swift server instead of ftp:// (optional, defaults to false)
- root: the container inside the swift server to mount (optional, defaults to ‘/’)

#### Example

    <?php

    array( 'class'=>'OC_Filestorage_SWIFT',
           'options'=>array(
                'host'=>'swift.myhost.com/auth',
                'user'=>'johndoe',
                'token'=>'secret',
                'root'=>'/Videos',
                'secure'=>true
           )
    );