Skip to content

Commit 5372ece

Browse files
lmcdonoughlmcdonough
authored
Update Container-README.md
removes values from tip tap env vars in Container-Readme
1 parent db3620e commit 5372ece

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

‎docs/runbooks/Container-README.md

+24-25
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ BACKEND_LOG_FILTER_LEVEL=DEBUG # Logging level for the back-end
3737
BACKEND_PORT=4000 # Port on which the Rust back-end listens
3838
BACKEND_INTERFACE=0.0.0.0 # Interface for the Rust back-end
3939
BACKEND_SERVICE_PROTOCOL=http # Protocol (usually http)
40-
BACKEND_SERVICE_PORT=4000 # Derived service port
40+
BACKEND_SERVICE_PORT=4000 # Derived service port
4141
BACKEND_SERVICE_HOST=localhost # Hostname used by the service
4242
BACKEND_API_VERSION=0.0.1 # API version
4343

@@ -47,16 +47,15 @@ BACKEND_API_VERSION=0.0.1 # API version
4747
FRONTEND_IMAGE_NAME=ghcr.io/refactor-group/refactor-platform-fe/<branch-name>:latest
4848
# Pre-built image for the Next.js front-end from GHCR
4949
FRONTEND_CONTAINER_NAME=refactor-platform-frontend # Name for the front-end container
50-
FRONTEND_SERVICE_INTERFACE=0.0.0.0 # Interface for the front-end service
51-
FRONTEND_SERVICE_PORT=3000 # Port for the front-end service
50+
FRONTEND_SERVICE_INTERFACE=0.0.0.0 # Interface for the front-end service
51+
FRONTEND_SERVICE_PORT=3000 # Port for the front-end service
5252

5353
# ==============================
5454
# TipTap Service Configuration
5555
# ==============================
56-
TIPTAP_URL="https://ok01532m.collab.tiptap.cloud" # URL for the TipTap service
57-
TIPTAP_AUTH_KEY="6122462e59d7cc8c6146f4e3b5c93dfad28c8a219838df69b59ffcec4cdc0041"
58-
# Authentication key for TipTap
59-
TIPTAP_JWT_SIGNING_KEY="0f38cb0650a8fc262258ad415f25c52579bfc4095b222f486557d24c8fafaeb8" # JWT signing key for TipTap
56+
TIPTAP_URL="" # URL for the TipTap service
57+
TIPTAP_AUTH_KEY="" # Authentication key for TipTap
58+
TIPTAP_JWT_SIGNING_KEY="" # JWT signing key for TipTap
6059
```
6160

6261
## Steps & Commands
@@ -84,18 +83,18 @@ TIPTAP_JWT_SIGNING_KEY="0f38cb0650a8fc262258ad415f25c52579bfc4095b222f486557d24c
8483
1. **Basic Management Commands:**
8584

8685
```bash
87-
docker-compose ps # List running containers
88-
docker-compose logs -f # Follow live logs (press Ctrl+C to exit)
89-
docker-compose restart rust-app # Restart the Rust back-end container
90-
docker-compose down # Stop and remove all containers and networks
91-
docker-compose down -v # Stop containers and remove volumes for a fresh start
86+
docker-compose ps # List running containers
87+
docker-compose logs -f # Follow live logs (press Ctrl+C to exit)
88+
docker-compose restart rust-app # Restart the Rust back-end container
89+
docker-compose down # Stop and remove all containers and networks
90+
docker-compose down -v # Stop containers and remove volumes for a fresh start
9291
docker-compose exec rust-app cargo check # Run 'cargo check' inside the Rust back-end container
93-
docker-compose exec rust-app cargo run # Run the Rust back-end application
94-
docker-compose ps # List running containers
95-
docker-compose logs -f # Follow live logs (press Ctrl+C to exit)
96-
docker-compose restart rust-app # Restart the Rust back-end container
92+
docker-compose exec rust-app cargo run # Run the Rust back-end application
93+
docker-compose ps # List running containers
94+
docker-compose logs -f # Follow live logs (press Ctrl+C to exit)
95+
docker-compose restart rust-app # Restart the Rust back-end container
9796
docker-compose exec rust-app cargo check # Run 'cargo check' inside the Rust back-end container
98-
docker-compose exec rust-app cargo run # Run the Rust back-end application
97+
docker-compose exec rust-app cargo run # Run the Rust back-end application
9998
```
10099

101100
1. **Direct Docker Commands (Optional):**
@@ -113,16 +112,16 @@ TIPTAP_JWT_SIGNING_KEY="0f38cb0650a8fc262258ad415f25c52579bfc4095b222f486557d24c
113112
1. **Debugging & Troubleshooting:**
114113

115114
```bash
116-
docker-compose exec rust-app bash # Access a shell in the Rust back-end container
117-
docker-compose exec rust-app env # View environment variables in the Rust back-end container
118-
docker-compose exec postgres bash # Access a shell in the PostgreSQL container
115+
docker-compose exec rust-app bash # Access a shell in the Rust back-end container
116+
docker-compose exec rust-app env # View environment variables in the Rust back-end container
117+
docker-compose exec postgres bash # Access a shell in the PostgreSQL container
119118
docker-compose exec postgres pg_isready -U $POSTGRES_USER -d $POSTGRES_DB
120-
# Verify PostgreSQL is ready
121-
docker-compose exec rust-app bash # Access a shell in the Rust back-end container
122-
docker-compose exec rust-app env # Check environment variables inside the rust-app container
123-
docker-compose exec postgres bash # Access a shell in the PostgreSQL container for troubleshooting
119+
# Verify PostgreSQL is ready
120+
docker-compose exec rust-app bash # Access a shell in the Rust back-end container
121+
docker-compose exec rust-app env # Check environment variables inside the rust-app container
122+
docker-compose exec postgres bash # Access a shell in the PostgreSQL container for troubleshooting
124123
docker-compose exec postgres pg_isready -U $POSTGRES_USER -d $POSTGRES_DB # Verify PostgreSQL is ready
125-
docker-compose exec rust-app cargo test # Run tests inside the Rust back-end container
124+
docker-compose exec rust-app cargo test # Run tests inside the Rust back-end container
126125
```
127126

128127
**Final Notes:**

0 commit comments

Comments
 (0)