Skip to content

Commit

Permalink
Minor docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jschneier committed Sep 10, 2019
1 parent 6237948 commit 5d29ac6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/backends/apache_libcloud.rst
Expand Up @@ -154,7 +154,7 @@ set::
Your default Libcloud provider will be used as the file store.

Certificate authorities
----------------------
-----------------------

Libcloud uses HTTPS connections, and in order to validate that these HTTPS connections are
correctly signed, root CA certificates must be present. On some platforms
Expand Down
18 changes: 8 additions & 10 deletions docs/backends/gcloud.rst
Expand Up @@ -19,18 +19,15 @@ current Google Compute Engine (GCE) or Google Kubernetes Engine (GKE) instance
for authentication. In most cases, the default service accounts are not sufficient
to read/write and sign files in GCS.

1. Create a service account.
(`Google Getting Started Guide <https://cloud.google.com/docs/authentication/getting-started>`__)
1. Create a service account. (`Google Getting Started Guide <https://cloud.google.com/docs/authentication/getting-started>`__)

2. Create the key and download `your-project-XXXXX.json` file.

3. Make sure your service account has access to the bucket and appropriate permissions.
(`Using IAM Permissions <https://cloud.google.com/storage/docs/access-control/using-iam-permissions>`__)
3. Make sure your service account has access to the bucket and appropriate permissions. (`Using IAM Permissions <https://cloud.google.com/storage/docs/access-control/using-iam-permissions>`__)

4. The key must be mounted/available to your running Django app.
Note: a json keyfile will work for developer machines (or other instances outside Google infrastructure).
4. The key must be mounted/available to your running Django app. Note: a json keyfile will work for developer machines (or other instances outside Google infrastructure).

5. Set an environment variable of GOOGLE_APPLICATION_CREDENTIALS to path of the json file.
5. Set an environment variable of GOOGLE_APPLICATION_CREDENTIALS to the path of the json file.

Alternatively, you can use the setting `GS_CREDENTIALS` as described below.

Expand Down Expand Up @@ -118,11 +115,12 @@ translated.)
For most cases, the blob will need to be set to the ``publicRead`` ACL in order for the file to be viewed.
If GS_DEFAULT_ACL is not set, the blob will have the default permissions set by the bucket.

``publicRead`` files will return a public - non-expiring url. All other files return
``publicRead`` files will return a public, non-expiring url. All other files return
a signed (expiring) url.

**GS_DEFAULT_ACL must be set to ``publicRead`` to return a public url.** Even if you set
the bucket to public or set the file permissions directly in GCS to public.
.. note::
GS_DEFAULT_ACL must be set to 'publicRead' to return a public url. Even if you set
the bucket to public or set the file permissions directly in GCS to public.


``GS_FILE_CHARSET`` (optional)
Expand Down

0 comments on commit 5d29ac6

Please sign in to comment.