Skip to content

Commit

Permalink
Update documentation to reflect support for PostgreSQL and Microsoft …
Browse files Browse the repository at this point in the history
…SQL Server
  • Loading branch information
leodip committed Nov 23, 2024
1 parent 341d668 commit 7fe491d
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Goiabada makes user management easy for app developers. You can set up users, gr
- Self-service account page for users to update their details
- OAuth2 support, including authorization code flow and client credentials flow
- OpenID Connect support
- Compatible with MySQL and SQLite databases (other DBs coming soon)
- Databases supported: MySQL, PostgreSQL, Microsoft SQL Server, SQLite

Documentation: [https://goiabada.dev](https://goiabada.dev).

Expand Down
2 changes: 1 addition & 1 deletion mkdocs/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Flag: `--db-type`

Default: sqlite

Description: Currently `mysql` and `sqlite` are supported.
Description: Currently `mysql`, `postgres`, `mssql`, `sqlite` are supported.

---

Expand Down
2 changes: 2 additions & 0 deletions mkdocs/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Save this [docker compose file](https://github.com/leodip/goiabada/tree/main/src
docker compose -f docker-compose-mysql.yml up -d
```

We also support postgres, mssql and sqlite.

If you want to test it with sqlite you can use this [docker compose file](https://github.com/leodip/goiabada/tree/main/src/build/docker-compose-sqlite.yml) instead.

```
Expand Down
2 changes: 1 addition & 1 deletion mkdocs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Goiabada makes user management easy for app developers. You can set up users, gr
- Self-service account page for users to update their details
- OAuth2 support, including authorization code flow and client credentials flow
- OpenID Connect support
- Compatible with MySQL and SQLite databases (other DBs coming soon)
- Databases supported: MySQL, PostgreSQL, Microsoft SQL Server, SQLite

## Screenshots

Expand Down
3 changes: 2 additions & 1 deletion src/build/docker-compose-mysql.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
version: '3.8'
services:

# you can also use mssql, postgres, or sqlite
mysql-server:
image: mysql:latest
restart: unless-stopped
Expand Down Expand Up @@ -66,7 +67,7 @@ services:
- GOIABADA_AUTHSERVER_TEMPLATEDIR= #leave this empty to use embedded templates

# Database (mysql) details
- GOIABADA_DB_TYPE=mysql
- GOIABADA_DB_TYPE=mysql # you can also use mssql, postgres, or sqlite
- GOIABADA_DB_USERNAME=root
- GOIABADA_DB_PASSWORD=mySqlPass123
- GOIABADA_DB_HOST=mysql-server
Expand Down

0 comments on commit 7fe491d

Please sign in to comment.