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
- To request support for another database, please [open an issue](https://github.com/warrant-dev/warrant/issues/new/choose)!
76
77
77
78
## SDKs
@@ -102,7 +103,7 @@ To report a bug you found or request a feature that you'd like, open an issue. I
102
103
103
104
Contributions from the community are welcome! Just be sure to follow some ground rules:
104
105
105
-
- Never submit a PR without an issue.
106
+
- Never submit a PR without an associated issue.
106
107
- Issues should mention whether the issue is a bug or a feature.
107
108
- Issues reporting a bug should describe (1) steps to reproduce the bug, (2) what the current behavior is, and (3) what the expected behavior should be.
108
109
- Issues requesting a feature should (1) provide a description of the feature and (2) explain the intended use case for the feature.
This guide will cover how to run Warrant with SQLite as the datastore/eventstore. Note that running Warrant with SQLite requires that you build Warrant from source.
4
+
5
+
## Running the Binary
6
+
7
+
### Install SQLite
8
+
9
+
Many operating systems (like MacOS) come with SQLite pre-installed. If you already have SQLite installed, you can skip to the next step. If you don't already have SQLite installed, [install it](https://www.tutorialspoint.com/sqlite/sqlite_installation.htm). Once installed, you should be able to run the following command to print the currently installed version of SQLite:
10
+
11
+
```bash
12
+
sqlite3 --version
13
+
```
14
+
15
+
### Install Go
16
+
17
+
[Install Go](https://go.dev/doc/install).
18
+
19
+
### Build Warrant From Source
20
+
21
+
Clone the Warrant repository from GitHub or download and unzip the tarball containing the source code for the [latest Warrant release](https://github.com/warrant-dev/warrant/releases/latest).
22
+
23
+
```bash
24
+
tar -xvf <name_of_tarball>
25
+
```
26
+
27
+
Navigate to the `cmd/warrant` directory and run `make dev` to build Warrant. This will create a file called `warrant` that contains the executable.
28
+
29
+
### Create `warrant.yaml` Configuration
30
+
31
+
Create a file called `warrant.yaml` in the directory containing the Warrant binary. Add properties to configure SQLite as both the datastore and evenstore for Warrant.
32
+
33
+
```yaml
34
+
# warrant.yaml
35
+
port: 8000
36
+
logLevel: 0
37
+
enableAccessLog: true
38
+
apiKey: replace_with_api_key
39
+
datastore:
40
+
sqlite:
41
+
database: warrant
42
+
inMemory: true
43
+
eventstore:
44
+
sqlite:
45
+
database: warrantEvents
46
+
inMemory: true
47
+
```
48
+
49
+
NOTE: By default, SQLite will create a database file for both the database and eventstore. The filenames are configurable using the `database` property under `datastore` and `eventstore`. Specifying the `inMemory` option under `datastore` or `eventstore` will bypass creation of a database file and run the SQLite database completely in memory. When running Warrant with the `inMemory` configuration, **any data in Warrant will be lost once the Warrant process is shutdown/killed**.
0 commit comments