mertd / one-click-apps

Repo for CapRover One Click Apps (https://github.com/caprover/caprover)

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 an enviromental variable that needs to point to the URL 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.
• 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.

Test your One Click Apps

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:

• Login to your CapRover dashboard
• Go to apps and click on Create One Click App
• Select the last option from the dropdown list "TEMPLATE"
• Copy and paste your JSON there, and click NEXT.
• Enter values and make sure it's working as expected.