Skip to content

Commit 3a76139

Browse files
committed
Update README with deploy instructions for dokploy
1 parent 592183f commit 3a76139

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

.env.dokploy.example

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
RAILS_ENV=production
2+
DISPLAY_ENV=production
3+
SECRET_KEY_BASE=changeme
4+
APP_PROTOCOL=https
5+
APP_HOST=starter-rails-agosgj-a3c8ce-52-12-189-130.traefik.me
6+
7+
SMTP_HOST=test
8+
SMTP_PORT=587
9+
SMTP_USERNAME=test
10+
SMTP_PASSWORD=test
11+
12+
AWS_REGION=us-west-2
13+
AWS_ACCESS_KEY_ID=changeme
14+
AWS_SECRET_ACCESS_KEY=changeme

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
# Ignore all environment files (except templates).
1111
/.env*
1212
!/.env*.erb
13+
!/.env.development
14+
!/.env.dokploy.example
1315

1416
# Ignore all logfiles and tempfiles.
1517
/log/*

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,11 @@ To cleanup all containers, volumes and networks execute `docker compose down -v`
9999

100100
## Deployment
101101

102-
* Ensure ENV variables are set:
103-
* DISPLAY_ENV=production
104-
* RAILS_ENV=production
105-
* SECRET_KEY_BASE
106-
* SMTP_HOST
107-
* SMTP_PORT
108-
* SMTP_USERNAME
109-
* SMTP_PASSWORD
110-
* Ensure SMTP
102+
This starter is set up to deploy out of the box on dokploy using a compose configuration. There are some items that need to be set up properly:
103+
104+
1. Configure the environment variables. You can find samples in `.env.dokploy.example`
105+
2. Make sure you configure a domain
106+
3. Make sure you turn on **Enable Isolated Deployment** in the
111107

112108
---
113109

0 commit comments

Comments
 (0)