summaryrefslogtreecommitdiffhomepage
path: root/public/v4/apps/postgres.yml
diff options
context:
space:
mode:
authorRonald Loyko <[email protected]>2022-10-19 07:03:01 +0300
committerGitHub <[email protected]>2022-10-18 21:03:01 -0700
commitdcb5744e5822ef095ad99c6374bef87ea547711e (patch)
tree552d81b2063ec6e47a65b8861bb6ed4b3edba844 /public/v4/apps/postgres.yml
parent3a562d6e5a3df5426c17896049e8973ded558fee (diff)
downloadcaprover-one-click-apps-dcb5744e5822ef095ad99c6374bef87ea547711e.tar.gz
caprover-one-click-apps-dcb5744e5822ef095ad99c6374bef87ea547711e.zip
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
Diffstat (limited to 'public/v4/apps/postgres.yml')
-rw-r--r--public/v4/apps/postgres.yml36
1 files changed, 18 insertions, 18 deletions
diff --git a/public/v4/apps/postgres.yml b/public/v4/apps/postgres.yml
index cac61da..3b18f2d 100644
--- a/public/v4/apps/postgres.yml
+++ b/public/v4/apps/postgres.yml
@@ -15,37 +15,37 @@ services:
caproverOneClickApp:
variables:
- id: $$cap_postgres_version
- label: Postgres Version
+ label: Version
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^\/])+$/
- id: $$cap_pg_user
- label: Postgres Username
+ label: Username
defaultValue: postgres
- description: ''
validRegex: /.{1,}/
- id: $$cap_pg_pass
- label: Postgres Password
- description: ''
+ label: Password
+ defaultValue: $$cap_gen_random_hex(16)
validRegex: /.{1,}/
- id: $$cap_pg_db
- label: Postgres Default Database
+ label: Default Database
defaultValue: postgres
- description: ''
validRegex: /.{1,}/
- id: $$cap_pg_initdb_args
- label: "OPTIONAL: Arguments for 'postgres initdb'"
- description: For example, --data-checksums
+ label: Optional Arguments
+ description: >-
+ Arguments will be appended to `postgres initdb`.
+ Example: `--data-checksums`.
validRegex: /.{0,}/
instructions:
- 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.
-
- After installation on CapRover, it will be available as srv-captain--YOUR_CONTAINER_NAME at port 5432 to other CapRover apps.
-
- Enter your Postgres Configuration parameters and click on next. It will take about a minute for the process to finish.
- 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})'"
+ 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.
+ end: |-
+ Postgres is deployed and available as `srv-captain--$$cap_appname:5432` to other apps.
+ 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
isOfficial: true
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