v1.0.9 (#37)

Features:
- Integrated the first service: [Plausible Analytics](https://plausible.io)!

Fixes:
- UI/UX fixes and new designs

api/libs/applications/configuration.js

@@ -2,7 +2,7 @@ const { uniqueNamesGenerator, adjectives, colors, animals } = require('unique-na
 const cuid = require('cuid')
 const crypto = require('crypto')
 const { docker } = require('../docker')
-const { execShellAsync } = require('../common')
+const { execShellAsync, baseServiceConfiguration } = require('../common')
 
 function getUniq () {
   return uniqueNamesGenerator({ dictionaries: [adjectives, animals, colors], length: 2 })
@@ -15,25 +15,6 @@ function setDefaultConfiguration (configuration) {
   const shaBase = JSON.stringify({ repository: configuration.repository })
   const sha256 = crypto.createHash('sha256').update(shaBase).digest('hex')
 
-  const baseServiceConfiguration = {
-    replicas: 1,
-    restart_policy: {
-      condition: 'any',
-      max_attempts: 3
-    },
-    update_config: {
-      parallelism: 1,
-      delay: '10s',
-      order: 'start-first'
-    },
-    rollback_config: {
-      parallelism: 1,
-      delay: '10s',
-      order: 'start-first',
-      failure_action: 'rollback'
-    }
-  }
-
   configuration.build.container.name = sha256.slice(0, 15)
 
   configuration.general.nickname = nickname
@@ -133,4 +114,4 @@ async function precheckDeployment ({ services, configuration }) {
     forceUpdate
   }
 }
-module.exports = { setDefaultConfiguration, updateServiceLabels, precheckDeployment }
+module.exports = { setDefaultConfiguration, updateServiceLabels, precheckDeployment, baseServiceConfiguration }

api/libs/common.js

@@ -6,6 +6,24 @@ const User = require('../models/User')
 const algorithm = 'aes-256-cbc'
 const key = process.env.SECRETS_ENCRYPTION_KEY
 
+const baseServiceConfiguration = {
+  replicas: 1,
+  restart_policy: {
+    condition: 'any',
+    max_attempts: 3
+  },
+  update_config: {
+    parallelism: 1,
+    delay: '10s',
+    order: 'start-first'
+  },
+  rollback_config: {
+    parallelism: 1,
+    delay: '10s',
+    order: 'start-first',
+    failure_action: 'rollback'
+  }
+}
 function delay (t) {
   return new Promise(function (resolve) {
     setTimeout(function () {
@@ -94,5 +112,6 @@ module.exports = {
   checkImageAvailable,
   encryptData,
   decryptData,
-  verifyUserId
+  verifyUserId,
+  baseServiceConfiguration
 }

api/libs/services/plausible/index.js

@@ -0,0 +1,185 @@
+const { execShellAsync, cleanupTmp, baseServiceConfiguration } = require('../../common')
+const yaml = require('js-yaml')
+const fs = require('fs').promises
+const generator = require('generate-password')
+const { docker } = require('../../docker')
+
+async function plausible ({ email, userName, userPassword, baseURL, traefikURL }) {
+  const deployId = 'plausible'
+  const workdir = '/tmp/plausible'
+  const secretKey = generator.generate({ length: 64, numbers: true, strict: true })
+  const generateEnvsPostgres = {
+    POSTGRESQL_PASSWORD: generator.generate({ length: 24, numbers: true, strict: true }),
+    POSTGRESQL_USERNAME: generator.generate({ length: 10, numbers: true, strict: true }),
+    POSTGRESQL_DATABASE: 'plausible'
+  }
+
+  const secrets = [
+    { name: 'ADMIN_USER_EMAIL', value: email },
+    { name: 'ADMIN_USER_NAME', value: userName },
+    { name: 'ADMIN_USER_PWD', value: userPassword },
+    { name: 'BASE_URL', value: baseURL },
+    { name: 'SECRET_KEY_BASE', value: secretKey },
+    { name: 'DISABLE_AUTH', value: 'false' },
+    { name: 'DISABLE_REGISTRATION', value: 'true' },
+    { name: 'DATABASE_URL', value: `postgresql://${generateEnvsPostgres.POSTGRESQL_USERNAME}:${generateEnvsPostgres.POSTGRESQL_PASSWORD}@plausible_db:5432/${generateEnvsPostgres.POSTGRESQL_DATABASE}` },
+    { name: 'CLICKHOUSE_DATABASE_URL', value: 'http://plausible_events_db:8123/plausible' }
+  ]
+
+  const generateEnvsClickhouse = {}
+  for (const secret of secrets) generateEnvsClickhouse[secret.name] = secret.value
+
+  const clickhouseConfigXml = `
+    <yandex>
+      <logger>
+          <level>warning</level>
+          <console>true</console>
+      </logger>
+
+      <!-- Stop all the unnecessary logging -->
+      <query_thread_log remove="remove"/>
+      <query_log remove="remove"/>
+      <text_log remove="remove"/>
+      <trace_log remove="remove"/>
+      <metric_log remove="remove"/>
+      <asynchronous_metric_log remove="remove"/>
+  </yandex>`
+  const clickhouseUserConfigXml = `
+    <yandex>
+      <profiles>
+          <default>
+              <log_queries>0</log_queries>
+              <log_query_threads>0</log_query_threads>
+          </default>
+      </profiles>
+  </yandex>`
+
+  const clickhouseConfigs = [
+    { source: 'plausible-clickhouse-user-config.xml', target: '/etc/clickhouse-server/users.d/logging.xml' },
+    { source: 'plausible-clickhouse-config.xml', target: '/etc/clickhouse-server/config.d/logging.xml' },
+    { source: 'plausible-init.query', target: '/docker-entrypoint-initdb.d/init.query' },
+    { source: 'plausible-init-db.sh', target: '/docker-entrypoint-initdb.d/init-db.sh' }
+  ]
+
+  const initQuery = 'CREATE DATABASE IF NOT EXISTS plausible;'
+  const initScript = 'clickhouse client --queries-file /docker-entrypoint-initdb.d/init.query'
+  await execShellAsync(`mkdir -p ${workdir}`)
+  await fs.writeFile(`${workdir}/clickhouse-config.xml`, clickhouseConfigXml)
+  await fs.writeFile(`${workdir}/clickhouse-user-config.xml`, clickhouseUserConfigXml)
+  await fs.writeFile(`${workdir}/init.query`, initQuery)
+  await fs.writeFile(`${workdir}/init-db.sh`, initScript)
+  const stack = {
+    version: '3.8',
+    services: {
+      [deployId]: {
+        image: 'plausible/analytics:latest',
+        command: 'sh -c "sleep 10 && /entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh db init-admin && /entrypoint.sh run"',
+        networks: [`${docker.network}`],
+        volumes: [`${deployId}-postgres-data:/var/lib/postgresql/data`],
+        environment: generateEnvsClickhouse,
+        deploy: {
+          ...baseServiceConfiguration,
+          labels: [
+            'managedBy=coolify',
+            'type=service',
+            'serviceName=plausible',
+            'configuration=' + JSON.stringify({ email, userName, userPassword, baseURL, secretKey, generateEnvsPostgres, generateEnvsClickhouse }),
+            'traefik.enable=true',
+            'traefik.http.services.' +
+            deployId +
+            '.loadbalancer.server.port=8000',
+            'traefik.http.routers.' +
+            deployId +
+            '.entrypoints=websecure',
+            'traefik.http.routers.' +
+            deployId +
+            '.rule=Host(`' +
+            traefikURL +
+            '`) && PathPrefix(`/`)',
+            'traefik.http.routers.' +
+            deployId +
+            '.tls.certresolver=letsencrypt',
+            'traefik.http.routers.' +
+            deployId +
+            '.middlewares=global-compress'
+          ]
+        }
+      },
+      plausible_db: {
+        image: 'bitnami/postgresql:13.2.0',
+        networks: [`${docker.network}`],
+        environment: generateEnvsPostgres,
+        deploy: {
+          ...baseServiceConfiguration,
+          labels: [
+            'managedBy=coolify',
+            'type=service',
+            'serviceName=plausible'
+          ]
+        }
+      },
+      plausible_events_db: {
+        image: 'yandex/clickhouse-server:21.3.2.5',
+        networks: [`${docker.network}`],
+        volumes: [`${deployId}-clickhouse-data:/var/lib/clickhouse`],
+        ulimits: {
+          nofile: {
+            soft: 262144,
+            hard: 262144
+          }
+        },
+        configs: [...clickhouseConfigs],
+        deploy: {
+          ...baseServiceConfiguration,
+          labels: [
+            'managedBy=coolify',
+            'type=service',
+            'serviceName=plausible'
+          ]
+        }
+      }
+    },
+    networks: {
+      [`${docker.network}`]: {
+        external: true
+      }
+    },
+    volumes: {
+      [`${deployId}-clickhouse-data`]: {
+        external: true
+      },
+      [`${deployId}-postgres-data`]: {
+        external: true
+      }
+    },
+    configs: {
+      'plausible-clickhouse-user-config.xml': {
+        file: `${workdir}/clickhouse-user-config.xml`
+      },
+      'plausible-clickhouse-config.xml': {
+        file: `${workdir}/clickhouse-config.xml`
+      },
+      'plausible-init.query': {
+        file: `${workdir}/init.query`
+      },
+      'plausible-init-db.sh': {
+        file: `${workdir}/init-db.sh`
+      }
+    }
+  }
+  await fs.writeFile(`${workdir}/stack.yml`, yaml.dump(stack))
+  await execShellAsync('docker stack rm plausible')
+  await execShellAsync(
+    `cat ${workdir}/stack.yml | docker stack deploy --prune -c - ${deployId}`
+  )
+  cleanupTmp(workdir)
+}
+
+async function activateAdminUser () {
+  const { POSTGRESQL_USERNAME, POSTGRESQL_PASSWORD, POSTGRESQL_DATABASE } = JSON.parse(JSON.parse((await execShellAsync('docker service inspect plausible_plausible --format=\'{{json .Spec.Labels.configuration}}\'')))).generateEnvsPostgres
+  const containers = (await execShellAsync('docker ps -a --format=\'{{json .Names}}\'')).replace(/"/g, '').trim().split('\n')
+  const postgresDB = containers.find(container => container.startsWith('plausible_plausible_db'))
+  await execShellAsync(`docker exec ${postgresDB} psql -H postgresql://${POSTGRESQL_USERNAME}:${POSTGRESQL_PASSWORD}@localhost:5432/${POSTGRESQL_DATABASE} -c "UPDATE users SET email_verified = true;"`)
+}
+
+module.exports = { plausible, activateAdminUser }