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
+23-5Lines changed: 23 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,8 +38,10 @@ Mozilla Sync Storage built with [Rust](https://rust-lang.org).
38
38
- pkg-config
39
39
-[Rust stable](https://rustup.rs)
40
40
- python 3.9+
41
-
- MySQL 5.7 (or compatible)
42
-
* libmysqlclient (`brew install mysql` on macOS, `apt install libmysqlclient-dev` on Ubuntu, `apt install libmariadb-dev-compat` on Debian)
41
+
- At least one database backend (depending on which one you'll be running)
42
+
* MySQL 5.7 (or compatible)
43
+
* libmysqlclient (`brew install mysql` on macOS, `apt install libmysqlclient-dev` on Ubuntu, `apt install libmariadb-dev-compat` on Debian)
44
+
* SQLite v3.24 or greater
43
45
44
46
Depending on your OS, you may also need to install `libgrpcdev`,
45
47
and `protobuf-compiler-grpc`. *Note*: if the code complies cleanly,
@@ -52,7 +54,8 @@ are missing `libcurl4-openssl-dev`.
52
54
2. Now `cp config/local.example.toml config/local.toml`. Open `config/local.toml` and make sure you have the desired settings configured. For a complete list of available configuration options, check out [docs/config.md](docs/config.md).
53
55
3. To start a local server in debug mode, run either:
54
56
-`make run_mysql` if using MySQL or,
55
-
-`make run_spanner` if using spanner.
57
+
-`make run_spanner` if using spanner or,
58
+
-`make run_sqlite` if using sqlite.
56
59
57
60
The above starts the server in debug mode, using your new `local.toml` file for config options. Or, simply `cargo run` with your own config options provided as env vars.
58
61
4. Visit `http://localhost:8000/__heartbeat__` to make sure the server is running.
@@ -185,9 +188,24 @@ SYNC_SYNCSTORAGE__SPANNER_EMULATOR_HOST=localhost:9010 make run_spanner
185
188
Setting up the server with sqlite only requires a path to the database file,
186
189
which will be created automatically:
187
190
188
-
`sqlite:path/syncdb.sqlite`
191
+
One for the syncserver data
192
+
`sqlite:path/syncdb.sqlite`
193
+
And one for the tokenserver data
194
+
`sqlite:path/tokendb.sqlite`
189
195
190
-
This requires at least sqlite v3.24.0 to be installed on the host system.
196
+
Note that after database initialisation you will still need to run two SQL
197
+
insert on the tokenserver database to announce the presence of your syncserver
0 commit comments