Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arjunlol committed May 1, 2024
1 parent e48ba55 commit fd0dfbf
Show file tree
Hide file tree
Showing 13 changed files with 70 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/docs/alternatives.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: 'PostgreSQL Data Change Tracking Alternatives'
description: 'Comparison of all options for data change tracking in Postgres.'
image: 'img/data-tracking.png'
keywords: ['Postgres data change tracking', 'pgaudit', 'Postgres triggers', 'Change Data Capture', 'app data tracking']
---

# Alternatives

## PostgreSQL data change tracking
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: 'Bemi Changelog: Automatic Audit Trail for PostgreSQL'
description: 'Recently released features and improvements for Bemi. Database change tracking for troubleshooting, reporting, data recovery, and audit purposes.'
image: 'img/social-card.png'
keywords: ['Bemi Changelog', 'Bemi New Features', 'Postgres Audit Trails', 'Change Data Capture', 'Database Changes']
---

# Changelog

## 2024-04
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Bemi FAQ - Automatic Audit Trails for Postgres
description: Get answers to common questions about Bemi, including how it uses Change Data Capture (CDC) to track database changes, the security of stored data, and how Bemi compares to other ORM and logging solutions. Learn about Bemi's approach to data integrity and ease of integration.
image: 'img/social-card.png'
keywords: [Bemi, database tracking, Change Data Capture, secure data storage, data integrity, real-time data tracking, Bemi FAQ, database audit trails, Bemi data security]
---

# FAQ

### What does Bemi do when connecting to a database?
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/orms/prisma.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Bemi Prisma Integration - Automate Context-Aware Audit Trails with PostgreSQL
description: Discover how Bemi integrates with Prisma and PostgreSQL to automatically track database changes, providing robust audit trails for your applications. Learn how to install and use the Bemi Prisma package for enhanced data tracking.
image: 'img/bemi-prisma.png'
keywords: [Bemi, Prisma, PostgreSQL, database auditing, data tracking, context-aware audit, application context, database actions, database prisma activity]
---

# Prisma

<a class="github-button" href="https://github.com/BemiHQ/bemi-prisma" data-size="large" data-show-count="true" aria-label="Star BemiHQ/bemi-prisma on GitHub">BemiHQ/bemi-prisma</a>
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/orms/rails.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Bemi vs. PaperTrail, Audited, Logidze - Advanced Rails Audit Trails
description: Discover why Bemi is the preferred choice over PaperTrail, Audited, and Logidze for tracking database changes in Ruby on Rails. Learn how Bemi integrates with ActiveRecord and PostgreSQL to offer reliable, scalable audit trails with minimal performance impact.
image: 'img/rails-gems-comparison.png'
keywords: [Bemi, PaperTrail, Audited, Logidze, Rails audit trails, ActiveRecord tracking, database change logging, Rails data auditing, Rails model changes tracking]
---

# Ruby on Rails

<a class="github-button" href="https://github.com/BemiHQ/bemi-rails" data-size="large" data-show-count="true" aria-label="Star BemiHQ/bemi-rails on GitHub">BemiHQ/bemi-rails</a>
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/orms/typeorm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Bemi TypeORM Integration - Automatic Database Change Tracking for PostgreSQL
description: Discover how Bemi integrates with TypeORM and PostgreSQL to automatically track database changes. This guide covers the installation and use of Bemi with TypeORM to enable context-aware audit trails in your application.
image: 'img/social-card.png'
keywords: [Bemi, TypeORM integration, PostgreSQL change tracking, database auditing, application context, audit trails, TypeORM PostgreSQL, database change monitoring]
---

# TypeORM

<a class="github-button" href="https://github.com/BemiHQ/bemi-typeorm" data-size="large" data-show-count="true" aria-label="Star BemiHQ/bemi-typeorm on GitHub">BemiHQ/bemi-typeorm</a>
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/postgresql/destination-database.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Bemi Destination Database Overview - Autoscaled and optimized Cloud PostgreSQL Audit Trails
description: Explore the features of Bemi's cloud-hosted PostgreSQL destination database, including autoscaling, failover, backups, and query capabilities. Bemi simplifies data retention, version upgrades, and offers enhanced performance and security.
image: 'img/social-card.png'
keywords: [Bemi, destination database, PostgreSQL, autoscaling, high availability, query changes, cloud data audit trails]
---

# Destination Database

Bemi automatically provisions a cloud-hosted PostgreSQL destination database to store all changes made in a source database.
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/postgresql/source-database.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Bemi Source Database Configuration Guide - Real-Time Data Tracking with CDC
description: Learn how to configure your PostgreSQL source database with Bemi for real-time data tracking using Change Data Capture (CDC). Includes detailed setup instructions for WAL levels, connections, and hosting platforms like AWS, GCP, Supabase, and Render.
keywords: [PostgreSQL, Change Data Capture, Bemi, real-time data tracking, database replication, WAL, logical replication]
image: 'img/social-card.png'
---

# Source Database

Bemi tracks changes made in a primary PostgreSQL database (source database) by implementing a design pattern called Change Data Capture (CDC),
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/self-hosting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: 'Bemi: Open Source Automatic Audit Trail for PostgreSQL'
description: 'Self-host a 100% reliable database change tracking solution for troubleshooting, reporting, data recovery, and audit purposes.'
image: 'img/social-card.png'
keywords: ['Open source', 'Database Tracking', 'Postgres Audit Trails', 'Change Data Capture', 'Database Changes']
---

# Self-Hosting

<a class="github-button" href="https://github.com/BemiHQ/bemi" data-size="large" data-show-count="true" aria-label="Star BemiHQ/bemi on GitHub">BemiHQ/bemi</a>
Expand Down
8 changes: 7 additions & 1 deletion docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,14 @@ const config: Config = {
} satisfies Preset.Options,
],
],

themeConfig: {
metadata: [
{name: 'title', content: 'Bemi - Automatic Audit Trail as a Service for PostgreSQL'},
{name: 'description', content: 'Bemi: Your automatic, reliable audit trail for PostgreSQL. Securely connect to your databases, enrich data changes, and maintain an immutable record of data modifications with military-grade encryption. Perfect for troubleshooting, reporting, data recovery, and audit purposes'},
{name: 'keywords', content: 'Bemi, PostgreSQL audit trail, database tracking, data compliance, PostgreSQL data changes, automated audit, change data capture, data observability, pgaudit'},
{name: 'image', content: 'img/social-card.png'},
],
image: "img/social-card.png",
navbar: {
title: "Bemi",
Expand Down
Binary file added docs/static/img/bemi-prisma.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/data-tracking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/rails-gems-comparison.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fd0dfbf

Please sign in to comment.