Skip to content

Commit

Permalink
Added Docmost One-Click App - My First Contribution! ✨ (#1149)
Browse files Browse the repository at this point in the history
* Add Docmost app

* Fix formatting issues in docmost.yml
  • Loading branch information
larananas authored Sep 20, 2024
1 parent e3a87ca commit 48ba94c
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 0 deletions.
135 changes: 135 additions & 0 deletions public/v4/apps/docmost.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
captainVersion: 4
services:
# Docmost
$$cap_appname:
environment:
APP_URL: http://$$cap_appname.$$cap_root_domain
APP_SECRET: $$cap_app_secret
PORT: 3000
JWT_TOKEN_EXPIRES_IN: $$cap_jwt_token_expire_in
DATABASE_URL: postgresql://docmost:$$cap_db_docmost_password@srv-captain--$$cap_appname-db:5432/docmost?schema=public
REDIS_URL: redis://srv-captain--$$cap_appname-redis:6379
STORAGE_DRIVER: $$cap_strorage_driver
AWS_S3_ACCESS_KEY_ID: $$cap_aws_s3_access_key_id
AWS_S3_SECRET_ACCESS_KEY: $$cap_aws_s3_secret_access_key
AWS_S3_REGION: $$cap_aws_s3_region
AWS_S3_BUCKET: $$cap_aws_s3_bucket
AWS_S3_ENDPOINT: $$cap_aws_s3_endpoint
MAIL_DRIVER: $$cap_mail_driver
POSTMARK_TOKEN: $$cap_postmark_token
SMTP_HOST: $$cap_smtp_host
SMTP_PORT: $$cap_smtp_port
SMTP_USERNAME: $$cap_smtp_username
SMTP_PASSWORD: $$cap_smtp_password
SMTP_SECURE: $$cap_smtp_secure
MAIL_FROM_ADDRESS: $$cap_mail_from_address
MAIL_FROM_NAME: $$cap_mail_from_name
image: docmost/docmost:$$cap_docmost_version
restart: always
volumes:
- $$cap_appname-data:/app/data/storage
depends_on:
- $$cap_appname-db
- $$cap_appname-redis
caproverExtra:
containerHttpPort: '3000'
$$cap_appname-db:
environment:
POSTGRES_DB: docmost
POSTGRES_USER: docmost
POSTGRES_PASSWORD: $$cap_db_docmost_password
image: postgres:16-alpine
restart: always
volumes:
- $$cap_appname-db-data:/var/lib/postgresql/data
caproverExtra:
notExposeAsWebApp: 'true'
$$cap_appname-redis:
image: redis:7.2-alpine
restart: always
volumes:
- $$cap_appname-redis-data:/data
caproverExtra:
notExposeAsWebApp: 'true'
caproverOneClickApp:
variables:
- defaultValue: 0.3.1
description: Check out their Docker page for the valid tags https://hub.docker.com/r/docmost/docmost/tags
id: $$cap_docmost_version
label: Dockmost version
validRegex: /^([^\s^\/])+$/
- defaultValue: $$cap_gen_random_hex(32)
description: A random key that is used for application security.
id: $$cap_app_secret
label: 'Application secret'
validRegex: /^(?=.*\d).{10,}$/
- defaultValue: 30d
description: The expiration time for JSON Web Tokens (JWT)..
id: $$cap_jwt_token_expire_in
label: 'JSON expiration time'
- defaultValue: $$cap_gen_random_hex(32)
description: Database password of the docmost user.
id: $$cap_db_docmost_password
label: 'Database password'
validRegex: /^(?=.*\d).{10,}$/
- defaultValue: local
description: The storage driver to use for file storage, can be "local" or "s3".
id: $$cap_strorage_driver
label: 'Storage driver'
- description: Your AWS S3 access key ID.
id: $$cap_aws_s3_access_key_id
label: '[OPTIONAL] S3 access key ID'
- description: Your S3 secret access key.
id: $$cap_aws_s3_secret_access_key
label: '[OPTIONAL] S3 secret access key'
- description: The region where your S3 bucket is located.
id: $$cap_aws_s3_region
label: '[OPTIONAL] S3 bucket region'
- description: The name of your S3 bucket.
id: $$cap_aws_s3_bucket
label: '[OPTIONAL] S3 bucket name'
- description: The endpoint URL for your S3 service (optional).
id: $$cap_aws_s3_endpoint
label: '[OPTIONAL] S3 service endpoint URL'
- description: The mail driver to use for sending emails, can be "smtp" or "postmark".
id: $$cap_mail_driver
label: '[OPTIONAL] Mail driver'
- description: The token for Postmark, if using Postmark as the mail driver.
id: $$cap_postmark_token
label: '[OPTIONAL] Postmark token'
- description: The SMTP server to use for sending emails.
id: $$cap_smtp_host
label: '[OPTIONAL] SMTP server'
- description: The port to use for the SMTP server.
id: $$cap_smtp_port
label: '[OPTIONAL] SMTP port'
- description: The username for the SMTP server.
id: $$cap_smtp_username
label: '[OPTIONAL] SMTP username'
- description: The password for the SMTP server.
id: $$cap_smtp_password
label: '[OPTIONAL] SMTP password'
- description: Indicate if TLS should be use when connecting to the SMTP server.
id: $$cap_smtp_secure
label: '[OPTIONAL] SMTP secure'
- description: The email address that emails will be sent from.
id: $$cap_mail_from_address
label: '[OPTIONAL] Sender email adress'
- description: The name that emails will be sent from.
id: $$cap_mail_from_name
label: '[OPTIONAL] Sender email name'
instructions:
start: Docmost is an open-source collaborative wiki and documentation software.
end: >-
🎉 It's done! Docmost is deployed and available as $$cap_appname. 🎉
Please enable HTTPS before starting using Docmost.
Your service is available at http://$$cap_appname.$$cap_root_domain
Go there to create your admin account
IMPORTANT: It will take up to 2 minutes for Docmost to be ready. Before that, you might see 502 error page.
displayName: 'Docmost'
isOfficial: true
description: Docmost is an open-source collaborative wiki and documentation software.
documentation: https://docmost.com/docs
Binary file added public/v4/logos/docmost.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 48ba94c

Please sign in to comment.