mirror of
https://github.com/xbgmsharp/postgsail.git
synced 2025-09-17 11:17:46 +00:00
Update README , add cloud development sandbox
This commit is contained in:
26
README.md
26
README.md
@@ -27,7 +27,7 @@ To understand the why and how, you might want to read [Why.md](https://github.co
|
|||||||
## Architecture
|
## Architecture
|
||||||
For more clarity and visibility the complete [Entity-Relationship Diagram (ERD)](https://github.com/xbgmsharp/postgsail/tree/main/ERD/README.md) is export as PNG and SVG file.
|
For more clarity and visibility the complete [Entity-Relationship Diagram (ERD)](https://github.com/xbgmsharp/postgsail/tree/main/ERD/README.md) is export as PNG and SVG file.
|
||||||
|
|
||||||
### Cloud
|
## Cloud
|
||||||
If you prefer not to install or administer your instance of PostgSail, hosted versions of PostgSail are available in the cloud of your choice.
|
If you prefer not to install or administer your instance of PostgSail, hosted versions of PostgSail are available in the cloud of your choice.
|
||||||
|
|
||||||
The cloud advantage.
|
The cloud advantage.
|
||||||
@@ -35,14 +35,26 @@ The cloud advantage.
|
|||||||
Hosted and fully–managed options for PostgSail, designed for all your deployment and business needs. Register and try for free at https://iot.openplotter.cloud/.
|
Hosted and fully–managed options for PostgSail, designed for all your deployment and business needs. Register and try for free at https://iot.openplotter.cloud/.
|
||||||
|
|
||||||
## Using PostgSail
|
## Using PostgSail
|
||||||
|
|
||||||
|
## Cloud developement
|
||||||
|
- https://codesandbox.io/p/sandbox/stoic-bird-5g6gk8
|
||||||
|
|
||||||
### pre-deploy configuration
|
### pre-deploy configuration
|
||||||
|
|
||||||
To get these running, copy `.env.example` and rename to `.env` then set the value accordinly.
|
To get these running, copy `.env.example` and rename to `.env` then set the value accordinly.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# cp .env.example .env
|
||||||
|
```
|
||||||
|
|
||||||
Notice, that `PGRST_JWT_SECRET` must be at least 32 characters long.
|
Notice, that `PGRST_JWT_SECRET` must be at least 32 characters long.
|
||||||
|
|
||||||
`$ head /dev/urandom | tr -dc A-Za-z0-9 | head -c 32 ; echo ''`
|
`$ head /dev/urandom | tr -dc A-Za-z0-9 | head -c 32 ; echo ''`
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# nano .env
|
||||||
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
By default there is no network set and the postgresql data are store in a docker volume.
|
By default there is no network set and the postgresql data are store in a docker volume.
|
||||||
You can update the default settings by editing `docker-compose.yml` to your need.
|
You can update the default settings by editing `docker-compose.yml` to your need.
|
||||||
@@ -51,6 +63,18 @@ Then simply excecute:
|
|||||||
$ docker-compose up
|
$ docker-compose up
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Initialize database
|
||||||
|
Then simply excecute:
|
||||||
|
```bash
|
||||||
|
$ docker-compose up db
|
||||||
|
```
|
||||||
|
|
||||||
|
#### start backend (db, api)
|
||||||
|
Then simply excecute:
|
||||||
|
```bash
|
||||||
|
$ docker-compose up db api
|
||||||
|
```
|
||||||
|
|
||||||
### SQL Configuration
|
### SQL Configuration
|
||||||
|
|
||||||
Check and update your postgsail settings via SQL in the table `app_settings`:
|
Check and update your postgsail settings via SQL in the table `app_settings`:
|
||||||
|
Reference in New Issue
Block a user