summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorKasra Bigdeli <[email protected]>2019-08-14 13:00:46 -0400
committerKasra Bigdeli <[email protected]>2019-08-14 13:00:46 -0400
commit340f984c8fe884c896bb3f1dd8c607843e8cdabc (patch)
tree6de0137e203a796c3f4c52cce9bc460edc6a5da5
parentd5223e80f564cc21ca90f67008fa12f76e1f069e (diff)
parent186210796ad835c901a2c5d9ab3562fc36259b38 (diff)
downloadcaprover-one-click-apps-340f984c8fe884c896bb3f1dd8c607843e8cdabc.tar.gz
caprover-one-click-apps-340f984c8fe884c896bb3f1dd8c607843e8cdabc.zip
Merge branch 'master' of github.com:caprover/one-click-apps
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 5d42cd4..3bf23b8 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,13 @@
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
-- 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.