feat(postgres): optimize documentation and add default password (#771)

* docs(postgres): removed postgres from labels

* feat(postgres): add generated default password

* docs(postgres): optimize descriptions

* docs(postgres): optimize instructions

* docs(postgres): remove 'taken from' documentation
This commit is contained in:
Ronald Loyko 2022-10-19 07:03:01 +03:00 committed by GitHub
parent 3a562d6e5a
commit dcb5744e58
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 18 deletions

View File

@ -15,37 +15,37 @@ services:
caproverOneClickApp: caproverOneClickApp:
variables: variables:
- id: $$cap_postgres_version - id: $$cap_postgres_version
label: Postgres Version label: Version
defaultValue: '14.5' defaultValue: '14.5'
description: Check out their Docker page for the valid tags https://hub.docker.com/r/library/postgres/tags/ description: Check out their Docker page for the valid tags https://hub.docker.com/r/library/postgres/tags
validRegex: /^([^\s^\/])+$/ validRegex: /^([^\s^\/])+$/
- id: $$cap_pg_user - id: $$cap_pg_user
label: Postgres Username label: Username
defaultValue: postgres defaultValue: postgres
description: ''
validRegex: /.{1,}/ validRegex: /.{1,}/
- id: $$cap_pg_pass - id: $$cap_pg_pass
label: Postgres Password label: Password
description: '' defaultValue: $$cap_gen_random_hex(16)
validRegex: /.{1,}/ validRegex: /.{1,}/
- id: $$cap_pg_db - id: $$cap_pg_db
label: Postgres Default Database label: Default Database
defaultValue: postgres defaultValue: postgres
description: ''
validRegex: /.{1,}/ validRegex: /.{1,}/
- id: $$cap_pg_initdb_args - id: $$cap_pg_initdb_args
label: "OPTIONAL: Arguments for 'postgres initdb'" label: Optional Arguments
description: For example, --data-checksums description: >-
Arguments will be appended to `postgres initdb`.
Example: `--data-checksums`.
validRegex: /.{0,}/ validRegex: /.{0,}/
instructions: instructions:
start: >- start: |-
PostgreSQL, often simply Postgres, is an object-relational database management system (ORDBMS) with an emphasis on extensibility and standards-compliance. As a database server, its primary function is to store data, securely and supporting best practices, and retrieve it later, as requested by other software applications, be it those on the same computer or those running on another computer across a network (including the Internet). It can handle workloads ranging from small single-machine applications to large Internet-facing applications with many concurrent users. PostgreSQL, often simply Postgres, is an object-relational database management system (ORDBMS) with an emphasis on extensibility and standards-compliance.
As a database server, its primary function is to store data, securely and supporting best practices, and retrieve it later, as requested by other software applications, be it those on the same computer or those running on another computer across a network (including the Internet).
After installation on CapRover, it will be available as srv-captain--YOUR_CONTAINER_NAME at port 5432 to other CapRover apps. It can handle workloads ranging from small single-machine applications to large Internet-facing applications with many concurrent users.
end: |-
Enter your Postgres Configuration parameters and click on next. It will take about a minute for the process to finish. Postgres is deployed and available as `srv-captain--$$cap_appname:5432` to other apps.
end: "Postgres is deployed and available as srv-captain--$$cap_appname:5432 to other apps. For example with NodeJS: 'const client = new Client({ user: '$$cap_pg_user', host: 'srv-captain--$$cap_appname', database: '$$cap_pg_db', password: '********', port: 5432})'" For example with Node.js: `const client = new Client({ user: '$$cap_pg_user', host: 'srv-captain--$$cap_appname', database: '$$cap_pg_db', password: '$$cap_pg_pass', port: 5432})`
displayName: PostgreSQL displayName: PostgreSQL
isOfficial: true isOfficial: true
description: The PostgreSQL object-relational database system provides reliability and data integrity description: The PostgreSQL object-relational database system provides reliability and data integrity
documentation: Taken from https://hub.docker.com/_/postgres documentation: https://hub.docker.com/_/postgres