refactor: better organized docker installation

Slick-Telemetry · Feb 11, 2024 · 6d63a94 · 6d63a94
1 parent 210a94b
commit 6d63a94
Show file tree

Hide file tree

Showing 17 changed files with 19 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -160,5 +160,5 @@ cython_debug/
 #.idea/
 
 # Supabase self-host
-volumes/db/data
-volumes/storage
+docker/volumes/db/data
+docker/volumes/storage
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,2 @@
 # required in order for supabase-kong to work
-volumes/api/kong.yml
+docker/volumes/api/kong.yml
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@ Table of Contents:
 - [Setting up the project](#setting-up-the-project)
   - [What you'll need](#what-youll-need)
 - [Development](#development)
+  - [Environment variables](#environment-variables)
   - [Python virtual environment](#python-virtual-environment)
     - [Installing dependencies](#installing-dependencies)
     - [Virtual environment sanity check](#virtual-environment-sanity-check)
@@ -33,6 +34,10 @@ Table of Contents:
 
 ## Development
 
+### Environment variables
+
+In `/docker`, create a copy of `.env.example` as `.env`.
+
 ### Python virtual environment
 
 #### Installing dependencies
@@ -77,15 +82,16 @@ pre-commit install --hook-type commit-msg --hook-type pre-push --hook-type pre-c
   ```
 - Run container
   ```sh
-  docker run --detach --name backend-dev --publish 8081:8081 backend-dev
+  docker run --name backend-dev --publish 8081:8081 backend-dev --detach
   ```
 - Open your browser at `http://localhost/8081`.
 
 #### With Supabase
 
 - Bring up the services
   ```sh
-  docker compose --detach --file compose.dev.yaml up
+  cd docker
+  docker compose --file compose.dev.yaml up --detach
   ```
 - Open your browser at
   - `http://localhost/8081` for app

diff --git a/.env.example → docker/.env.example b/.env.example → docker/.env.example
diff --git a/compose.dev.yaml → docker/compose.dev.yaml b/compose.dev.yaml → docker/compose.dev.yaml
@@ -6,7 +6,9 @@ services:
   app:
     container_name: backend-dev
     build:
-      context: .
+      context: ..
       dockerfile: Dockerfile.dev
     ports:
       - "8081:8081"
+    env_file:
+      - .env
diff --git a/supabase-selfhost.yaml → docker/supabase-selfhost.yaml b/supabase-selfhost.yaml → docker/supabase-selfhost.yaml
diff --git a/volumes/api/kong.yml → docker/volumes/api/kong.yml b/volumes/api/kong.yml → docker/volumes/api/kong.yml
diff --git a/volumes/db/init/data.sql → docker/volumes/db/init/data.sql b/volumes/db/init/data.sql → docker/volumes/db/init/data.sql
diff --git a/volumes/db/jwt.sql → docker/volumes/db/jwt.sql b/volumes/db/jwt.sql → docker/volumes/db/jwt.sql
diff --git a/volumes/db/logs.sql → docker/volumes/db/logs.sql b/volumes/db/logs.sql → docker/volumes/db/logs.sql
diff --git a/volumes/db/realtime.sql → docker/volumes/db/realtime.sql b/volumes/db/realtime.sql → docker/volumes/db/realtime.sql
diff --git a/volumes/db/roles.sql → docker/volumes/db/roles.sql b/volumes/db/roles.sql → docker/volumes/db/roles.sql
diff --git a/volumes/db/webhooks.sql → docker/volumes/db/webhooks.sql b/volumes/db/webhooks.sql → docker/volumes/db/webhooks.sql
diff --git a/volumes/functions/hello/index.ts → docker/volumes/functions/hello/index.ts b/volumes/functions/hello/index.ts → docker/volumes/functions/hello/index.ts
diff --git a/volumes/functions/main/index.ts → docker/volumes/functions/main/index.ts b/volumes/functions/main/index.ts → docker/volumes/functions/main/index.ts
diff --git a/volumes/logs/vector.yml → docker/volumes/logs/vector.yml b/volumes/logs/vector.yml → docker/volumes/logs/vector.yml
diff --git a/useful_commands.md b/useful_commands.md
@@ -75,9 +75,9 @@ docker build --file Dockerfile.prod --tag backend-prod .
 #### Start the containers
 
 ```sh
-docker run --detach --name backend-dev --publish 8081:8081 backend-dev
-docker run --detach --name backend-staging --publish 80:80 backend-staging
-docker run --detach --name backend-prod --publish 80:80 backend-prod
+docker run --name backend-dev --publish 8081:8081 backend-dev --detach
+docker run --name backend-staging --publish 80:80 backend-staging --detach
+docker run --name backend-prod --publish 80:80 backend-prod --detach
 ```
 
 #### Stop the containers
@@ -113,12 +113,12 @@ docker compose --file compose.dev.yaml build
 #### Bring up the services
 
 ```sh
-docker compose --detach --file compose.dev.yaml up
+docker compose --file compose.dev.yaml up --detach
 ```
 
 
 #### Build and bring up the services
 
 ```sh
-docker compose --detach --file compose.dev.yaml up --build
+docker compose --file compose.dev.yaml up --build --detach
 ```