feat: leverage .env file (#42)

* feat: leverage .env file

- prevent user from modifying docker-compose.yml
- prevent user from building db url by itself, thanks to dotenv-expand

* refactor: expose db port only to other services

* refactor: expose db port only to other services

---------

Co-authored-by: João Lucas <[email protected]>

.env.example

@@ -1,6 +1,15 @@
-DATABASE_URL=postgresql:https://johndoe:randompassword@localhost:5432/mydb?schema=public
+PORT=3000
 SALT="this is a very insecure salt, change it"
 
+DB_NAME=mydb
+DB_PROVIDER=postgres
+DB_HOST=db # db refers to the name of the service in docker-compose.yml
+DB_USER=johndoe
+DB_PASSWORD=randompassword
+
+# do not modify. copy as-is. dotenv-expand will replace the variables
+DATABASE_URL=${DB_PROVIDER}:https://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:5432?schema=public
+
 MAIL_ENABLED=false
 MAIL_SERVER=smtp.gmail.com
 MAIL_PORT=465

README.md

@@ -53,7 +53,13 @@ Right now, my instance is using PostgreSQL on Vercel. However, it can be run usi
 
 ### .env Configuration
 
-`DATABASE_URL` needs to point to a running SQL database. It uses PostgreSQL by default, but can be changed to MySQL or SQLite by modifying the provider in [schema.prisma](src/lib/server/prisma/schema.prisma).
+- `DB_NAME` is the database name;
+- `DB_PROVIDER` uses 'postgres' by default, but can be changed to MySQL or SQLite.
+- `DB_HOST` database host (defaults to 'db', but can be changed to aything like localhost)
+- `DB_USER` database user
+- `DB_PORT` database port 5432
+- `DB_PASSWORD` the database user password
+- `DATABASE_URL` you don't need to modify this variable (thanks to dotenv-expand). keep it though!
 
 Remember to modify `SALT` to something secure if you plan on using user accounts.
 

docker-compose.yml

@@ -1,22 +1,33 @@
 version: '3.3'
+networks:
+ yabin-network:
+ name: yabin-network
+ ipam:
+ driver: default
 services:
  yabin:
+ container_name: yabin
  ports:
- - '3000:3000'
+ - '${PORT:-3000}:${PORT:-3000}'
  image: 'yureien/yabin:latest'
- environment:
- - DATABASE_URL=postgresql:https://user:pass@db:5432/yabin?schema=public
+ env_file: .env
  depends_on:
  - db
+ networks:
+ - yabin-network
  db:
+ container_name: yabin-db
+ restart: always
  image: postgres:15-alpine
+ env_file: .env
+ expose:
+ - '5432'
  environment:
- POSTGRES_USER: user
- POSTGRES_PASSWORD: pass
- POSTGRES_DB: yabin
+ POSTGRES_USER: ${DB_USER:-yabin_user}
+ POSTGRES_PASSWORD: ${DB_USER_PASS:-123}
+ POSTGRES_DB: ${DB_NAME:-yabin_db}
  POSTGRES_HOST_AUTH_METHOD: "trust"
  volumes:
- - db_data:/var/lib/postgresql/data:Z
- restart: always
-volumes:
- db_data: {}
+ - ./db-data:/var/lib/postgresql/data
+ networks:
+ - yabin-network

src/lib/server/prisma/schema.prisma

@@ -6,7 +6,7 @@ generator client {
 }
 
 datasource db {
- provider = "postgresql"
+ provider = env("DB_PROVIDER")
  url = env("DATABASE_URL")
 }