You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-14Lines changed: 1 addition & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,10 +59,8 @@ Key variables:
59
59
| --- | --- | --- |
60
60
|`BARFFINE_BIND_ADDRESS`|`127.0.0.1:8081`| Socket address for the HTTP listener. |
61
61
|`BARFFINE_DATABASE_PATH`|`./data`| Directory that stores the SQLite metadata database (Barffine creates `barffine.db` inside) and co-locates RocksDB column families. Keep this pointing at a directory; file paths are best-effort supported for backward compatibility. |
62
-
|`BARFFINE_DATABASE_BACKEND`|`sqlite`| Choose `sqlite`, `postgres`, or `libsql`. |
|`BARFFINE_DATABASE_URL`|`postgres://user:pass@localhost:5432/barffine`| Required when `BARFFINE_DATABASE_BACKEND=postgres`; ignored otherwise. |
64
-
|`BARFFINE_LIBSQL_URL`| unset | When `BARFFINE_DATABASE_BACKEND=libsql`, set this to a remote libsql endpoint (e.g. a Turso database or self-hosted `sqld`) to use remote storage instead of an embedded file. Leave unset to use a local libsql database at `BARFFINE_DATABASE_PATH`. |
65
-
|`BARFFINE_LIBSQL_AUTH_TOKEN`| unset | Optional auth token used when connecting to `BARFFINE_LIBSQL_URL` (for Turso or protected `sqld` instances). |
66
64
|`BARFFINE_DATABASE_MAX_CONNECTIONS`|`16`| Controls the metadata connection pool size. Increase for higher concurrency. |
67
65
|`BARFFINE_DOC_DATA_BACKEND`|`sqlite` / `rocksdb`| Selects where doc updates, snapshots, notifications, and other large KV payloads live. |
68
66
|`BARFFINE_DOC_DATA_PATH`|`./data/doc-kv`| Directory for RocksDB column families (used when `BARFFINE_DOC_DATA_BACKEND=rocksdb`). |
@@ -80,15 +78,6 @@ Key variables:
80
78
|`RUST_LOG`|`info`| Standard Rust log filter. |
81
79
|`BARFFINE_TRACE_*`| unset | Control sampling behaviour for custom tracing (see `server/src/observability.rs`). |
82
80
83
-
### Libsql remote / sqld
84
-
85
-
When `BARFFINE_DATABASE_BACKEND=libsql`:
86
-
87
-
- If `BARFFINE_LIBSQL_URL` is **unset**, Barffine uses an embedded libsql database file under `BARFFINE_DATABASE_PATH` (default: `./data/barffine.db`), similar to the default SQLite mode but backed by libsql.
88
-
- If `BARFFINE_LIBSQL_URL` is **set**, Barffine connects to that remote libsql endpoint (for example a Turso database or a self-hosted `sqld` instance such as `libsql://127.0.0.1:8080` or `https://<db>-<org>.turso.io`) and automatically runs the bundled SQLite migrations against it on startup.
89
-
90
-
In remote mode, the metadata schema is kept in sync with the SQLite/Postgres backends, and you can still choose where to store high-volume doc data via `BARFFINE_DOC_DATA_BACKEND` (`sqlite` or `rocksdb`).
91
-
92
81
### Example `.env`
93
82
94
83
```dotenv
@@ -119,15 +108,13 @@ By default (when `BARFFINE_NOTIFICATION_CENTER_BACKEND` is unset or set to `auto
119
108
- Otherwise, Barffine picks a backend that matches the metadata database:
You can override this selection with `BARFFINE_NOTIFICATION_CENTER_BACKEND`:
125
113
126
114
-`auto` (or unset): use the default detection described above.
127
115
-`rocksdb` / `rocks`: force `RocksNotificationCenter`. Requires `BARFFINE_DOC_DATA_BACKEND=rocksdb`, otherwise the server will fail to start.
128
116
-`sqlite`: force `SqliteNotificationCenter`. Requires `BARFFINE_DATABASE_BACKEND=sqlite`.
129
117
-`postgres` / `postgresql` / `pg`: force `PostgresNotificationCenter`. Requires `BARFFINE_DATABASE_BACKEND=postgres`.
130
-
-`libsql`: force `LibsqlNotificationCenter`. Requires `BARFFINE_DATABASE_BACKEND=libsql` (local or remote).
131
118
132
119
Unsupported values are ignored with a warning and Barffine falls back to the default backend. For most deployments, leaving this setting unset is recommended.
0 commit comments