Tidy instructions spelling & spacing (#369)
* tidy up instructions spelling/spacing * remove spaces in empty lines Co-authored-by: Edward <edward@finchit.co.za> Co-authored-by: Kasra Bigdeli <kasra85@gmail.com>
This commit is contained in:
Edward
GitHub
parent
8ed35e268f
commit
91daa6b904
|
|
@ -27,7 +27,7 @@ caproverOneClickApp:
|
|||
- id: $$cap_ackee_version
|
||||
label: Ackee Version
|
||||
defaultValue: '2.3.0'
|
||||
description: Checkout their docker page for the valid tags https://hub.docker.com/r/electerious/ackee/tags
|
||||
description: Check out their docker page for the valid tags https://hub.docker.com/r/electerious/ackee/tags
|
||||
validRegex: /^([^\s^\/])+$/
|
||||
- id: $$cap_ackee_username
|
||||
label: Ackee Admin User
|
||||
|
|
@ -41,7 +41,7 @@ caproverOneClickApp:
|
|||
- id: $$cap_ackee_access_origin
|
||||
label: CORS headers
|
||||
defaultValue: 'https://example.com,https://example2.com'
|
||||
description: 'Ackee requires correct CORS headers. pls read https://docs.ackee.electerious.com/#/docs/CORS%20headers#heroku-or-platforms-as-a-service-configuration'
|
||||
description: 'Ackee requires correct CORS headers. Please read https://docs.ackee.electerious.com/#/docs/CORS%20headers#heroku-or-platforms-as-a-service-configuration'
|
||||
- id: $$cap_mongo_version
|
||||
label: MongoDB Version
|
||||
defaultValue: '4.0.20'
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ caproverOneClickApp:
|
|||
- id: $$cap_adguard_version
|
||||
label: AdGuard Home Version
|
||||
defaultValue: 'v0.104.3'
|
||||
description: Checkout their docker page for the valid tags https://hub.docker.com/r/adguard/adguardhome/tags
|
||||
description: Check out their docker page for the valid tags https://hub.docker.com/r/adguard/adguardhome/tags
|
||||
instructions:
|
||||
start: >-
|
||||
AdGuard Home is a fast and easy way to block ads on any device and protect kids online!
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ caproverOneClickApp:
|
|||
|
||||
PREREQUISITE:
|
||||
|
||||
MongoDB database with initial appsmith installation data
|
||||
MongoDB database with initial appsmith installation data.
|
||||
end: >-
|
||||
Appsmith is deployed and available as $$cap_appname.
|
||||
|
||||
|
|
|
|||
|
|
@ -154,5 +154,5 @@ caproverOneClickApp:
|
|||
|
||||
displayName: Chaskiq
|
||||
isOfficial: true
|
||||
description: A full featured Live Chat, Support & Marketing platform
|
||||
description: A full-featured Live Chat, Support & Marketing platform
|
||||
documentation: 'Read more at: https://dev.chaskiq.io'
|
||||
|
|
|
|||
|
|
@ -80,12 +80,12 @@ caproverOneClickApp:
|
|||
description: Password must be at least 12 characters. Please use a random string.
|
||||
validRegex: /^[^\@]{12,}$/
|
||||
instructions:
|
||||
start: Open-source customer support saas alternative to Intercom, Drift, Crisp.
|
||||
start: Open-source customer support SaaS alternative to Intercom, Drift, Crisp.
|
||||
end: >-
|
||||
Your Chatwoot instance is now successfully deployed.
|
||||
|
||||
Refer https://www.chatwoot.com/docs/environment-variables/ for full list of environment variables available. Let us know if you have any queries through hello@chatwoot.com
|
||||
displayName: Chatwoot
|
||||
isOfficial: true
|
||||
description: Open-source customer support saas alternative to Intercom, Drift, Crisp
|
||||
description: Open-source customer support SaaS alternative to Intercom, Drift, Crisp
|
||||
documentation: 'Read more at: https://www.chatwoot.com/docs'
|
||||
|
|
|
|||
|
|
@ -12,12 +12,12 @@ caproverOneClickApp:
|
|||
description: Checkout their docker page for the valid tags @ https://hub.docker.com/r/agentejo/cockpit/tags
|
||||
defaultValue: 0.9.3
|
||||
instructions:
|
||||
start: Cockpit is Simple Content Platform to manage any structured content. A self-hosted headless and api-driven CMS.
|
||||
start: Cockpit is Simple Content Platform to manage any structured content. A self-hosted headless and API-driven CMS.
|
||||
end: >-
|
||||
Cockpit is deployed and available as $$cap_appname.
|
||||
|
||||
IMPORTANT: Navigate to /install to finish the installation and to create an admin user!
|
||||
displayName: Cockpit
|
||||
isOfficial: true
|
||||
description: Cockpit is Simple Content Platform to manage any structured content. A self-hosted headless and api-driven CMS.
|
||||
description: Cockpit is Simple Content Platform to manage any structured content. A self-hosted headless and API-driven CMS.
|
||||
documentation: Read the documentation @ https://github.com/agentejo/cockpit-docker
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ caproverOneClickApp:
|
|||
id: $$cap_timezone
|
||||
instructions:
|
||||
start: |-
|
||||
Realtime collaborative markdown notes on all platforms.
|
||||
Realtime collaborative Markdown notes on all platforms.
|
||||
|
||||
GitHub: https://github.com/hackmdio/codimd
|
||||
end: |-
|
||||
|
|
@ -51,5 +51,5 @@ caproverOneClickApp:
|
|||
Your service is available as $$cap_appname
|
||||
displayName: CodiMD
|
||||
isOfficial: true
|
||||
description: Realtime collaborative markdown notes on all platforms
|
||||
description: Realtime collaborative Markdown notes on all platforms
|
||||
documentation: https://hackmd.io/c/codimd-documentation
|
||||
|
|
|
|||
|
|
@ -48,18 +48,15 @@ caproverOneClickApp:
|
|||
|
||||
IMPORTANT: You need do 5 manual steps before access.
|
||||
|
||||
1 - enable websocket on HTTP settings tab
|
||||
1 - Enable websocket on HTTP settings tab
|
||||
|
||||
2 - add the "proxy_read_timeout 36000s;" instruction below "proxy_http_version 1.1;"
|
||||
2 - Add the "proxy_read_timeout 36000s;" instruction below "proxy_http_version 1.1;"
|
||||
|
||||
3 - Enable and force HTTPS and wait few minutes.
|
||||
|
||||
4 - Add the Collabora Online extension for Nextcloud (3.7.0 for now)
|
||||
|
||||
4 - add the Collabora Online extension for Nextcloud (3.7.0 for now)
|
||||
|
||||
|
||||
5 - go to your Nextcloud plugin configuration > collabora online > use your own server > paste the FQDN of your new instance of collabora > save
|
||||
|
||||
5 - Go to your Nextcloud plugin configuration > collabora online > use your own server > paste the FQDN of your new instance of collabora > save
|
||||
|
||||
That's all, you can use collabora online to all your Nextcloud instance.
|
||||
displayName: Collabora Online
|
||||
|
|
|
|||
|
|
@ -46,5 +46,5 @@ caproverOneClickApp:
|
|||
IMPORTANT: It will take up to 2 minutes for the application to be ready. Before that, you might see a 502 error page.
|
||||
displayName: Coral Talk
|
||||
isOfficial: true
|
||||
description: Coral is an open source commenting platform with a full suite of tools helps moderators easily identify disruptive comments.
|
||||
description: Coral is an open-source commenting platform with a full suite of tools helps moderators easily identify disruptive comments.
|
||||
documentation: Taken from https://docs.coralproject.net/coral/installation-from-docker/
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ caproverOneClickApp:
|
|||
defaultValue: 19.08.1
|
||||
validRegex: /^([^\s^\/])+$/
|
||||
instructions:
|
||||
start: Countly. This will only work over HTTPS, so enable plz :) | Product Analytics for Mobile, Web, Desktop and IoT | https://count.ly
|
||||
start: Countly will only work over HTTPS, so please enable it. | Product Analytics for Mobile, Web, Desktop and IoT | https://count.ly
|
||||
end: Countly is deployed and available as $$cap_appname
|
||||
displayName: ''
|
||||
isOfficial: true
|
||||
|
|
|
|||
|
|
@ -60,5 +60,5 @@ caproverOneClickApp:
|
|||
start: Dolibarr is an Open Source ERP & CRM for Business
|
||||
end: Dolibarr is deployed and available as srv-captain--$$cap_appname:8080 to other apps.
|
||||
displayName: Dolibarr
|
||||
description: Open Source ERP & CRM for Business (sme or large companies, freelancers, foundations)
|
||||
description: Open Source ERP & CRM for Business (SME or large companies, freelancers, foundations)
|
||||
documentation: https://hub.docker.com/r/upshift/dolibarr
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@ caproverOneClickApp:
|
|||
filebrowser provides a file managing interface within a specified directory and it can be used to upload, delete, preview, rename and edit your files. It allows the creation of multiple users and each user can have its own directory.
|
||||
|
||||
|
||||
|
||||
IMPORTANT:
|
||||
|
||||
The default image maps an empty volume to FileBrowser in order to avoid exposing your files, but after you finished installation and changed the password you can mount the root directory of host. i.e. / to /srv in the app.
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ caproverOneClickApp:
|
|||
defaultValue: b7b45f2
|
||||
description: Check out their Docker page for the valid tags https://hub.docker.com/r/machines/filestash/tags
|
||||
instructions:
|
||||
start: Filestash is a modern web client for SFTP, S3, FTP, WebDAV, Git, Minio, LDAP, CalDAV, CardDAV, Mysql, Backblaze, ...
|
||||
start: Filestash is a modern web client for SFTP, S3, FTP, WebDAV, Git, Minio, LDAP, CalDAV, CardDAV, Mysql, Backblaze...
|
||||
end: Filestash is deployed and available as srv-captain--$$cap_appname-db:8334 to other apps.
|
||||
displayName: Filestash
|
||||
description: A modern web client for SFTP, S3, FTP, WebDAV, Git, Minio, LDAP, CalDAV, CardDAV, Mysql, Backblaze, ...
|
||||
description: A modern web client for SFTP, S3, FTP, WebDAV, Git, Minio, LDAP, CalDAV, CardDAV, Mysql, Backblaze...
|
||||
documentation: Filestash https://www.filestash.app
|
||||
|
|
|
|||
|
|
@ -31,14 +31,13 @@ caproverOneClickApp:
|
|||
description: Get yours from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
validRegex: /.{1,}/
|
||||
instructions:
|
||||
start: Grocy is an ERP system for your kitchen and groceries! Cut down on food waste, and manage your chores with this brilliant utulity. Keep track of your purchaes, how much food you are wasting, what chores need doing and what batteries need charging with this proudly Open Source tool.
|
||||
start: Grocy is an ERP system for your kitchen and groceries! Cut down on food waste, and manage your chores with this brilliant utility. Keep track of your purchaes, how much food you are wasting, what chores need doing and what batteries need charging with this proudly Open Source tool.
|
||||
end: >-
|
||||
Grocy has been successfully deployed. Please wait about 2-5 minutes before accessing Grocy.
|
||||
|
||||
|
||||
|
||||
Username and password are both admin.
|
||||
displayName: Grocy
|
||||
isOfficial: true
|
||||
description: Grocy is an ERP system for your kitchen and groceries! Cut down on food waste, and manage your chores with this brilliant utulity.
|
||||
description: Grocy is an ERP system for your kitchen and groceries! Cut down on food waste, and manage your chores with this brilliant utility.
|
||||
documentation: Taken from https://hub.docker.com/r/linuxserver/grocy/tags
|
||||
|
|
|
|||
|
|
@ -31,9 +31,9 @@ caproverOneClickApp:
|
|||
defaultValue: long-secret
|
||||
validRegex: /^\s*\S.*$/
|
||||
instructions:
|
||||
start: Reporting tools for creating PDF, HTMLS, Excel by converting your HTML + CSS + Javascript knowledge.
|
||||
start: Reporting tools for creating PDF, HTMLS, Excel by converting your HTML + CSS + JavaScript knowledge.
|
||||
end: Congratulations! You have the new jsReport instance running. Happy reporting!
|
||||
displayName: ''
|
||||
isOfficial: true
|
||||
description: jsreport is an open source reporting platform where reports are designed using popular javascript templating engines
|
||||
description: jsreport is an open source reporting platform where reports are designed using popular JavaScript templating engines
|
||||
documentation: Taken from https://hub.docker.com/r/jsreport/jsreport/
|
||||
|
|
|
|||
|
|
@ -59,7 +59,6 @@ caproverOneClickApp:
|
|||
|
||||
For source code, see: https://github.com/keycloak/keycloak
|
||||
|
||||
|
||||
For docker image, see: https://hub.docker.com/r/jboss/keycloak
|
||||
|
||||
Enter your Keycloak Configuration parameters and click on next. It will take about a minute for the process to finish.
|
||||
|
|
|
|||
|
|
@ -29,9 +29,9 @@ caproverOneClickApp:
|
|||
id: $$cap_ELASTICSEARCH_HOSTS
|
||||
instructions:
|
||||
end: >-
|
||||
That's it! If you get a 502 it might mean that kibana cannot find your elasticsearch instance. Please recheck your configs
|
||||
That's it! If you get a 502 it might mean that kibana cannot find your elasticsearch instance. Please recheck your configs.
|
||||
|
||||
. Ensure basic auth is enabled so your data is not publicly available.
|
||||
Ensure basic auth is enabled so your data is not publicly available.
|
||||
start: >-
|
||||
Provide the ELASTICSEARCH_HOSTS so that kibana can find your elasticsearch instance. be sure to include the http:// protocol in the url.
|
||||
Note that Kibana does not have persistent volumes as all data is stored in the elasticsearch instance itself.
|
||||
|
|
|
|||
|
|
@ -191,7 +191,7 @@ caproverOneClickApp:
|
|||
start: >-
|
||||
Before you proceed keep a note of the following.
|
||||
|
||||
-----------------------------------------------------
|
||||
--------------------------------------------------
|
||||
|
||||
|
||||
After you deploy mastodon and created your fist user in the browser, you will need to use the command line to give your newly created account admin privileges.
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ caproverOneClickApp:
|
|||
label: DISABLE CRON
|
||||
defaultValue: ''
|
||||
instructions:
|
||||
start: Runs mongodump to backup data using cronjob to an s3 bucket
|
||||
start: Runs mongodump to backup data using cronjob to an S3 bucket
|
||||
end: MongoDB Backup S3 is ready
|
||||
displayName: MongoDB Backup Amazon S3
|
||||
description: Runs mongodump to backup data using cronjob to an Amazon S3 bucket
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ caproverOneClickApp:
|
|||
Check out their Docker page for the valid tags https://hub.docker.com/r/library/nextcloud/tags/
|
||||
|
||||
|
||||
do not use fpm versions.
|
||||
Do not use fpm versions.
|
||||
validRegex: /^([^\s^\/])+$/
|
||||
- id: $$cap_mariadb_version
|
||||
label: MariaDB (database) version
|
||||
|
|
|
|||
|
|
@ -25,5 +25,5 @@ caproverOneClickApp:
|
|||
end: Reverse Proxy is deployed and available as $$cap_appname
|
||||
displayName: Nginx Reverse Proxy
|
||||
isOfficial: true
|
||||
description: A simple nginx image preloaded with reverse proxy config that allows you to proxy a URL to another URL
|
||||
description: A simple Nginx image preloaded with reverse proxy config that allows you to proxy a URL to another URL
|
||||
documentation: Taken from https://github.com/caprover/nginx-reverse-proxy
|
||||
|
|
|
|||
|
|
@ -98,9 +98,9 @@ caproverOneClickApp:
|
|||
instructions:
|
||||
start: 'PeerTube is a free, decentralized and federated video platform. (Github : https://github.com/Chocobozzz/PeerTube/)'
|
||||
end: >
|
||||
Peertube is deployed and available as $$cap_appname.
|
||||
PeerTube is deployed and available as $$cap_appname.
|
||||
|
||||
IMPORTANT: It will take up to 2 minutes for peertube to be ready. Before that, you might see 502 error page.
|
||||
IMPORTANT: It will take up to 2 minutes for PeerTube to be ready. Before that, you might see 502 error page.
|
||||
displayName: ''
|
||||
isOfficial: true
|
||||
description: PeerTube is a decentralized video hosting network, based on free/libre software
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ caproverOneClickApp:
|
|||
validRegex: /^([^\s^\/])+$/
|
||||
instructions:
|
||||
start: PhotoPrism is a server-based application for browsing, organizing and sharing your personal photo collection. We recommend hosting PhotoPrism on a server with at least 2 cores and 4 GB of memory. It makes use of the latest technologies to automatically tag and find pictures without getting in your way.
|
||||
end: Photoprism is deployed and available as $$cap_appname. Please also enable Websockets in the Caprover UI. When you log in the default password is 'photoprism'
|
||||
displayName: Photoprism
|
||||
end: PhotoPrism is deployed and available as $$cap_appname. Please also enable Websockets in the Caprover UI. When you log in the default password is 'photoprism'
|
||||
displayName: PhotoPrism
|
||||
isOfficial: true
|
||||
description: An app for browsing, organizing and sharing your personal photo collection.
|
||||
documentation: Taken from https://hub.docker.com/r/photoprism/photoprism
|
||||
|
|
|
|||
|
|
@ -34,14 +34,10 @@ caproverOneClickApp:
|
|||
description: The full hostname for this captain app. (usually mail.mydomain.com)
|
||||
instructions:
|
||||
start: >-
|
||||
SMTP + IMAP + POP3 + Antispam + Antivirus
|
||||
|
||||
Web administration + Web email
|
||||
|
||||
...on your server in ~5 minutes
|
||||
SMTP + IMAP + POP3 + Antispam + Antivirus + Web administration + Web email on your server in ~5 minutes
|
||||
|
||||
|
||||
Recommended: Use"mail" as the App Name.
|
||||
Recommended: Use "mail" as the App Name.
|
||||
end: >-
|
||||
Please paste the preDeployFunction from https://github.com/caprover/caprover/issues/479#issuecomment-520902309 to the App Config > Pre-Deploy section of your created poste.io instance $$cap_appname.
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ caproverOneClickApp:
|
|||
SonarQube is an open source product for continuous inspection of code quality.
|
||||
This Docker image contains the Community Edition of SonarQube.
|
||||
|
||||
Enter your Sonarqube Configuration parameters and click on next.
|
||||
Enter your SonarQube Configuration parameters and click on next.
|
||||
|
||||
More information about this container can be found here:
|
||||
https://hub.docker.com/_/sonarqube?tab=description
|
||||
|
|
|
|||
|
|
@ -96,7 +96,9 @@ caproverOneClickApp:
|
|||
end: |-
|
||||
Squidex is deployed and available as $$cap_appname
|
||||
You'll need also to enable https in order to make this app work.
|
||||
|
||||
IMPORTANT!! Don't forget to change the URLS__BASEURL,LETSENCRYPT_HOST and VIRTUAL_HOST variable if you change your URL.
|
||||
|
||||
IMPORTANT!! It takes up to 2-5 minutes for Squidex to boot up. You will see a 502 Error until the startup is finished.
|
||||
displayName: ''
|
||||
isOfficial: true
|
||||
|
|
|
|||
|
|
@ -37,7 +37,6 @@ caproverOneClickApp:
|
|||
The following app sets up an SSHd service in a container that you can use to connect to and inspect other container’s volumes, or to get quick access to a test container.
|
||||
|
||||
|
||||
|
||||
IMPORTANT:
|
||||
|
||||
This setup uses password login. You can optionally mount your keys and use public/private key to log in.
|
||||
|
|
|
|||
|
|
@ -61,11 +61,9 @@ caproverOneClickApp:
|
|||
read more on https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/deployment.html#hosting-provider-guides
|
||||
end: >-
|
||||
Strapi is deployed and available as $$cap_appname
|
||||
|
||||
IMPORTANT: It will take up to 3 minutes for Strapi to be ready. Before that, you will see an 502 error page.
|
||||
|
||||
Note when installing a plugin an error will be displayed. This error message is due to a restart on plugin installation.
|
||||
|
||||
This behaviour is normal. Refresh the page after few seconds (502 can happen if you refresh too fast).
|
||||
displayName: ''
|
||||
isOfficial: true
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ caproverOneClickApp:
|
|||
start: The Lounge, a self-hosted web IRC client.
|
||||
end: >-
|
||||
Your instance is now fully deployed.
|
||||
|
||||
To create your user, run `docker exec --user node -it $(docker ps -f name=srv-captain--$$cap_appname --quiet) thelounge add [user]` on your host.
|
||||
displayName: The Lounge
|
||||
isOfficial: true
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ caproverOneClickApp:
|
|||
|
||||
IMPORTANT: It will take up to 2 minutes for WordPress to be ready. Before that, you might see a 502 error page.
|
||||
|
||||
. Remember that this app will not create a Database by itself. You need to provide all that information.
|
||||
Remember that this app will not create a Database by itself. You need to provide all that information.
|
||||
displayName: WordPress - No Database
|
||||
isOfficial: true
|
||||
description: This will create a WordPress only. You will need to create and configure the database information manually. Intended for advanced users.
|
||||
|
|
|
|||
Loading…
Reference in New Issue