one-click-apps

One Click Apps

Go to file

Simon Belbeoch 809a5d4897 proposition of updating readme (#177 ) * proposition of updating readme adding bold for clicable sections rename enviromental into environment add the icon to the process fix link name of the app who does not match with the current README * take into account dev review + important Note		2020-05-24 10:59:45 -04:00
.github	Merge branch 'master' of github.com:caprover/one-click-apps	2019-12-24 18:32:48 -05:00
public	Feature add limesurvey (#175 )	2020-05-24 10:58:19 -04:00
.gitignore	Mattermost One-Click-App (#137 )	2020-03-20 18:52:58 -04:00
LICENSE	Create LICENSE (#40 )	2019-03-17 09:10:19 -07:00
README.md	proposition of updating readme (#177 )	2020-05-24 10:59:45 -04:00
build_dir	Updated publish script	2019-12-24 17:31:34 -05:00
build_one_click_apps.js	updated	2019-12-24 18:27:42 -05:00
package-lock.json	Updated npm	2019-08-12 10:55:20 -04:00
package.json	updated	2019-12-24 18:32:10 -05:00
publish-from-actions.sh	Script is updated for actual deployment	2019-12-24 17:50:32 -05:00
validate_json.js	updated	2019-12-24 18:34:34 -05:00

Repo for CapRover One Click Apps

Process:

Find/create a docker-compose file for the one click app
Convert yaml file to json
Copy the content into the one-click app structure. See this for the reference: wordpress.json
Variables are prefixed with $$cap
Variables can be anywhere in the JSON and they will be replaced by what user enters
There are 2 special variables called $$cap_appname and $$cap_root_domain which exist for all oneclick apps. If your app needs environment variables with the URL value of the app, you can use $$cap_appname.$$cap_root_domain which resolves to something like myappname.rootdomain.com
Each custom variable must have id, label. They may also have defaultValue, validRegex, description. (NB: fields are not required. If validRegex is not set, the field can be set as empty and ignored by the user.)
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 for example.
Add the icon as a png file to the logos directory.

After creating your One-Click app json, like this, you need to test it before creating a Pull Request. Here is how you test it: