← Back
Editing: amazons3.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" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Amazon S3 — Nextcloud latest Administration Manual latest documentation</title> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" /> <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" /> <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=8ff6e0db" /> <link rel="stylesheet" type="text/css" href="../../_static/dark_mode_css/general.css?v=c0a7eb24" /> <link rel="stylesheet" type="text/css" href="../../_static/dark_mode_css/dark.css?v=70edf1c7" /> <link rel="canonical" href="https://docs.nextcloud.com/server/stable/admin_manual/configuration_files/external_storage/amazons3.html" /> <script src="../../_static/jquery.js?v=5d32c60e"></script> <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../../_static/documentation_options.js?v=a49d5d77"></script> <script src="../../_static/doctools.js?v=9bcbadda"></script> <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../../_static/clipboard.min.js?v=a7894cd8"></script> <script src="../../_static/copybutton.js?v=f281be69"></script> <script src="../../_static/dark_mode_js/default_light.js?v=c2e647ce"></script> <script src="../../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script> <script src="../../_static/js/theme.js"></script> <script src="../../_static/js/versions.js"></script> <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="FTP/FTPS" href="ftp.html" /> <link rel="prev" title="Configuring External Storage (GUI)" href="../external_storage_configuration_gui.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <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"> <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p> <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> <p class="caption" role="heading"><span class="caption-text">Release notes</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../release_notes/index.html">Critical changes</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Installation</span></p> <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> <p class="caption" role="heading"><span class="caption-text">Configuration</span></p> <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> <p class="caption" role="heading"><span class="caption-text">Files</span></p> <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 > 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"><a class="reference internal" href="../primary_storage.html">Configuring Object Storage as Primary Storage</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../external_storage_configuration_gui.html">Configuring External Storage (GUI)</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#enabling-external-storage-support">Enabling External Storage Support</a></li> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#storage-configuration">Storage configuration</a></li> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#usage-of-variables-for-mount-paths">Usage of variables for mount paths</a></li> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#user-and-group-permissions">User and group permissions</a></li> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#mount-options">Mount options</a></li> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#using-self-signed-certificates">Using self-signed certificates</a></li> <li class="toctree-l3 current"><a class="reference internal" href="../external_storage_configuration_gui.html#available-storage-backends">Available storage backends</a><ul class="current"> <li class="toctree-l4 current"><a class="current reference internal" href="#">Amazon S3</a></li> <li class="toctree-l4"><a class="reference internal" href="ftp.html">FTP/FTPS</a></li> <li class="toctree-l4"><a class="reference internal" href="local.html">Local</a></li> <li class="toctree-l4"><a class="reference internal" href="nextcloud.html">Nextcloud</a></li> <li class="toctree-l4"><a class="reference internal" href="openstack.html">OpenStack Object Storage</a></li> <li class="toctree-l4"><a class="reference internal" href="sftp.html">SFTP</a></li> <li class="toctree-l4"><a class="reference internal" href="smb.html">SMB/CIFS</a></li> <li class="toctree-l4"><a class="reference internal" href="webdav.html">WebDAV</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#allow-users-to-mount-external-storage">Allow users to mount external Storage</a></li> <li class="toctree-l3"><a class="reference internal" href="../external_storage_configuration_gui.html#adding-files-to-external-storages">Adding files to external storages</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="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> <p class="caption" role="heading"><span class="caption-text">Apps</span></p> <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> <p class="caption" role="heading"><span class="caption-text">Users</span></p> <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> <p class="caption" role="heading"><span class="caption-text">Groupware</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../groupware/index.html">Groupware</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Office</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../office/index.html">Office</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Maintenance</span></p> <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> <p class="caption" role="heading"><span class="caption-text">Links</span></p> <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" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <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"><a href="../external_storage_configuration_gui.html">Configuring External Storage (GUI)</a></li> <li class="breadcrumb-item active">Amazon S3</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_files/external_storage/amazons3.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="amazon-s3"> <h1>Amazon S3<a class="headerlink" href="#amazon-s3" title="Link to this heading"></a></h1> <p>To connect an Amazon S3 (or compatible) bucket to Nextcloud you will need to know your:</p> <ul class="simple"> <li><p>S3 bucket name</p></li> <li><p>S3 access key ID</p></li> <li><p>S3 secret access key</p></li> <li><p>S3 region (if Amazon hosted) or S3 hostname (if non-Amazon hosted) [Note: If specifying a hostname, use the generic S3 endpoint hostname, <strong>not</strong> the hostname that contains your bucket name]</p></li> </ul> <p>In the <strong>Folder name</strong> field enter a folder name to use as the local mountpoint for this external storage. If this does not exist it will be created.</p> <p>In the <strong>External storage</strong> field select <strong>Amazon S3</strong>.</p> <p>In the <strong>Authentication</strong> field select <strong>Access key</strong>.</p> <p>In the <strong>Bucket</strong> field enter your <em>S3 bucket name</em>. [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]</p> <p>In the <strong>Access key</strong> field enter your <em>S3 access key ID</em>.</p> <p>In the <strong>Secret key</strong> field enter your <em>S3 access key</em>.</p> <p><strong>If you are using Amazon S3:</strong> the <code class="code docutils literal notranslate"><span class="pre">Region</span></code> parameter is required unless you’re happy with the default of <code class="code docutils literal notranslate"><span class="pre">eu-west-1</span></code> (which will be used if you don’t specify anything). There is no need to override the <code class="code docutils literal notranslate"><span class="pre">Hostname</span></code> or <code class="code docutils literal notranslate"><span class="pre">Port</span></code>. And <code class="code docutils literal notranslate"><span class="pre">Storage</span> <span class="pre">Class</span></code> only needs to be modified if you’re using a different configuration at AWS. Lastly, <code class="code docutils literal notranslate"><span class="pre">Enable</span> <span class="pre">Path</span> <span class="pre">Style</span></code> is rarely required with Amazon, but some legacy Amazon datacenters may require it. Leave <code class="code docutils literal notranslate"><span class="pre">Legacy</span> <span class="pre">(v2)</span> <span class="pre">authentication</span></code> unselected.</p> <p><strong>If you using a non-Amazon hosted S3 store:</strong> you will need to set the <code class="code docutils literal notranslate"><span class="pre">Hostname</span></code> parameter (and can ignore the <code class="code docutils literal notranslate"><span class="pre">Region</span></code> parameter). You may need to enable <code class="code docutils literal notranslate"><span class="pre">Enable</span> <span class="pre">Path</span> <span class="pre">Style</span></code> if your non-Amazon S3 store does <em>not</em> support requests like <code class="code docutils literal notranslate"><span class="pre">https://bucket.hostname.domain/</span></code>. Setting <code class="code docutils literal notranslate"><span class="pre">Enable</span> <span class="pre">Path</span> <span class="pre">Style</span></code> to true configures the S3 client to make requests like <code class="code docutils literal notranslate"><span class="pre">https://hostname.domain/bucket</span></code> instead. It’s rare to need <code class="code docutils literal notranslate"><span class="pre">Legacy</span> <span class="pre">(v2)</span> <span class="pre">authentication</span></code>, but enable it if your in-house object store or service provider requires it over the default (v4) authentication.</p> <p>In the <strong>Available for</strong> field enter the users or groups who you want to give access your S3 mount.</p> <p>The <code class="docutils literal notranslate"><span class="pre">Enable</span> <span class="pre">SSL</span></code> checkbox enables HTTPS connections and generally preferred. It is the default unless you disable it here.</p> <p>Optionally, a 32-byte base64 encoded SSE-C key can be provided for server side encryption. See <a class="reference internal" href="../primary_storage.html"><span class="doc">Configuring Object Storage as Primary Storage</span></a> and the <a class="reference external" href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html">SSE-C AWS documentation</a> for more information how to generate a key.</p> <figure class="align-default"> <img alt="" src="../../_images/amazons3.png" /> </figure> <p>See <a class="reference internal" href="../external_storage_configuration_gui.html"><span class="doc">Configuring External Storage (GUI)</span></a> for additional mount options and information.</p> <p>See <a class="reference internal" href="auth_mechanisms.html"><span class="doc">External Storage authentication mechanisms</span></a> for more information on authentication schemes.</p> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="../external_storage_configuration_gui.html" class="btn btn-neutral float-left" title="Configuring External Storage (GUI)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="ftp.html" class="btn btn-neutral float-right" title="FTP/FTPS" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2016-2026 Nextcloud GmbH and Nextcloud contributors.</p> </div> </footer> </div> </div> </section> </div> <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> ☁️ latest <span class="fa fa-caret-down"></span> </span> <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>
Save File
Cancel