From d2fa540c20bcc0640e6be87eceb536c750530b2b Mon Sep 17 00:00:00 2001 From: Kasra Bigdeli Date: Tue, 13 Aug 2019 09:03:14 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d42cd4..8a25573 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Process: - Find/create a docker-compose file for the one click app - Convert yaml file to json -- Copy the content into the one click ap structure. See this for the reference: [wordpress.json](https://github.com/caprover/one-click-apps/blob/master/public/v1/apps/wordpress.json) +- Copy the content into the one-click app structure. See this for the reference: [wordpress.json](https://github.com/caprover/one-click-apps/blob/master/public/v1/apps/wordpress.json) - Variables are prefixed with `$$cap` - There is one special variable called `$$cap_appname` which exists for all oneclick apps - Variables can be anywhere in the JSON and they will be replaced by what user enters From 186210796ad835c901a2c5d9ab3562fc36259b38 Mon Sep 17 00:00:00 2001 From: Kasra Bigdeli Date: Tue, 13 Aug 2019 09:05:14 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8a25573..3bf23b8 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ Process: - Variables are prefixed with `$$cap` - There is one special variable called `$$cap_appname` which exists for all oneclick apps - Variables can be anywhere in the JSON and they will be replaced by what user enters -- Each variable must have `id`, `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. -- Instead of image in a service, you can use `dockerfileLines` which is an array of strings. +- Each variable must have `id`, `label`. They may also have `defaultValue`, `validRegex`, `description`. +- Other than `image`, `environment`, `ports`, `volumes`, `depends_on`, other parameters are currently being ignored by CapRover. Make sure they are not crucial. +- Instead of `image` property in a service, you can use `dockerfileLines` which is an array of strings. - Some webapps, use a non-standard HTTP port. For example, Adminer's Docker image uses port 8080. In this case, add `containerHttpPort` to the service. See [adminer.json](https://github.com/caprover/one-click-apps/blob/master/public/v1/apps/adminer.json) for example.