Skip to content

Commit abb182f

Browse files
committed
fix: remove libsql backend references from README
1 parent e0fe6d1 commit abb182f

File tree

1 file changed

+1
-14
lines changed

1 file changed

+1
-14
lines changed

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,8 @@ Key variables:
5959
| --- | --- | --- |
6060
| `BARFFINE_BIND_ADDRESS` | `127.0.0.1:8081` | Socket address for the HTTP listener. |
6161
| `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`. |
62+
| `BARFFINE_DATABASE_BACKEND` | `sqlite` | Choose `sqlite` or `postgres`. |
6363
| `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). |
6664
| `BARFFINE_DATABASE_MAX_CONNECTIONS` | `16` | Controls the metadata connection pool size. Increase for higher concurrency. |
6765
| `BARFFINE_DOC_DATA_BACKEND` | `sqlite` / `rocksdb` | Selects where doc updates, snapshots, notifications, and other large KV payloads live. |
6866
| `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:
8078
| `RUST_LOG` | `info` | Standard Rust log filter. |
8179
| `BARFFINE_TRACE_*` | unset | Control sampling behaviour for custom tracing (see `server/src/observability.rs`). |
8280

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-
9281
### Example `.env`
9382

9483
```dotenv
@@ -119,15 +108,13 @@ By default (when `BARFFINE_NOTIFICATION_CENTER_BACKEND` is unset or set to `auto
119108
- Otherwise, Barffine picks a backend that matches the metadata database:
120109
- `DatabaseBackend::Sqlite``SqliteNotificationCenter`
121110
- `DatabaseBackend::Postgres``PostgresNotificationCenter`
122-
- `DatabaseBackend::Libsql``LibsqlNotificationCenter`
123111

124112
You can override this selection with `BARFFINE_NOTIFICATION_CENTER_BACKEND`:
125113

126114
- `auto` (or unset): use the default detection described above.
127115
- `rocksdb` / `rocks`: force `RocksNotificationCenter`. Requires `BARFFINE_DOC_DATA_BACKEND=rocksdb`, otherwise the server will fail to start.
128116
- `sqlite`: force `SqliteNotificationCenter`. Requires `BARFFINE_DATABASE_BACKEND=sqlite`.
129117
- `postgres` / `postgresql` / `pg`: force `PostgresNotificationCenter`. Requires `BARFFINE_DATABASE_BACKEND=postgres`.
130-
- `libsql`: force `LibsqlNotificationCenter`. Requires `BARFFINE_DATABASE_BACKEND=libsql` (local or remote).
131118

132119
Unsupported values are ignored with a warning and Barffine falls back to the default backend. For most deployments, leaving this setting unset is recommended.
133120

0 commit comments

Comments
 (0)