Cycle 1 Deployment - Merge pull request #244 from coollabsio/next

Author: ShadowArcanist

bun.lockb

@@ -7,6 +7,7 @@ import spec from '../public/openapi.json' with { type: 'json' }
 import container from 'markdown-it-container'
 import { bundledLanguages } from 'shiki'
 import { join, dirname } from 'node:path'
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
 
 const sidebar = useSidebar({ spec, collapsible: true })
 
@@ -141,6 +142,7 @@ export default defineConfig({
             text: 'Overview',
             link: '/databases/index',
             items: [
+              { text: 'Database SSL', link: '/databases/ssl' },
               { text: 'Backups', link: '/databases/backups' },
               { text: 'MySQL', link: '/databases/mysql' },
               { text: 'MariaDB', link: '/databases/mariadb' },
@@ -163,11 +165,14 @@ export default defineConfig({
             link: '/services/overview',
             items: [
               { text: 'ActivePieces', link: '/services/activepieces' },
+              { text: 'Actual Budget', link: '/services/actualbudget' },
               { text: 'AnythingLLM', link: '/services/anythingllm' },
               { text: 'Appsmith', link: '/services/appsmith' },
               { text: 'Appwrite', link: '/services/appwrite' },
               { text: 'Argilla', link: '/services/argilla' },
               { text: 'Authentik', link: '/services/authentik' },
+              { text: 'Affine', link: '/services/affine' },
+              { text: 'Apprise API', link: '/services/apprise-api' },
               { text: 'Baby Buddy', link: '/services/babybuddy' },
               { text: 'Beszel', link: '/services/beszel' },
               { text: 'Browserless', link: '/services/browserless' },
@@ -341,6 +346,7 @@ export default defineConfig({
                   { text: 'Environment Variables', link: '/knowledge-base/environment-variables' },
                   { text: 'Persistent Storage', link: '/knowledge-base/persistent-storage' },
                   { text: 'Drain Logs', link: '/knowledge-base/drain-logs' },
+                  { text: 'Rolling Updates', link: '/knowledge-base/rolling-updates' },
                   { text: 'Health Checks', link: '/knowledge-base/health-checks' },
                   { text: 'Cron Syntax', link: '/knowledge-base/cron-syntax' },
                 ]
@@ -349,6 +355,7 @@ export default defineConfig({
                 text: 'How-Tos',
                 collapsed: true,
                 items: [
+                  { text: 'Backup & Restore Coolify', link: '/knowledge-base/how-to/backup-restore-coolify' },
                   { text: 'Load-balancing on Hetzner', link: '/knowledge-base/how-to/hetzner-loadbalancing' },
                   { text: 'Wordpress Multisite', link: '/knowledge-base/how-to/wordpress-multisite' },
                   { text: 'Raspberry Pi OS Setup', link: '/knowledge-base/how-to/raspberry-pi-os' },
@@ -462,6 +469,7 @@ export default defineConfig({
                     collapsed: true,
                     items: [
                       { text: 'Overview', link: '/knowledge-base/proxy/caddy/overview' },
+                      { text: 'Basic Auth', link: '/knowledge-base/proxy/caddy/basic-auth' },
                     ]
                   },
                 ]
@@ -578,6 +586,7 @@ export default defineConfig({
           }
         }
       })
+      md.use(tabsMarkdownPlugin)
     },
     theme: {
       light: 'github-light',

docs/.vitepress/config.mts

@@ -18,6 +18,9 @@ import "./scrollbar.css";
 import "./tailwind.postcss";
 import "vitepress-openapi/dist/style.css";
 
+// Import plugins
+import { enhanceAppWithTabs } from "vitepress-plugin-tabs/client";
+
 // @ts-ignore
 import spec from "../../public/openapi.json" assert { type: "json" };
 
@@ -40,13 +43,15 @@ export default {
   extends: DefaultTheme,
   Layout: Landing,
   enhanceApp({ app, router, siteData }) {
+    enhanceAppWithTabs(app);
+
     const openapi = useOpenapi({
       spec,
       base: "/docs/api-reference/api/operations/",
       label: "API",
     });
 
-    theme.enhanceApp({ app, openapi })
+    theme.enhanceApp({ app, openapi });
     app.component("Card", Card);
     app.component("CardGroup", CardGroup);
     app.component("LandingSection", Sections);
@@ -60,21 +65,25 @@ export default {
     app.component("Browser", Browser);
 
     router.onAfterRouteChange = () => {
-      if (typeof window !== 'undefined' && (window as any).plausible) {
-        (window as any).plausible('pageview')
+      if (typeof window !== "undefined" && (window as any).plausible) {
+        (window as any).plausible("pageview");
       }
-    }
-    app.directive('plausible', {
+    };
+    app.directive("plausible", {
       mounted(el: HTMLElement, binding: DirectiveBinding) {
-        const eventName = binding.arg
-        const eventData = binding.value || {}
+        const eventName = binding.arg;
+        const eventData = binding.value || {};
 
-        el.addEventListener('click', () => {
-          if (typeof window !== 'undefined' && (window as any).plausible && eventName) {
-            (window as any).plausible(eventName, { props: eventData })
+        el.addEventListener("click", () => {
+          if (
+            typeof window !== "undefined" &&
+            (window as any).plausible &&
+            eventName
+          ) {
+            (window as any).plausible(eventName, { props: eventData });
           }
-        })
-      }
-    })
+        });
+      },
+    });
   },
 } satisfies Theme;

docs/.vitepress/theme/index.ts

@@ -32,20 +32,29 @@ The token will only be able to access resources that are owned by the team that
 
 ## Permissions
 
+::: warning HEADS UP!
+Some API data won't get returned if the API token doesn't have correct permissions
+:::
+
 Currently there are three types of permissions:
 
 - read-only `(default)`
+- read:sensitive
 - view:sensitive
 - `*` (all permissions)
 
 ### `read-only`
 
 With this permission, you can only read data from the API, but you can't create, update, or delete any resources. Also you can't see sensitive data.
 
+### `read:sensitive`
+
+With this permission, you can only read data from the API and see sensitive information that is normally redacted. You cannot create, update, or delete any resources.
+
 ### `view:sensitive`
 
 Without this permission, passwords, api keys, and other sensitive data will be redacted from the API response.
 
 ### `*`
 
-Full access to all resources and sensitive data.
+Full access to all resources and sensitive data.

docs/api-reference/authorization.md

@@ -2,17 +2,82 @@
 title: ClickHouse
 ---
 
-# ClickHouse
 
- ![clickhouse](/images/database-logos/clickhouse.webp)
+# Clickhouse
+
+ <ZoomableImage src="/docs/images/database-logos/clickhouse.webp" />
+
 
 ## What is ClickHouse
+ClickHouse is an open-source column-oriented database management system designed for online analytical processing (OLAP). 
+
+It's known for its exceptional query performance on large datasets, making it ideal for real-time analytics and data warehousing applications.
+
+ClickHouse uses a column-oriented storage format and employs various optimizations like vectorized query execution to achieve high performance. 
+
+It supports SQL with extensions and can handle both batch and stream data ingestion, making it versatile for various analytical workloads.
+
+
+## Backup and Restore Guide
+Currently, Coolify does not support modifying ClickHouse configurations, which means certain native backup options (e.g., backing up to a local Disk or using `ALTER TABLE ... FREEZE PARTITION ...`) are not possible. Instead, the recommended approach is to use S3 for backups.
+
+
+### How to Backup ClickHouse
+To backup a table or an entire database, use the following SQL command:
+
+- **Backup a Table:**
+```sql
+BACKUP TABLE <table_name> TO S3('<your_s3_endpoint_com>/<unique_folder_for_table_backup>', '<s3_access_key>', '<s3_secret_key>')
+```
+
+- **Backup a Database:**
+Replace `TABLE` with `DATABASE` to backup the whole database:
+
+```sql
+BACKUP DATABASE <database_name> TO S3('<your_s3_endpoint_com>/<unique_folder_for_database_backup>', '<s3_access_key>', '<s3_secret_key>')
+```
+
+
+### How to Restore ClickHouse
+To restore a table or database from an S3 backup, use the corresponding RESTORE command:
+
+- **Restore a Table:**
+```sql
+RESTORE TABLE <table_name> FROM S3('<your_s3_endpoint_com>/<unique_folder_from_table_backup>', '<s3_access_key>', '<s3_secret_key>')
+```
+
+- **Restore a Database:**
+Replace `TABLE` with `DATABASE` to restore the whole database:
+
+```sql
+RESTORE DATABASE <database_name> FROM S3('<your_s3_endpoint_com>/<unique_folder_from_database_backup>', '<s3_access_key>', '<s3_secret_key>')
+```
+
+
+### What Doesn't Work
+- **Disk Backups:**
+
+```sql
+BACKUP TABLE test.table TO Disk('backups', '1.zip')
+```
+Does not work due to Coolify not allowing modifications to ClickHouse configurations.
+
+- **Native Partition Freezes:** 
+
+```sql
+ALTER TABLE ... FREEZE PARTITION ...
+```
+May not work because of limitations in the Docker/Coolify file structure.
+
+- **clickhouse-backup Tool:**
+External tools like [clickhouse-backup](https://github.com/Altinity/clickhouse-backup?utm_source=coolify.io) might not function properly within the Docker/Coolify setup due to similar configuration restrictions.
+
 
-ClickHouse is an open-source column-oriented database management system designed for online analytical processing (OLAP). It's known for its exceptional query performance on large datasets, making it ideal for real-time analytics and data warehousing applications.
+### Performance Notes
+A community member shared that backing up a 145GB database took around 12 minutes, while restoring it took roughly 17 minutes.
 
-ClickHouse uses a column-oriented storage format and employs various optimizations like vectorized query execution to achieve high performance. It supports SQL with extensions and can handle both batch and stream data ingestion, making it versatile for various analytical workloads.
 
 ## Links
 
-- [The official website ›](https://clickhouse.com/)
-- [GitHub ›](https://github.com/ClickHouse/ClickHouse)
+- [The official website ›](https://clickhouse.com/?utm_source=coolify.io)
+- [GitHub ›](https://github.com/ClickHouse/ClickHouse?utm_source=coolify.io)

docs/databases/clickhouse.md

@@ -12,7 +12,20 @@ DragonFly is a modern in-memory datastore, designed as a Redis alternative with
 
 With its multi-threaded architecture and advanced data structures, DragonFly aims to provide enhanced scalability and performance for applications that require Redis-like functionality on modern hardware.
 
+## Data Persistence
+By default, Dragonfly DB does not save data to disk. To enable persistence, set up snapshots manually. 
+
+For example, configure the service with:
+
+ ```yaml
+services:
+  dragonfly:
+    command: 'dragonfly --requirepass XXXXXXXX --dir /data --dbfilename dragonfly-snapshot-{timestamp} --snapshot_cron "*/5 * * * *"'
+ ```
+
+You can also trigger manual saves using the SDK's `SAVE` command.
+
 ## Links
 
-- [The official website ›](https://dragonflydb.io/)
-- [GitHub ›](https://github.com/dragonflydb/dragonfly)
+- [The official website ›](https://dragonflydb.io/?utm_source=coolify.io)
+- [GitHub ›](https://github.com/dragonflydb/dragonfly?utm_source=coolify.io)