diff --git a/docs/development/project-setup/storage/s3-bucket.md b/docs/development/project-setup/storage/s3-bucket.md index 7021049ca..4daa16292 100644 --- a/docs/development/project-setup/storage/s3-bucket.md +++ b/docs/development/project-setup/storage/s3-bucket.md @@ -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 diff --git a/docs/self-hosted/enable-ip-logging.md b/docs/self-hosted/enable-ip-logging.md index aba6edde8..650a60eff 100644 --- a/docs/self-hosted/enable-ip-logging.md +++ b/docs/self-hosted/enable-ip-logging.md @@ -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. diff --git a/docs/self-hosted/storage/configuring-gcs.md b/docs/self-hosted/storage/configuring-gcs.md new file mode 100644 index 000000000..48c4ce16c --- /dev/null +++ b/docs/self-hosted/storage/configuring-gcs.md @@ -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": "" +} +``` diff --git a/docs/self-hosted/storage/images/create-a-bucket.png b/docs/self-hosted/storage/images/create-a-bucket.png new file mode 100644 index 000000000..cf01b5aa3 Binary files /dev/null and b/docs/self-hosted/storage/images/create-a-bucket.png differ diff --git a/docs/self-hosted/storage/images/get-your-project-id.png b/docs/self-hosted/storage/images/get-your-project-id.png new file mode 100644 index 000000000..22e006093 Binary files /dev/null and b/docs/self-hosted/storage/images/get-your-project-id.png differ diff --git a/docs/self-hosted/storage/images/json.png b/docs/self-hosted/storage/images/json.png new file mode 100644 index 000000000..f8ae674fb Binary files /dev/null and b/docs/self-hosted/storage/images/json.png differ diff --git a/docs/self-hosted/storage/images/permissions.png b/docs/self-hosted/storage/images/permissions.png new file mode 100644 index 000000000..942c0889c Binary files /dev/null and b/docs/self-hosted/storage/images/permissions.png differ diff --git a/docs/self-hosted/storage/images/storage-admin.png b/docs/self-hosted/storage/images/storage-admin.png new file mode 100644 index 000000000..261ccdd9d Binary files /dev/null and b/docs/self-hosted/storage/images/storage-admin.png differ