Skip to content

Commit

Permalink
Improve Flyway documentation (#830)
Browse files Browse the repository at this point in the history
* Improve widget parameter encryption documentation

* Fix typos

* Fix typo in readme

* Replace injector with inject

* Improve tsconfig

* Fix index

* Fix crash when saving widget edit

* Fix some typing issue

* Fix last typing issue

* Fix color picker overlap with save button on dashboard edit sidebar

* Fix the widget stepper background color

* Improve the documentation regarding database
  • Loading branch information
loicgreffier authored Jan 5, 2024
1 parent 88c0a53 commit 3fbbc16
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 4 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ This repository contains the source code of the Suricate application.
* [Configuration](#configuration)
* [Default Configuration](#default-configuration)
* [Database](#database)
* [H2 vs PostgreSQL](#h2-vs-postgresql)
* [Initialization with Flyway](#initialization-with-flyway)
* [Authentication](#authentication)
* [LDAP vs Database](#ldap-vs-database)
* [Social Login](#social-login)
Expand Down Expand Up @@ -87,7 +89,9 @@ By default, Suricate:

### Database

Suricate supports running on different DBMS. Currently, the following DBMS are supported:
#### H2 vs PostgreSQL

Suricate supports running on different database management systems (DBMS):

- H2
- PostgreSQL
Expand All @@ -99,9 +103,9 @@ parameter:
spring.profiles.active: ### Provider should be 'h2' or 'postgresql'
```
The matching `application-DBMS.properties` file will be picked up.
It will activate the default `application-DBMS.properties` configuration file with the required properties for the chosen DBMS.

In the matching `application-DBMS.properties`, fill in the datasource properties:
You will still need to define your database connection properties in the `application.properties` file:

```yaml
spring.datasource.url:
Expand All @@ -112,6 +116,27 @@ spring.datasource.password:
Please note that the `application-DBMS.properties` files activate Flyway to automatically set up the database
structure (tables, constraints, etc.) and the minimum required functional data.

#### Initialization with Flyway

Suricate uses [Flyway](https://docs.spring.io/spring-boot/docs/2.0.0.M5/reference/html/howto-database-initialization.html) to manage the database initialization.
It is enabled by default to automatically set up the database structure (tables, constraints, etc.) and the minimum
required functional data at the first start of the application.

Depending on the database management system you use, Flyway will use the appropriate scripts located in the
`src/main/resources/flyway` folder.

Flyway stores the current version of the database in a table named `schema_version` defined by the following property:

```yaml
spring.flyway.table: schema_version
```

Flyway can be deactivated by setting the following property to `false`:

```yaml
spring.flyway.enabled: false
```

### Authentication

Suricate provides multiple types of authentication that can be activated or deactivated based on your requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
*/

.color-picker {
position: initial;
border: none;
background-color: transparent;
padding-bottom: 20px;
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/sass/components/_mat-stepper-theme.scss
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
.mat-stepper-horizontal,
.mat-stepper-vertical {
min-height: 90%;
background-color: mat.get-color-from-palette($background, background);
--mat-stepper-container-color: mat.get-color-from-palette($background, background);

.mat-step-header {
.mat-step-icon {
Expand Down

0 comments on commit 3fbbc16

Please sign in to comment.