Skip to content

Commit 0088fdc

Browse files
committed
Add Self-hosted S3 section to the docs
1 parent 0c87df5 commit 0088fdc

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/source/index.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,26 @@ Furthermore, ``S3FileSystem.current()`` will return the most-recently created
119119
instance, so this method could be used in preference to the constructor in
120120
cases where the code must be agnostic of the credentials/config used.
121121

122+
Self-hosted S3
123+
--------------
124+
125+
To use S3Fs against your self hosted S3-compatible storage, like `MinIO`_ or
126+
`Ceph Object Gateway`_, you can set your custom ``endpoint_url`` when creating
127+
the S3Fs filesystem:
128+
129+
.. code-block:: python
130+
131+
>>> s3 = s3fs.S3FileSystem(
132+
anon=false,
133+
client_kwargs={
134+
'endpoint_url': 'https://...'
135+
}
136+
)
137+
138+
139+
.. _MinIO: https://min.io
140+
.. _Ceph Object Gateway: https://docs.ceph.com/docs/master/radosgw/
141+
122142
Requester Pays Buckets
123143
----------------------
124144

0 commit comments

Comments
 (0)