Skip to content

Commit 3d3bc2c

Browse files
davidfrigoletdieppabercianor
authored
CLI doc and remove Hsqldb
Co-authored-by: Antonio Perez Dieppa <[email protected]> Co-authored-by: Rubén Berciano <[email protected]>
1 parent 6ae0365 commit 3d3bc2c

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

docs/audit-stores/community/sql-audit-store.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ The following databases are supported:
2727
| PostgreSQL || 12+ recommended |
2828
| SQLite || Suitable for testing and local development |
2929
| H2 || Ideal for testing environments |
30-
| HSQLDB || Testing and embedded scenarios |
3130
| SQL Server || 2017+ recommended |
3231
| Oracle || 19c+ recommended |
3332
| Sybase || ASE 16+ recommended |

docs/cli/cli.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: Flamingock CLI
33
sidebar_position: 999
44
---
55

6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
8+
69
# Flamingock CLI
710

811
Command-line tool for audit management and maintenance operations.
@@ -35,8 +38,10 @@ chmod +x flamingock
3538

3639
### Configuration
3740

38-
Create a `flamingock.yaml` configuration file in your working directory:
41+
Modify the `flamingock-cli.yml` configuration file in flamingock-cli/bin directory according to your audit store setup:
3942

43+
<Tabs groupId="cli_config">
44+
<TabItem value="mongodb" label="MongoDB" default>
4045
#### MongoDB configuration
4146
```yaml
4247
serviceIdentifier: my-service # Optional, defaults to "flamingock-cli"
@@ -50,10 +55,11 @@ audit:
5055
# username: admin
5156
# password: secret
5257
```
53-
58+
</TabItem>
59+
<TabItem value="dynamodb" label="Amazon DynamoDB">
5460
#### DynamoDB configuration
5561
```yaml
56-
serviceIdentifier: my-service
62+
serviceIdentifier: my-service # Optional, defaults to "flamingock-cli"
5763
audit:
5864
dynamodb:
5965
region: us-east-1
@@ -62,6 +68,20 @@ audit:
6268
# accessKey: local
6369
# secretKey: local
6470
```
71+
</TabItem>
72+
<TabItem value="couchbase" label="Couchabse">
73+
#### Couchbase configuration
74+
```yaml
75+
serviceIdentifier: my-service # Optional, defaults to "flamingock-cli"
76+
audit:
77+
couchbase:
78+
endpoint: "couchbase://localhost:12110"
79+
username: "your-username"
80+
password: "your-password"
81+
bucket-name: "my-app"
82+
```
83+
</TabItem>
84+
</Tabs>
6585
6686
You can specify a custom configuration file using the `-c` or `--config` option:
6787
```bash
@@ -145,7 +165,7 @@ For detailed workflows on issue resolution, see [Issue resolution](../safety-and
145165
flamingock [global-options] <command> [command-options]
146166
```
147167

148-
- `-c, --config <file>` - Configuration file path (default: `flamingock`)
168+
- `-c, --config <file>` - Configuration file path (default: `bin/flamingock-cli.yml`)
149169
- `--verbose` - Enable verbose logging
150170
- `--debug` - Enable debug logging
151171
- `--trace` - Enable trace logging (most detailed level)

0 commit comments

Comments
 (0)