From ac7fdaa997106b4d1585f1623ea9518727cb4690 Mon Sep 17 00:00:00 2001
From: Pranav Raj S <pranav@thoughtwoot.com>
Date: Wed, 16 Dec 2020 00:32:05 +0530
Subject: [PATCH] chore: Add documentation for Maxmind geocoder setup (#1518)

---
 .../dashboard/i18n/locale/en/contact.json     |  1 +
 .../dashboard/conversation/ContactPanel.vue   | 12 +++++++
 docs/self-hosted/enable-ip-logging.md         | 32 +++++++++++++++++++
 3 files changed, 45 insertions(+)
 create mode 100644 docs/self-hosted/enable-ip-logging.md

diff --git a/app/javascript/dashboard/i18n/locale/en/contact.json b/app/javascript/dashboard/i18n/locale/en/contact.json
index 684a56ee5..da85ffab8 100644
--- a/app/javascript/dashboard/i18n/locale/en/contact.json
+++ b/app/javascript/dashboard/i18n/locale/en/contact.json
@@ -11,6 +11,7 @@
     "OS": "Operating System",
     "INITIATED_FROM": "Initiated from",
     "INITIATED_AT": "Initiated at",
+    "IP_ADDRESS": "IP Address",
     "CONVERSATIONS": {
       "NO_RECORDS_FOUND": "There are no previous conversations associated to this contact.",
       "TITLE": "Previous Conversations"
diff --git a/app/javascript/dashboard/routes/dashboard/conversation/ContactPanel.vue b/app/javascript/dashboard/routes/dashboard/conversation/ContactPanel.vue
index 1c7572d44..50662ad9b 100644
--- a/app/javascript/dashboard/routes/dashboard/conversation/ContactPanel.vue
+++ b/app/javascript/dashboard/routes/dashboard/conversation/ContactPanel.vue
@@ -11,6 +11,12 @@
         :value="location"
         icon="ion-map"
       />
+      <contact-details-item
+        v-if="ipAddress"
+        :title="$t('CONTACT_PANEL.IP_ADDRESS')"
+        :value="ipAddress"
+        icon="ion-android-locate"
+      />
       <contact-details-item
         v-if="browser.browser_name"
         :title="$t('CONTACT_PANEL.BROWSER')"
@@ -106,6 +112,12 @@ export default {
       return `${this.browser.browser_name || ''} ${this.browser
         .browser_version || ''}`;
     },
+    ipAddress() {
+      const {
+        additional_attributes: { created_at_ip: createdAtIp },
+      } = this.contact;
+      return createdAtIp;
+    },
     location() {
       const {
         additional_attributes: {
diff --git a/docs/self-hosted/enable-ip-logging.md b/docs/self-hosted/enable-ip-logging.md
new file mode 100644
index 000000000..aba6edde8
--- /dev/null
+++ b/docs/self-hosted/enable-ip-logging.md
@@ -0,0 +1,32 @@
+---
+path: "/docs/self-hosted/enable-ip-logging"
+title: "Chatwoot Production deployment guide"
+---
+
+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.
+
+**Step 1:** Create an account at [MaxmindDB](https://www.maxmind.com) and create an API key.
+
+**Step 2:** Add the following environment variables.
+
+```bash
+IP_LOOKUP_SERVICE=geoip2
+IP_LOOKUP_API_KEY=your-api-key
+```
+
+With this step, Chatwoot would automatically download the [MaxmindDB downloadable databases](https://dev.maxmind.com/geoip/geoip2/downloadable/) and cache it locally.
+
+**Step 3:** Enable IP Lookup on your account.
+
+Login to Rails console
+
+```
+RAILS_ENV=production bundle exec rails console
+```
+
+```rb
+account_id = 1 // Please fill your account id instead of 1
+account = Account.find(account_id)
+account.enable_features('ip_lookup')
+account.save!
+```