File Manager - BorneoXploit

Editing: primary_storage.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
 <meta charset="utf-8" />
 <meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" />

<a href="../contents.html">
 
 <img src="../_static/logo-white.png" class="logo" alt="Logo"/>
 </a>
 <div class="switch-menus">
 <div class="version-switch"></div>
 <div class="language-switch"></div>
 </div>
<div role="search">
 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
</div>
 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
 Getting Started
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../declarations/index.html">Declarations</a></li>
</ul>
Release notes
<ul>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Critical changes</a></li>
</ul>
Installation
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
</ul>
Configuration
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../occ_command.html">Using the occ command</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../webhook_listeners/index.html">Webhook Listeners</a></li>
<li class="toctree-l1"><a class="reference internal" href="../windmill_workflows/index.html">Windmill Workflows</a></li>
</ul>
Files
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">File sharing and management</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="file_sharing_configuration.html">File Sharing</a></li>
<li class="toctree-l2"><a class="reference internal" href="federated_cloud_sharing_configuration.html">Configuring Federation Sharing</a></li>
<li class="toctree-l2"><a class="reference internal" href="big_file_upload_configuration.html">Uploading big files &gt; 512MB</a></li>
<li class="toctree-l2"><a class="reference internal" href="default_files_configuration.html">Providing default files</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Configuring Object Storage as Primary Storage</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#differences-from-external-storage">Differences from External Storage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#performance-implications">Performance Implications</a></li>
<li class="toctree-l4"><a class="reference internal" href="#data-backup-and-recovery-implications">Data Backup and Recovery Implications</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#configuration">Configuration</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#openstack-swift">OpenStack Swift</a></li>
<li class="toctree-l4"><a class="reference internal" href="#simple-storage-service-s3">Simple Storage Service (S3)</a></li>
<li class="toctree-l4"><a class="reference internal" href="#microsoft-azure-blob-storage">Microsoft Azure Blob Storage</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#multibucket-object-store">Multibucket Object Store</a></li>
<li class="toctree-l3"><a class="reference internal" href="#multibucket-object-store-with-per-bucket-configuration-overrides">Multibucket Object Store with per Bucket configuration overrides</a></li>
<li class="toctree-l3"><a class="reference internal" href="#multi-instance-object-store">Multi-instance Object Store</a></li>
<li class="toctree-l3"><a class="reference internal" href="#s3-sse-c-encryption-support">S3 SSE-C encryption support</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="external_storage_configuration_gui.html">Configuring External Storage (GUI)</a></li>
<li class="toctree-l2"><a class="reference internal" href="external_storage/auth_mechanisms.html">External Storage authentication mechanisms</a></li>
<li class="toctree-l2"><a class="reference internal" href="encryption_configuration.html">Server-side encryption configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="encryption_details.html">Server-side encryption details</a></li>
<li class="toctree-l2"><a class="reference internal" href="encryption_migration.html">Server-side encryption migration</a></li>
<li class="toctree-l2"><a class="reference internal" href="files_locking_transactional.html">Transactional file locking</a></li>
<li class="toctree-l2"><a class="reference internal" href="previews_configuration.html">Previews configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_versioning.html">Controlling file versions and aging</a></li>
<li class="toctree-l2"><a class="reference internal" href="trashbin_configuration.html">Deleted Items (trash bin)</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_conversion.html">File conversion</a></li>
<li class="toctree-l2"><a class="reference internal" href="windows_compatible_filenames.html">Windows compatible filenames</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
</ul>
Apps
<ul>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../exapps_management/index.html">ExApps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
</ul>
Users
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../desktop/index.html">Desktop Clients</a></li>
</ul>
Groupware
<ul>
<li class="toctree-l1"><a class="reference internal" href="../groupware/index.html">Groupware</a></li>
</ul>
Office
<ul>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
</ul>
Maintenance
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_monitoring/index.html">Monitoring</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
</ul>
Links
<ul>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/">Community Help Forum</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">User Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">Developer Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/install/">Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://apps.nextcloud.com">App Store</a></li>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/t/translation-knowledge-valid-for-the-entire-nextcloud-project-wiki/51550">Translations</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/">GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/wiki/Maintenance-and-Release-Schedule">Supported versions</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/enterprise/">Nextcloud Enterprise</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/blob/master/COPYING-README">License</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/">Nextcloud GmbH</a></li>
</ul>

</div>
 </div>
 </nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
 
 <a href="../contents.html">Nextcloud latest Administration Manual</a>
 </nav>

<div class="wy-nav-content">
 <div class="rst-content style-external-links">
 <div role="navigation" aria-label="Page navigation">
 <ul class="wy-breadcrumbs">
 <li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
 <li class="breadcrumb-item"><a href="index.html">File sharing and management</a></li>
 <li class="breadcrumb-item active">Configuring Object Storage as Primary Storage</li>
 <li class="wy-breadcrumbs-aside">
 <a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_files/primary_storage.rst" class="fa fa-github"> Edit on GitHub</a>
 </li>
 </ul>
 <hr/>
</div>
 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 <div itemprop="articleBody">
 
 <section id="configuring-object-storage-as-primary-storage">
<h1>Configuring Object Storage as Primary Storage<a class="headerlink" href="#configuring-object-storage-as-primary-storage" title="Link to this heading"></a></h1>
Nextcloud allows to configure object storages like OpenStack Swift or
Amazon Simple Storage Service (S3) or any compatible S3-implementation
(e.g. Minio or Ceph Object Gateway) as primary storage replacing the default
storage of files.
By default, files are stored in <code class="code docutils literal notranslate">nextcloud/data</code> or another directory configured
in the <code class="code docutils literal notranslate">config.php</code> of your Nextcloud instance. This data directory might
still be used for compatibility reasons)
<section id="differences-from-external-storage">
<h2>Differences from External Storage<a class="headerlink" href="#differences-from-external-storage" title="Link to this heading"></a></h2>
When an object store is used as Primary Storage, Nextcloud requires exclusive access
over the bucket being used. All metadata (filenames, directory structures, etc)
is stored in Nextcloud and not in the object store. The metadata is only stored in the database and the
object store only holds the file content by unique identifier.
<section id="performance-implications">
<h3>Performance Implications<a class="headerlink" href="#performance-implications" title="Link to this heading"></a></h3>
Because of this, object stores configured as Primary Storage usually perform better than
when using the same object store via the External Storage support application, but the downside
is being unable to access the files from outside of Nextcloud. This makes using an object store
as Primary Storage distinct from using an object store via External Storage.
</section>
<section id="data-backup-and-recovery-implications">
<h3>Data Backup and Recovery Implications<a class="headerlink" href="#data-backup-and-recovery-implications" title="Link to this heading"></a></h3>
One impact of using an object store as Primary Storage is that your data backup strategy
needs to incorporate this. Your data is longer stored on your Nextcloud server, but your
files are also no longer accessible by simply bypassing your Nextcloud server and accessing
your object store directly.
</section>
</section>
<section id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h2>
Primary object stores need to be configured in <code class="code docutils literal notranslate">config.php</code> by specifying
the objectstore backend and any backend specific configuration.
<div class="admonition note">
Note
Configuring a primary object store on an existing Nextcloud instance will
make all existing files on the instance inaccessible.
</div>
The configuration has the following structure:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;Object\\Storage\\Backend\\Class&#39;,
 &#39;arguments&#39; =&gt; [
 ...
 ],
],
</pre></div>
</div>
<section id="openstack-swift">
<h3>OpenStack Swift<a class="headerlink" href="#openstack-swift" title="Link to this heading"></a></h3>
The OpenStack Swift backend mounts a container on an OpenStack Object Storage
server into the virtual filesystem.
The class to be used is <code class="code docutils literal notranslate">\OC\Files\ObjectStore\Swift</code>
Both openstack v2 and v3 authentication are supported,
V2 Authentication:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;\\OC\\Files\\ObjectStore\\Swift&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;username&#39; =&gt; &#39;username&#39;,
 &#39;password&#39; =&gt; &#39;Secr3tPaSSWoRdt7&#39;,
 // the container to store the data in
 &#39;bucket&#39; =&gt; &#39;nextcloud&#39;,
 &#39;autocreate&#39; =&gt; true,
 &#39;region&#39; =&gt; &#39;RegionOne&#39;,
 // The Identity / Keystone endpoint
 &#39;url&#39; =&gt; &#39;http://example.com/v2.0&#39;,
 // optional on some swift implementations
 &#39;tenantName&#39; =&gt; &#39;username&#39;,
 &#39;serviceName&#39; =&gt; &#39;swift&#39;,
 // The Interface / url Type, optional
 &#39;urlType&#39; =&gt; &#39;internal&#39;
 ],
],
</pre></div>
</div>
V3 Authentication:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;OC\\Files\\ObjectStore\\Swift&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;autocreate&#39; =&gt; true,
 &#39;user&#39; =&gt; [
 &#39;name&#39; =&gt; &#39;UserName&#39;,
 &#39;password&#39; =&gt; &#39;Secr3tPaSSWoRdt7&#39;,
 &#39;domain&#39; =&gt; [
 &#39;name&#39; =&gt; &#39;Default&#39;,
 ],
 ],
 &#39;scope&#39; =&gt; [
 &#39;project&#39; =&gt; [
 &#39;name&#39; =&gt; &#39;TenantName&#39;,
 &#39;domain&#39; =&gt; [
 &#39;name&#39; =&gt; &#39;Default&#39;,
 ],
 ],
 ],
 &#39;serviceName&#39; =&gt; &#39;swift&#39;,
 &#39;region&#39; =&gt; &#39;regionOne&#39;,
 &#39;url&#39; =&gt; &#39;http://example.com/v3&#39;,
 &#39;bucket&#39; =&gt; &#39;nextcloud&#39;,
 ],
],
</pre></div>
</div>
</section>
<section id="simple-storage-service-s3">
<h3>Simple Storage Service (S3)<a class="headerlink" href="#simple-storage-service-s3" title="Link to this heading"></a></h3>
The Simple Storage Service (S3) backend mounts a bucket on an Amazon S3 object
storage or compatible implementation (e.g. Minio or Ceph Object Gateway) into the
virtual filesystem.
The class to be used is <code class="code docutils literal notranslate">\OC\Files\ObjectStore\S3</code>
Amazon-hosted S3:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;\\OC\\Files\\ObjectStore\\S3&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;bucket&#39; =&gt; &#39;my-nextcloud-store&#39;,
 &#39;region&#39; =&gt; &#39;us-east-1&#39;,
 &#39;key&#39; =&gt; &#39;EJ39ITYZEUH5BGWDRUFY&#39;,
 &#39;secret&#39; =&gt; &#39;M5MrXTRjkyMaxXPe2FRXMTfTfbKEnZCu+7uRTVSj&#39;,
 ],
],
</pre></div>
</div>
Non-Amazon hosted S3:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;\\OC\\Files\\ObjectStore\\S3&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;bucket&#39; =&gt; &#39;my-nextcloud-store&#39;,
 &#39;hostname&#39; =&gt; &#39;s3.example.com&#39;,
 &#39;key&#39; =&gt; &#39;EJ39ITYZEUH5BGWDRUFY&#39;,
 &#39;secret&#39; =&gt; &#39;M5MrXTRjkyMaxXPe2FRXMTfTfbKEnZCu+7uRTVSj&#39;,
 &#39;port&#39; =&gt; 8443,
 // required for some non-Amazon S3 implementations
 &#39;use_path_style&#39; =&gt; true,
 ],
],
</pre></div>
</div>
Minimum required parameters are:
<ul class="simple">
<li><code class="code docutils literal notranslate">bucket</code> [Note: Even if non-Amazon hosted, bucket names must meet AWS S3 naming requirements regardless of what your S3 provider/platform considers acceptable - i.e. no underscores]</li>
<li><code class="code docutils literal notranslate">key</code></li>
<li><code class="code docutils literal notranslate">secret</code></li>
</ul>
<div class="admonition note">
Note
You will probably need to specify additional parameters beyond these, unless the default
values (see below) exactly match your situation. In particular, your <code class="code docutils literal notranslate">region</code> (if Amazon
hosted) or <code class="code docutils literal notranslate">hostname</code> (if non-Amazon hosted).
</div>
Optional parameters most commonly needing adjustment (and their defaults values if left
unconfigured):
<ul class="simple">
<li><code class="code docutils literal notranslate">region</code> defaults to <code class="code docutils literal notranslate">eu-west-1</code></li>
<li><code class="code docutils literal notranslate">storageClass</code> defaults to <code class="code docutils literal notranslate">STANDARD</code></li>
<li><code class="code docutils literal notranslate">hostname</code> defaults to <code class="code docutils literal notranslate">s3.REGION.amazonaws.com</code> [Note: If using this parameter (non-Amazon), specify the generic S3 endpoint hostname, not the hostname that contains your bucket name]</li>
<li><code class="code docutils literal notranslate">use_ssl</code> defaults to <code class="code docutils literal notranslate">true</code></li>
</ul>
Optional parameters sometimes needing adjustment:
<ul class="simple">
<li><code class="code docutils literal notranslate">use_path_style</code> defaults to <code class="code docutils literal notranslate">false</code></li>
<li><code class="code docutils literal notranslate">port</code> defaults to <code class="code docutils literal notranslate">443</code></li>
<li><code class="code docutils literal notranslate">sse_c_key</code> has no default</li>
</ul>
Optional parameters less commonly needing adjustment:
<ul class="simple">
<li><code class="code docutils literal notranslate">concurrency</code> defaults to <code class="code docutils literal notranslate">5</code> [Note: This defines the maximum number of concurrent multipart uploads]</li>
<li><code class="code docutils literal notranslate">proxy</code> defaults to <code class="code docutils literal notranslate">false</code></li>
<li><code class="code docutils literal notranslate">connect_timeout</code> defaults to <code class="code docutils literal notranslate">5</code> [Note: the connection timeout is
set in seconds, but decimal precision can be used for subsecond accuracy (for
example, 4.2 for 4200 milliseconds)]</li>
<li><code class="code docutils literal notranslate">timeout</code> defaults to <code class="code docutils literal notranslate">15</code></li>
<li><code class="code docutils literal notranslate">uploadPartSize</code> defaults to <code class="code docutils literal notranslate">524288000</code></li>
<li><code class="code docutils literal notranslate">putSizeLimit</code> defaults to <code class="code docutils literal notranslate">104857600</code></li>
<li><code class="code docutils literal notranslate">useMultipartCopy</code> defaults to <code class="code docutils literal notranslate">true</code></li>
<li><code class="code docutils literal notranslate">copySizeLimit</code> defaults to <code class="code docutils literal notranslate">5242880000</code></li>
<li><code class="code docutils literal notranslate">legacy_auth</code> has no default</li>
<li><code class="code docutils literal notranslate">version</code> defaults to <code class="code docutils literal notranslate">latest</code></li>
<li><code class="code docutils literal notranslate">verify_bucket_exists</code> defaults to <code class="code docutils literal notranslate">true</code> [Note: Setting this to <code class="code docutils literal notranslate">false</code> after confirming the bucket has been created may provide a performance benefit, but may not be possible in multibucket scenarios.]</li>
</ul>
If you are using Amazon S3: the <code class="code docutils literal notranslate">region</code> parameter is required unless you’re happy with
the default of <code class="code docutils literal notranslate">eu-west-1</code>. There is no need to override the <code class="code docutils literal notranslate">hostname</code> or <code class="code docutils literal notranslate">port</code>.
And <code class="code docutils literal notranslate">storageClass</code> only needs to be modified if you’re using a different configuration at AWS.
Lastly, <code class="code docutils literal notranslate">use_path_style</code> is rarely required with Amazon, but some legacy Amazon datacenters
may require it.
If you using a non-Amazon hosted S3 store: you will need to set the <code class="code docutils literal notranslate">hostname</code>
parameter (and can ignore the <code class="code docutils literal notranslate">region</code> parameter). You may need to use <code class="code docutils literal notranslate">use_path_style</code>
if your non-Amazon S3 store does not support requests like <code class="code docutils literal notranslate">https://bucket.hostname.domain/</code>.
Setting <code class="code docutils literal notranslate">use_path_style</code> to true configures the S3 client to make requests like
<code class="code docutils literal notranslate">https://hostname.domain/bucket</code> instead.
</section>
<section id="microsoft-azure-blob-storage">
<h3>Microsoft Azure Blob Storage<a class="headerlink" href="#microsoft-azure-blob-storage" title="Link to this heading"></a></h3>
The Azure Blob Storage backend mounts a container on Microsoft’s Azure Blob Storage into the
virtual filesystem.
The class to be used is <code class="code docutils literal notranslate">\OC\Files\ObjectStore\Azure</code>
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;\\OC\\Files\\ObjectStore\\Azure&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;container&#39; =&gt; &#39;nextcloud&#39;,
 &#39;autocreate&#39; =&gt; true,
 &#39;account_name&#39; =&gt; &#39;account_name&#39;,
 &#39;account_key&#39; =&gt; &#39;xxxxxxxxxx&#39;
 ],
],
</pre></div>
</div>
</section>
</section>
<section id="multibucket-object-store">
<h2>Multibucket Object Store<a class="headerlink" href="#multibucket-object-store" title="Link to this heading"></a></h2>
It’s possible to configure Nextcloud to distribute the data over multiple buckets
for scalability purposes.
To setup multiple buckets, set <code class="code docutils literal notranslate">'multibucket =&gt; true'</code> in the object store
configuration in <code class="code docutils literal notranslate">config.php</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;Object\\Storage\\Backend\\Class&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;multibucket&#39; =&gt; true,
 // optional, defaults to 64
 &#39;num_buckets&#39; =&gt; 64,
 // will be postfixed by an integer in the range from 0 to (num_nuckets-1)
 &#39;bucket&#39; =&gt; &#39;nextcloud_&#39;,
 ...
 ],
],
</pre></div>
</div>
Multibucket object store backend maps every user to a range of buckets and saves
all files for that user in their corresponding bucket.
<div class="admonition note">
Note
While it is possible to change the number of buckets used by an existing Nextcloud
instance, the user-to-buckets mapping is only created once, so only newly created
users will be mapped to the updated range of buckets.
</div>
You can find out more information about upscaling with object storage and Nextcloud in the
<a class="reference external" href="https://portal.nextcloud.com/article/object-store-as-primary-storage-16.html">Nextcloud customer portal</a>.
</section>
<section id="multibucket-object-store-with-per-bucket-configuration-overrides">
<h2>Multibucket Object Store with per Bucket configuration overrides<a class="headerlink" href="#multibucket-object-store-with-per-bucket-configuration-overrides" title="Link to this heading"></a></h2>
When using an Object Store with <code class="code docutils literal notranslate">'multibucket =&gt; true'</code> it is possible to configure overrides for all config options per bucket:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;Object\\Storage\\Backend\\Class&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;multibucket&#39; =&gt; true,
 &#39;bucket&#39; =&gt; &#39;nextcloud_&#39;,
 &#39;perBucket&#39; =&gt; [
 &#39;nextcloud_1&#39; =&gt; [
 &#39;port&#39; =&gt; 9999,
 ],
 ],
 ],
],
</pre></div>
</div>
This can be useful for example if you want to configure credentials per bucket that is used by a Team folder.
A script for provisioning new Team folders this way could look like this (first make sure the bucket exists with those credentials):
<div class="highlight-default notranslate"><div class="highlight"><pre>occ config:system:set --type=string --value=KEYVALUE objectstore arguments perBucket BUCKETNAME key
occ config:system:set --type=string --value=SECRETVALUE objectstore arguments perBucket BUCKETNAME secret
occ groupfolders:create --bucket BUCKETNAME TEAMFOLDERNAME
</pre></div>
</div>
The credentials must be set before the new Team folder is created.
</section>
<section id="multi-instance-object-store">
<h2>Multi-instance Object Store<a class="headerlink" href="#multi-instance-object-store" title="Link to this heading"></a></h2>
It’s possible to configure Nextcloud to distribute the data over multiple object store
instances for further scaling and gradual migration.
To setup multiple buckets, set <code class="code docutils literal notranslate">'objectstore'</code> to an array of named configurations
configuration in <code class="code docutils literal notranslate">config.php</code> and set the <code class="code docutils literal notranslate">'default'</code> to the name of the
configuration to use for newly created users:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 &#39;default&#39; =&gt; &#39;server2&#39;,
 &#39;root&#39; =&gt; &#39;server1&#39;,
 &#39;server1&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;Object\\Storage\\Backend\\Class&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;hostname&#39; =&gt; &#39;s3-server1.example.com&#39;,
 &#39;bucket&#39; =&gt; &#39;s1_nextcloud&#39;,
 ...
 ],
 ],
 &#39;server2&#39; =&gt; [
 &#39;class&#39; =&gt; &#39;Object\\Storage\\Backend\\Class&#39;,
 &#39;arguments&#39; =&gt; [
 &#39;multibucket&#39; =&gt; true,
 &#39;hostname&#39; =&gt; &#39;s3-server2.example.com&#39;,
 &#39;bucket&#39; =&gt; &#39;s2_nextcloud_&#39;,
 ...
 ],
 ],
],
</pre></div>
</div>
<div class="admonition note">
Note
Bucket names must be unique between all configured object store instances.
</div>
Newly created users will be mapped to the object store instance set in <code class="code docutils literal notranslate">default</code>.
Files that are not part of the users storage are put in the <code class="code docutils literal notranslate">root</code> instance, or
in the <code class="code docutils literal notranslate">default</code> instance if no <code class="code docutils literal notranslate">root</code> instance is configured.
In the above example, if <code class="code docutils literal notranslate">server2</code> is starting to run low on capacity, an admin can
setup and configure a new <code class="code docutils literal notranslate">server3</code> and change the <code class="code docutils literal notranslate">default</code> to <code class="code docutils literal notranslate">server3</code>.
Than any newly created user will have their files put on <code class="code docutils literal notranslate">server3</code>.
<div class="admonition note">
Note
As with multibucket object store, the user-to-instance mapping is only created once,
so only newly created users will be mapped to the new default instance.
</div>
It is possible to mix different object store backends and multibucket and non-multibucket in
a multi-instance configuration.
</section>
<section id="s3-sse-c-encryption-support">
<h2>S3 SSE-C encryption support<a class="headerlink" href="#s3-sse-c-encryption-support" title="Link to this heading"></a></h2>
Nextcloud supports server side encryption, also known as <a class="reference external" href="http://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">SSE-C</a>, with compatible S3 bucket provider. The encryption and decryption happens on the S3 bucket side with a key provided by the Nextcloud server.
The key can be specified with the <code class="code docutils literal notranslate">sse_c_key</code> parameter which needs to be provided as a base64 encoded string with a maximum length of 32 bytes. A random key could be generated using the the following command:
<div class="highlight-default notranslate"><div class="highlight"><pre>openssl rand 32 | base64
</pre></div>
</div>
The following example shows how to configure the S3 object store with SSE-C encryption support in the objectstore section of the Nextcloud config.php file:
<div class="highlight-default notranslate"><div class="highlight"><pre>&#39;objectstore&#39; =&gt; [
 array (
 &#39;class&#39; =&gt; &#39;OC\\Files\\ObjectStore\\S3&#39;,
 &#39;arguments&#39; =&gt;
 array (
 &#39;bucket&#39; =&gt; &#39;nextcloud&#39;,
 &#39;key&#39; =&gt; &#39;nextcloud&#39;,
 &#39;secret&#39; =&gt; &#39;nextcloud&#39;,
 &#39;hostname&#39; =&gt; &#39;s3&#39;,
 &#39;port&#39; =&gt; &#39;443&#39;,
 &#39;use_ssl&#39; =&gt; true,
 &#39;use_path_style&#39; =&gt; true,
 &#39;autocreate&#39; =&gt; true,
 &#39;verify_bucket_exists&#39; =&gt; true,
 &#39;sse_c_key&#39; =&gt; &#39;o9d3Q9tHcPMv6TIpH53MSXaUmY91YheZRwuIhwCFRSs=&#39;,
 ),
 );
],
</pre></div>
</div>
</section>
</section>

</div>
 </div>
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
 <a href="default_files_configuration.html" class="btn btn-neutral float-left" title="Providing default files" accesskey="p" rel="prev"> Previous</a>
 <a href="external_storage_configuration_gui.html" class="btn btn-neutral float-right" title="Configuring External Storage (GUI)" accesskey="n" rel="next">Next </a>
 </div>

<hr/>

<div role="contentinfo">
 &#169; Copyright 2016-2026 Nextcloud GmbH and Nextcloud contributors.
 </div>

</footer>
 </div>
 </div>
 </section>
 </div>

<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
 
 ☁️ latest
 
 
 <div class="rst-other-versions">
 <dl>
 <dt>☁️ Versions</dt>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/latest/admin_manual"
 
 style="color: var(--dark-link-color);"
 
 >
 latest
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/stable/admin_manual"
 
 >
 stable
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/32/admin_manual"
 
 >
 32
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/31/admin_manual"
 
 >
 31
 </a>
 </dd>
 
 </dl>
 </div>
 </div>
<script>
 jQuery(function () {
 SphinxRtdTheme.Navigation.enable(true);
 });
 </script>

</body>
</html>

Cancel