Add Postgres and MySQL databases support

.github/workflows/go.yml

@@ -1,15 +1,15 @@
 name: "Go CI"
 on:
   push:
-    branches:
-      - master
-      - 'dev-*'
+  workflow_dispatch:
+
   pull_request:
     paths-ignore:
       - '**.yml'
 
 jobs:
   lint:
+    name: Lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -31,6 +31,7 @@ jobs:
         run: make fmt check_changes
 
   check:
+    name: Check
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -47,12 +48,58 @@ jobs:
       - name: Check translations
         run: make check-tr
 
+  test-db:
+    name: Test
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest"]
+        go: ["1.22"]
+        database: [postgres, mysql]
+        include:
+          - database: postgres
+            image: postgres:16
+            port: 5432:5432
+          - database: mysql
+            image: mysql:8
+            port: 3306:3306
+
+    runs-on: ${{ matrix.os }}
+    services:
+      database:
+        image: ${{ matrix.image }}
+        ports:
+          - ${{ matrix.port }}
+        env:
+          POSTGRES_PASSWORD: opengist
+          POSTGRES_DB: opengist_test
+          MYSQL_ROOT_PASSWORD: opengist
+          MYSQL_DATABASE: opengist_test
+        options: >-
+          --health-cmd ${{ matrix.database == 'postgres' && 'pg_isready' || '"mysqladmin ping"' }}
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Go ${{ matrix.go }}
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: Run tests
+        run: make test TEST_DB_TYPE=${{ matrix.database }}
+
   test:
+    name: Test
     strategy:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
         go: ["1.22"]
+        database: ["sqlite"]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
@@ -64,5 +111,4 @@ jobs:
           go-version: ${{ matrix.go }}
 
       - name: Run tests
-        run: make test
-
+        run: make test TEST_DB_TYPE=${{ matrix.database }}

Makefile

@@ -4,6 +4,7 @@
 BINARY_NAME := opengist
 GIT_TAG := $(shell git describe --tags)
 VERSION_PKG := github.com/thomiceli/opengist/internal/config.OpengistVersion
+TEST_DB_TYPE ?= sqlite
 
 all: clean install build
 
@@ -72,7 +73,7 @@ fmt:
 	@go fmt ./...
 
 test:
-	@go test ./... -p 1
+	@OPENGIST_TEST_DB=$(TEST_DB_TYPE) go test ./... -p 1
 
 check-tr:
 	@bash ./scripts/check-translations.sh

README.md

@@ -28,7 +28,7 @@ It is similiar to [GitHub Gist](https://gist.github.com/), but open-source and c
 * OAuth2 login with GitHub, GitLab, Gitea, and OpenID Connect
 * Restrict or unrestrict snippets visibility to anonymous users
 * Docker support
-* [More...](/docs/index.md#features)
+* [More...](/docs/introduction.md#features)
 
 ## Quick start
 

config.yml

@@ -14,8 +14,11 @@ external-url:
 # Directory where Opengist will store its data. Default: ~/.opengist/
 opengist-home:
 
-# Name of the SQLite database file. Default: opengist.db
-db-filename: opengist.db
+# URI of the database. Default: opengist.db (SQLite)
+# SQLite:        file name
+# PostgreSQL:    postgres://user:password@host:port/database
+# MySQL/MariaDB: mysql://user:password@host:port/database
+db-uri: opengist.db
 
 # Enable or disable the code search index (either `true` or `false`). Default: true
 index.enabled: true
@@ -29,6 +32,7 @@ git.default-branch:
 
 # Set the journal mode for SQLite. Default: WAL
 # See https://www.sqlite.org/pragma.html#pragma_journal_mode
+# For SQLite databases only.
 sqlite.journal-mode: WAL
 
 

docs/.vitepress/config.mts

@@ -36,11 +36,17 @@ export default defineConfig({
             {
                 text: 'Configuration', base: '/docs/configuration', items: [
                     {text: 'Configure Opengist', link: '/configure'},
-                    {text: 'Admin panel', link: '/admin-panel'},
+                    {text: 'Databases', items: [
+                        {text: 'SQLite', link: '/databases/sqlite'},
+                        {text: 'PostgreSQL', link: '/databases/postgresql'},
+                        {text: 'MySQL', link: '/databases/mysql'},
+                        ], collapsed: true
+                    },
                     {text: 'OAuth Providers', link: '/oauth-providers'},
                     {text: 'Custom assets', link: '/custom-assets'},
                     {text: 'Custom links', link: '/custom-links'},
                     {text: 'Cheat Sheet', link: '/cheat-sheet'},
+                    {text: 'Admin panel', link: '/admin-panel'},
                 ], collapsed: false
             },
             {

docs/configuration/databases/mysql.md

@@ -0,0 +1,49 @@
+# Using MySQL/MariaDB
+
+To use MySQL/MariaDB as the database backend, you need to set the database URI configuration to the connection string of your MySQL/MariaDB database with this format :
+
+`mysql://<user>:<password>@<host>:<port>/<database>`
+
+#### YAML
+```yaml
+# Example
+db-uri: mysql://root:passwd@localhost:3306/opengist_db
+```
+
+#### Environment variable
+```sh
+# Example
+OG_DB_URI=mysql://root:passwd@localhost:3306/opengist_db
+```
+
+### Docker Compose
+```yml
+version: "3"
+
+services:
+  opengist:
+    image: ghcr.io/thomiceli/opengist:1
+    container_name: opengist
+    restart: unless-stopped
+    depends_on:
+      - mysql
+    ports:
+      - "6157:6157"
+      - "2222:2222"
+    volumes:
+      - "$HOME/.opengist:/opengist"
+    environment:
+      OG_DB_URI: mysql://opengist:secret@mysql:3306/opengist_db
+      # other configuration options
+
+  mysql:
+    image: mysql:8.4
+    restart: unless-stopped
+    volumes:
+      - "./opengist-database:/var/lib/mysql"
+    environment:
+      MYSQL_USER: opengist
+      MYSQL_PASSWORD: secret
+      MYSQL_DATABASE: opengist_db
+      MYSQL_ROOT_PASSWORD: rootsecret
+```

docs/configuration/databases/postgresql.md

@@ -0,0 +1,48 @@
+# Using PostgreSQL
+
+To use PostgreSQL as the database backend, you need to set the database URI configuration to the connection string of your PostgreSQL database with this format :
+
+`postgres://<user>:<password>@<host>:<port>/<database>`
+
+#### YAML
+```yaml
+# Example
+db-uri: postgres://postgres:passwd@localhost:5432/opengist_db
+```
+
+#### Environment variable
+```sh
+# Example
+OG_DB_URI=postgres://postgres:passwd@localhost:5432/opengist_db
+```
+
+### Docker Compose
+```yml
+version: "3"
+
+services:
+  opengist:
+    image: ghcr.io/thomiceli/opengist:1
+    container_name: opengist
+    restart: unless-stopped
+    depends_on:
+      - postgres
+    ports:
+      - "6157:6157"
+      - "2222:2222"
+    volumes:
+      - "$HOME/.opengist:/opengist"
+    environment:
+      OG_DB_URI: postgres://opengist:secret@postgres:5432/opengist_db
+      # other configuration options
+
+  postgres:
+    image: postgres:16.4
+    restart: unless-stopped
+    volumes:
+      - "./opengist-database:/var/lib/postgresql/data"
+    environment:
+      POSTGRES_USER: opengist
+      POSTGRES_PASSWORD: secret
+      POSTGRES_DB: opengist_db
+```

docs/configuration/databases/sqlite.md

@@ -0,0 +1,39 @@
+# Using SQLite
+
+By default, Opengist uses SQLite as the database backend.
+
+Because SQLite is a file-based database, there is not much configuration to tweak.
+
+The configuration `db-uri`/`OG_DB_URI` refers to the path of the SQLite database file relative in the `$opengist-home/` directory (default `opengist.db`),
+although it can be left untouched.
+
+The SQLite journal mode is set to [`WAL` (Write-Ahead Logging)](https://www.sqlite.org/pragma.html#pragma_journal_mode) by default and can be changed.
+
+#### YAML
+```yaml
+sqlite.journal-mode: WAL
+```
+
+#### Environment variable
+```sh
+OG_SQLITE_JOURNAL_MODE=WAL
+```
+
+### Docker Compose
+```yml
+version: "3"
+
+services:
+  opengist:
+    image: ghcr.io/thomiceli/opengist:1
+    container_name: opengist
+    restart: unless-stopped
+    ports:
+      - "6157:6157" # HTTP port
+      - "2222:2222" # SSH port, can be removed if you don't use SSH
+    volumes:
+      - "$HOME/.opengist:/opengist"
+    environment:
+      OG_SQLITE_JOURNAL_MODE: WAL
+      # other configuration options
+```

docs/introduction.md

@@ -31,7 +31,7 @@ Written in [Go](https://go.dev), Opengist aims to be fast and easy to deploy.
   * delete users/gists; 
   * clean database/filesystem by syncing gists
   * run `git gc` for all repositories
-* SQLite database
+* SQLite/PostgreSQL/MySQL database
 * Logging
 * Docker support
 

go.mod

@@ -7,7 +7,6 @@ require (
 	github.com/alecthomas/chroma/v2 v2.14.0
 	github.com/blevesearch/bleve/v2 v2.4.0
 	github.com/dustin/go-humanize v1.0.1
-	github.com/glebarez/go-sqlite v1.22.0
 	github.com/glebarez/sqlite v1.11.0
 	github.com/go-playground/validator/v10 v10.21.0
 	github.com/google/uuid v1.6.0
@@ -26,7 +25,9 @@ require (
 	golang.org/x/crypto v0.23.0
 	golang.org/x/text v0.15.0
 	gopkg.in/yaml.v3 v3.0.1
-	gorm.io/gorm v1.25.10
+	gorm.io/driver/mysql v1.5.7
+	gorm.io/driver/postgres v1.5.9
+	gorm.io/gorm v1.25.12
 )
 
 require (
@@ -53,15 +54,21 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dlclark/regexp2 v1.11.0 // indirect
 	github.com/gabriel-vasile/mimetype v1.4.4 // indirect
+	github.com/glebarez/go-sqlite v1.22.0 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
 	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-sql-driver/mysql v1.7.0 // indirect
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/golang/geo v0.0.0-20230421003525-6adc56603217 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/gorilla/mux v1.8.1 // indirect
 	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
 	github.com/hashicorp/golang-lru v1.0.2 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
+	github.com/jackc/pgx/v5 v5.5.5 // indirect
+	github.com/jackc/puddle/v2 v2.2.1 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
@@ -85,6 +92,7 @@ require (
 	go.etcd.io/bbolt v1.3.10 // indirect
 	golang.org/x/net v0.25.0 // indirect
 	golang.org/x/oauth2 v0.20.0 // indirect
+	golang.org/x/sync v0.5.0 // indirect
 	golang.org/x/sys v0.20.0 // indirect
 	golang.org/x/time v0.5.0 // indirect
 	google.golang.org/protobuf v1.34.1 // indirect