summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorKasra Bigdeli <[email protected]>2018-12-25 22:17:44 -0800
committerKasra Bigdeli <[email protected]>2018-12-25 22:17:44 -0800
commit33d7e683bfe03425af1c72c64c230530fd050faf (patch)
tree675d1a25a1cb58c3204a43d438555a33b1c4b4fa /README.md
parent1140663b3c59cb6e7c1e220284e82afe4661e145 (diff)
downloadcaprover-one-click-apps-33d7e683bfe03425af1c72c64c230530fd050faf.tar.gz
caprover-one-click-apps-33d7e683bfe03425af1c72c64c230530fd050faf.zip
added start and end instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md80
1 files changed, 1 insertions, 79 deletions
diff --git a/README.md b/README.md
index 1937104..aba9dd2 100644
--- a/README.md
+++ b/README.md
@@ -3,87 +3,9 @@
Process:
- Find/create a docker-compose file for the one click app
- Convert yaml file to json
-- Copy the content into the structure as below
+- Copy the content into the structure as `/one-click-apps/v1/wordpress.json`
- Variables are prefixed with `$$cap`
- There is one special variable called `$$cap_appname$$` which exists for all oneclick apps
- Varibles can be anywhere in the JSON and they will be replaced by what user enters
- Each variable must have `id`, `type`, `label`. It may also have `defaultValue`, `validRegex`, `description`.
- Other than `image`, `environment`, `ports`, `volumes`, `depends_on`, other parameters are ignored. Make sure they are not important.
-
-```
-{
- "captainVersion": "1",
- "documentation": "Taken from https://docs.docker.com/compose/wordpress/ port mapping removed from WP as it's not needed",
- "dockerCompose":
- {
- "version": "3.3",
- "services":
- {
- "db":
- {
- "image": "mysql:$$cap_mysql_version",
- "volumes": [
- "db_data:/var/lib/mysql"
- ],
- "restart": "always",
- "environment":
- {
- "MYSQL_ROOT_PASSWORD": "$$cap_db_pass",
- "MYSQL_DATABASE": "wordpress",
- "MYSQL_USER": "$$cap_db_user",
- "MYSQL_PASSWORD": "$$cap_db_pass"
- }
- },
- "wordpress":
- {
- "depends_on": [
- "$$cap_appname$$-db"
- ],
- "image": "wordpress:$$cap_wp_version",
- "restart": "always",
- "environment":
- {
- "WORDPRESS_DB_HOST": "$$cap_appname$$-db:3306",
- "WORDPRESS_DB_USER": "$$cap_db_user",
- "WORDPRESS_DB_PASSWORD": "$$cap_db_pass"
- }
- }
- },
- "volumes":
- {
- "db_data":
- {}
- }
- },
- "variables": [
- {
- "id": "$$cap_db_user",
- "label": "Database user",
- "defaultValue": "wordpressuser",
- "type": "text",
- "testRegex": "/^[a-z0-9\\-]+$/"
- },
- {
- "id": "$$cap_db_pass",
- "label": "Database password",
- "description": "",
- "type": "text",
- "validRegex": ".{22,}"
- },
- {
- "id": "$$cap_wp_version",
- "label": "WordPress Version",
- "defaultValue": "latest",
- "description": "Checkout their docker page for the valid tags",
- "type": "text"
- },
- {
- "id": "$$cap_mysql_version",
- "label": "MySQL Version",
- "defaultValue": "latest",
- "description": "Checkout their docker page for the valid tags",
- "type": "text"
- }]
-
-}
-``` \ No newline at end of file