Create a new guide for send, an alternative to WeTransfer #724
Conversation
wowi42
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR creates a comprehensive deployment guide for Send, a privacy-focused file sharing application that serves as an alternative to WeTransfer. The guide provides step-by-step instructions for deploying Send on Clever Cloud platform with Redis and S3-compatible storage.
- Complete deployment walkthrough including prerequisites, installation, and configuration
- Integration setup for Redis metadata storage and Cellar S3 file storage
- Configuration examples for environment variables, custom branding, and domain setup
content/guides/send.md
Outdated
| @@ -0,0 +1,248 @@ | |||
| --- | |||
| title: 'Send' | |||
| description: | |||
There was a problem hiding this comment.
The description field is empty. Add a meaningful description that summarizes what this guide covers, such as 'A comprehensive guide to deploying Send, a secure file sharing application, on Clever Cloud platform.'
| description: | |
| description: 'A comprehensive guide to deploying Send, a secure file-sharing application, on the Clever Cloud platform.' |
content/guides/send.md
Outdated
| tags: | ||
| - guides | ||
| keywords: | ||
| - |
There was a problem hiding this comment.
The keywords field contains only a dash. Add relevant keywords like 'send', 'file-sharing', 'privacy', 'wetransfer-alternative', 'clever-cloud' to improve discoverability.
| - | |
| - send | |
| - file-sharing | |
| - privacy | |
| - wetransfer-alternative | |
| - clever-cloud |
✅ Review app deployedCheck how your changes look like!
|
content/guides/send.md
Outdated
| @@ -0,0 +1,219 @@ | |||
| --- | |||
| title: 'Send' | |||
| description: "Simple, private file sharing" | |||
There was a problem hiding this comment.
Use a longer description (about 100 characters)
content/guides/send.md
Outdated
| - cellar | ||
| - s3 | ||
|
|
||
| draft: false |
There was a problem hiding this comment.
you can remove this, it's false by default
content/guides/send.md
Outdated
| - s3 | ||
|
|
||
| draft: false | ||
| type: send |
There was a problem hiding this comment.
Put this as the first parameter of the frontmatter
| type: send | |
| type: docs |
|
|
||
| Before deploying Send on Clever Cloud, make sure you have: | ||
|
|
||
| - **Node.js 16.x** |
There was a problem hiding this comment.
We need to patch upstream
There was a problem hiding this comment.
My point is: it's not the needed version, it's maybe the minimum required version. But if the user can use a supported version, we should recommend it in settings, and here mention that the requirement is 16+. If Node.js 16 is mandatory, we can let it as is, but there are security concerns on non supported releases.
content/guides/send.md
Outdated
| - **Node.js 16.x** | ||
| - **Redis** for metadata storage | ||
| - **Cellar S3** for file storage | ||
| - **Clever Tools CLI** ([documentation](https://www.clever-cloud.com/developers/doc/cli/)) |
There was a problem hiding this comment.
Use link relative to the root domain, it's easier to manage when we change domain/path
| - **Clever Tools CLI** ([documentation](https://www.clever-cloud.com/developers/doc/cli/)) | |
| - **Clever Tools CLI** ([documentation](/developers/doc/cli/)) |
|
|
||
| ```bash | ||
| # Redis configuration | ||
| clever env set REDIS_DB 0 |
There was a problem hiding this comment.
Is it mandatory? It's the default ?
There was a problem hiding this comment.
| clever env set S3_ENDPOINT <CELLAR_ADDON_HOST> | ||
| clever env set AWS_ACCESS_KEY_ID <CELLAR_ADDON_KEY_ID> | ||
| clever env set AWS_SECRET_ACCESS_KEY <CELLAR_ADDON_KEY_SECRET> |
There was a problem hiding this comment.
Use a binding script as we did in oTree, you can fuse this with post build commands in the same script
There was a problem hiding this comment.
when you do some otree, you build your app with otree, more like a framework. Here it is not the same: we are using the source code directly from them. I do not want to commit upstream some Clever Cloud specific code.
content/guides/send.md
Outdated
|
|
||
| ```bash | ||
| # Base URL (replace with your test domain) | ||
| clever env set BASE_URL https://<your-test-domain> |
There was a problem hiding this comment.
you can set it from the application domain (clever domain favourite)
There was a problem hiding this comment.
updated the documentation to be more clear
| clever domain add <your-custom-domain.com> | ||
|
|
||
| # Update the BASE_URL environment variable | ||
| clever env set BASE_URL https://<your-custom-domain.com> |
There was a problem hiding this comment.
no, different paragraphs
There was a problem hiding this comment.
I think we should have one only section for domain configuration. We can tell the user to set a default cleverapps.io or its own domain here, but should't tell him to set one, then the other and restart
| clever env set BASE_URL https://<your-custom-domain.com> | ||
|
|
||
| # Restart to apply new BASE_URL | ||
| clever restart |
There was a problem hiding this comment.
unnecessary if we do it before
2 participants
Describe your PR
Create a new guide for send, an alternative to WeTransfer