chore: Add docs about GCS Storage (#1560)

This commit is contained in:
Pranav Raj S 2020-12-28 23:15:45 +05:30 committed by GitHub
parent 99125d3b9c
commit 08f1e0eb32
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 77 additions and 2 deletions

View file

@ -1,6 +1,6 @@
---
path: "/docs/configuring-s3-bucket-as-cloud-storage"
title: "Configuring Cloud Storage"
title: "Configuring S3 Bucket as storage in Chatwoot"
---
### Using Amazon S3

View file

@ -1,6 +1,6 @@
---
path: "/docs/self-hosted/enable-ip-logging"
title: "Chatwoot Production deployment guide"
title: "Enable IP Logging"
---
Chatwoot allows you to identify the location of the user by geocoding the IP address. For IP Address geocoding, we support MaxmindDB services. This lookup provides methods for geocoding IP addresses without making a call to a remote API everytime. To setup your self-hosted instance with the geocoding, follow the steps below.

View file

@ -0,0 +1,75 @@
---
path: "/docs/self-hosted/storage/configuring-gcs"
title: "Configure GCS as storage in Chatwoot"
---
Chatwoot supports Google Cloud storage as the storage provider. To enable GCS in Chatwoot, follow the below mentioned steps.
Set google as the active storage service in the environment variables
```bash
ACTIVE_STORAGE_SERVICE='google'
```
### Get project ID variable
Login to your Google Cloud console. On your home page of your project you will be able to see the project id and project name as follows.
![get-your-project-id](./images/get-your-project-id.png)
```bash
GCS_PROJECT=your-project-id
```
### Setup GCS Bucket
Go to Storage -> Browser. Click on "Create Bucket". You will be presented with a screen as shown below. Select the default values and continue.
![create-a-bucket](./images/create-a-bucket.png)
Once this is done you will get the bucket name. Set this as GCS_BUCKET.
```
GCS_BUCKET=your-bucket-name
```
### Setup a service account
Go to `Identity & Services -> Identity -> Service Accounts`. Click on "Create Service Account".
Provice a name and an ID for the service account, click on create. You will be asked to "Grant this service account access to the project" Select Cloud Storage -> Storage Admin as shown below.
![storage-admin](./images/storage-admin.png)
### Add service account to the bucket
Go to Storage -> Browser -> Your bucket -> Permissions. Click on add. On "New members" field select the service account you just created.
Select role as `Cloud Storage -> Storage Admin` and save.
![permissions](./images/permissions.png)
### Generate a key for the service account
Go to `Identity & Services -> Identity -> Service Accounts -> Your service account`. There is a section called **Keys**. Click on **Add Key**. You will be presented with an option like the one below. Select JSON from the option.
![json](./images/json.png)
Copy the json file content and set it as GCS_CREDENTIALS
A sample credential file is of the following format.
```json
{
"type": "service_account",
"project_id": "",
"private_key_id": "",
"private_key": "",
"client_email": "",
"client_id": "",
"auth_uri": "",
"token_uri": "",
"auth_provider_x509_cert_url": "",
"client_x509_cert_url": ""
}
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 741 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 632 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 665 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 644 KiB