Add docs

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
+```