diff --git a/docs/.vitepress/theme/components/Services/List.vue b/docs/.vitepress/theme/components/Services/List.vue index 96d2305b..9b731c05 100644 --- a/docs/.vitepress/theme/components/Services/List.vue +++ b/docs/.vitepress/theme/components/Services/List.vue @@ -370,6 +370,12 @@ const services = [ description: 'Web app for browsing, reading and downloading eBooks from a Calibre database.', category: 'Media' }, + { + name: 'Cap', + icon: '/public/images/services/cap.svg', + description: 'Cap is the open source alternative to Loom. Lightweight, powerful, and cross-platform. Record and share in seconds.', + category: 'Media' + }, { name: 'Castopod', icon: '/public/images/services/castopod.svg', diff --git a/docs/public/images/services/cap-app.webp b/docs/public/images/services/cap-app.webp new file mode 100644 index 00000000..e9624a80 Binary files /dev/null and b/docs/public/images/services/cap-app.webp differ diff --git a/docs/public/images/services/cap.svg b/docs/public/images/services/cap.svg new file mode 100644 index 00000000..83d26e15 --- /dev/null +++ b/docs/public/images/services/cap.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/services/cap.md b/docs/services/cap.md new file mode 100644 index 00000000..530f9d94 --- /dev/null +++ b/docs/services/cap.md @@ -0,0 +1,71 @@ +--- +title: "Cap" +description: "Here you can find the documentation for hosting Cap with Coolify." +--- + + + +## What is Cap + +Cap is the open source alternative to Loom. Lightweight, powerful, and cross-platform. Record and share in seconds. + +## How to self-host + +There are two storage options: you can store the video data on a remote storage service like S3 or R2, or you can choose the less recommended option of storing it directly on the local VPS (or another VPS) via a MinIO service. + +### Option 1: Remote S3-compatible storage (AWS S3, Cloudflare R2, etc.) + +Set these environment variables: +**** +- `CAP_AWS_ACCESS_KEY`: Your S3/R2 access key +- `CAP_AWS_SECRET_KEY`: Your S3/R2 secret key +- `CAP_AWS_BUCKET`: Your S3/R2 bucket name +- `CAP_AWS_REGION`: Your S3/R2 region (e.g., us-east-1, auto for R2) +- `CAP_AWS_ENDPOINT`: Your S3/R2 endpoint URL +- `S3_PUBLIC_ENDPOINT`: Public endpoint for your bucket (same as CAP_AWS_ENDPOINT for most cases) +- `S3_INTERNAL_ENDPOINT`: Internal endpoint (same as CAP_AWS_ENDPOINT for most cases) +- `S3_PATH_STYLE`: true for R2/most S3-compatible, false for AWS S3 virtual-hosted style + +### Option 2: Local MinIO storage + +Deploy MinIO as a separate service in the same network and set: + +- `CAP_AWS_ACCESS_KEY`: MinIO root user +- `CAP_AWS_SECRET_KEY`: MinIO root password +- `CAP_AWS_BUCKET`: Your bucket name (e.g., capso) +- `CAP_AWS_REGION`: us-east-1 (or any region) +- `CAP_AWS_ENDPOINT`: http://minio:9000 (internal MinIO endpoint) +- `S3_PUBLIC_ENDPOINT`: http://your-minio-domain:9000 (public MinIO endpoint) +- `S3_INTERNAL_ENDPOINT`: http://minio:9000 (internal MinIO endpoint) +- `S3_PATH_STYLE`: true + +## Email Login Links + +If the `RESEND_API_KEY` and `RESEND_FROM_DOMAIN` environment variables are not set, login links will be written to the server logs. To send login links via email, you'll need to configure [Resend](https://resend.com): + +1. Create an account at [Resend](https://resend.com) +2. Connect a domain and set it as `RESEND_FROM_DOMAIN` +3. Generate an API key and set it as `RESEND_API_KEY` + +## How to unlock limits (organization seats and recordings) + + +1. Open the terminal of the MySQL service +2. Connect to the database: `mysql -u root -p planetscale` and use the MYSQL_ROOT_PASSWORD when prompted +3. Run the SQL command below, replacing `your-user-id` with your actual user ID + ```sql + UPDATE users SET inviteQuota = 100, stripeSubscriptionId = '12345', subscriptionStatus = 'active' WHERE id = 'your-user-id'; + ``` +4. You can verify the changes by running the following command: + ```sql + SELECT * FROM users WHERE id = 'your-user-id'; + ``` + +## Screenshots + + + +## Links + +- [The official website ›](https://cap.so/) +- [GitHub ›](https://github.com/CapSoftware/Cap)