feat: Add deployment configurations for Railway and VPS (#1) #2044
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Reviewer's GuideThis PR adds comprehensive deployment support for both Railway and VPS environments by introducing an automated VPS install script, a dedicated Docker Compose configuration for VPS, environment templates, Railway-specific deployment settings, and detailed documentation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
. |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- In docker-compose.vps.yaml, consider adding healthcheck configurations for the api, postgres, and redis services so that
depends_onwill wait for full service readiness rather than just container start. - The VPS install script’s fallback for installing Docker Compose uses
apt-geteven on RHEL-based distros—add ayum-based path or use the official Compose plugin install method to ensure compatibility across all supported distros. - Pin explicit image tags or digests in docker-compose.vps.yaml (e.g. for your API image and postgres/redis) to guarantee reproducible and stable deployments.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In docker-compose.vps.yaml, consider adding healthcheck configurations for the api, postgres, and redis services so that `depends_on` will wait for full service readiness rather than just container start.
- The VPS install script’s fallback for installing Docker Compose uses `apt-get` even on RHEL-based distros—add a `yum`-based path or use the official Compose plugin install method to ensure compatibility across all supported distros.
- Pin explicit image tags or digests in docker-compose.vps.yaml (e.g. for your API image and postgres/redis) to guarantee reproducible and stable deployments.
## Individual Comments
### Comment 1
<location> `scripts/install_vps.sh:40` </location>
<code_context>
+ ubuntu|debian)
+ $SUDO apt-get update -y
+ $SUDO apt-get install -y ca-certificates curl gnupg lsb-release
+ install -d -m 0755 /etc/apt/keyrings
+ curl -fsSL https://download.docker.com/linux/$ID/gpg | $SUDO gpg --dearmor -o /etc/apt/keyrings/docker.gpg
+ echo \
</code_context>
<issue_to_address>
**issue (bug_risk):** Potential permission issue when creating /etc/apt/keyrings without sudo.
Prefix the 'install' command with $SUDO to avoid permission errors when not running as root.
</issue_to_address>
### Comment 2
<location> `scripts/install_vps.sh:71-77` </location>
<code_context>
+prepare_env() {
+ if [ ! -f .env ]; then
+ log "Gerando .env a partir de .env.vps.example"
+ cp .env.vps.example .env
+ # gerar chave aleatória
+ local key
</code_context>
<issue_to_address>
**suggestion:** No check for existence of .env.vps.example before copying.
Add a file existence check before copying to prevent script failure if .env.vps.example is missing.
```suggestion
if [ ! -f .env ]; then
if [ ! -f .env.vps.example ]; then
log "Erro: .env.vps.example não encontrado. Não é possível gerar .env."
exit 1
fi
log "Gerando .env a partir de .env.vps.example"
cp .env.vps.example .env
# gerar chave aleatória
local key
key=$(openssl rand -hex 24)
sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env
```
</issue_to_address>
### Comment 3
<location> `scripts/install_vps.sh:74-77` </location>
<code_context>
+ cp .env.vps.example .env
+ # gerar chave aleatória
+ local key
+ key=$(openssl rand -hex 24)
+ sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env
+ else
</code_context>
<issue_to_address>
**suggestion (bug_risk):** No check for openssl availability before using it.
Use 'require_cmd openssl' before this line to ensure the command doesn't fail if openssl is missing.
```suggestion
# gerar chave aleatória
require_cmd openssl
local key
key=$(openssl rand -hex 24)
sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| ubuntu|debian) | ||
| $SUDO apt-get update -y | ||
| $SUDO apt-get install -y ca-certificates curl gnupg lsb-release | ||
| install -d -m 0755 /etc/apt/keyrings |
There was a problem hiding this comment.
issue (bug_risk): Potential permission issue when creating /etc/apt/keyrings without sudo.
Prefix the 'install' command with $SUDO to avoid permission errors when not running as root.
Comment on lines
+71
to
+77
| if [ ! -f .env ]; then | ||
| log "Gerando .env a partir de .env.vps.example" | ||
| cp .env.vps.example .env | ||
| # gerar chave aleatória | ||
| local key | ||
| key=$(openssl rand -hex 24) | ||
| sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env |
There was a problem hiding this comment.
suggestion: No check for existence of .env.vps.example before copying.
Add a file existence check before copying to prevent script failure if .env.vps.example is missing.
Suggested change
| if [ ! -f .env ]; then | |
| log "Gerando .env a partir de .env.vps.example" | |
| cp .env.vps.example .env | |
| # gerar chave aleatória | |
| local key | |
| key=$(openssl rand -hex 24) | |
| sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env | |
| if [ ! -f .env ]; then | |
| if [ ! -f .env.vps.example ]; then | |
| log "Erro: .env.vps.example não encontrado. Não é possível gerar .env." | |
| exit 1 | |
| fi | |
| log "Gerando .env a partir de .env.vps.example" | |
| cp .env.vps.example .env | |
| # gerar chave aleatória | |
| local key | |
| key=$(openssl rand -hex 24) | |
| sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env |
Comment on lines
+74
to
+77
| # gerar chave aleatória | ||
| local key | ||
| key=$(openssl rand -hex 24) | ||
| sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env |
There was a problem hiding this comment.
suggestion (bug_risk): No check for openssl availability before using it.
Use 'require_cmd openssl' before this line to ensure the command doesn't fail if openssl is missing.
Suggested change
| # gerar chave aleatória | |
| local key | |
| key=$(openssl rand -hex 24) | |
| sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env | |
| # gerar chave aleatória | |
| require_cmd openssl | |
| local key | |
| key=$(openssl rand -hex 24) | |
| sed -i "s/^AUTHENTICATION_API_KEY=.*/AUTHENTICATION_API_KEY=${key}/" .env |
|
Change not required to run on the Railway |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📋 Description
🔗 Related Issue
Closes #(issue_number)
🧪 Type of Change
🧪 Testing
📸 Screenshots (if applicable)
✅ Checklist
📝 Additional Notes
Summary by Sourcery
Add deployment support for Railway and VPS environments by introducing necessary scripts, configurations, and documentation.
New Features:
Deployment:
Documentation: