Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve docker-compose #196

Merged
merged 2 commits into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions apps/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ git clone https://github.com/gitroomhq/gitroom
Copy the `.env.example` file to `.env` and fill in the values

```bash .env
DATABASE_URL="postgres database URL"
DATABASE_URL="postgres database URL i.g. postgresql://postiz-local:[email protected]:5432/postiz-db-local"
REDIS_URL="redis database URL"
JWT_SECRET="random string for your JWT secret, make it long"
FRONTEND_URL="By default: http://localhost:4200"
Expand All @@ -73,26 +73,28 @@ CLOUDFLARE_BUCKET_URL="Cloudflare R2 Backet URL"
NX_ADD_PLUGINS=false
IS_GENERAL="true" # required for now
```

</Step>

<Step title="Install the dependencies">

```bash Terminal
npm install
```
</Step>

<Step title="Setup postgres & redis via docker compose">
```bash Terminal
docker compose -f "docker-compose.dev.yaml" up
```
</Step>

<Step title="Generate the prisma client and run the migrations">
```bash Terminal
npm run prisma-db-push
```
</Step>
{' '}
<Step title="Setup postgres & redis via docker compose">
Using this you can skip the redis and postgres steps from above. This will
also give you pg-admin to check the database. ```bash Terminal docker compose
-f "docker-compose.dev.yaml" up ```
</Step>

{' '}
<Step title="Generate the prisma client and run the migrations">
```bash Terminal npm run prisma-db-push ```
</Step>

<Step title="Run the project">
```bash Terminal
Expand Down
34 changes: 24 additions & 10 deletions docker-compose.dev.yaml
Original file line number Diff line number Diff line change
@@ -1,26 +1,40 @@
version: '3.9'

services:
gitroom-postgres:
postiz-postgres:
image: postgres:14.5
container_name: gitroom-postgres
container_name: postiz-postgres
restart: always
environment:
POSTGRES_PASSWORD: gitroom-local-pwd
POSTGRES_USER: gitroom-local
POSTGRES_DB: gitroom-db-local
POSTGRES_PASSWORD: postiz-local-pwd
POSTGRES_USER: postiz-local
POSTGRES_DB: postiz-db-local
volumes:
- postgres-volume:/var/lib/postgresql/data
ports:
- 5432:5432
gitroom-redis:
networks:
- postiz-network
postiz-pg-admin:
image: dpage/pgadmin4
container_name: postiz-pg-admin
restart: always
ports:
- 8081:80
environment:
PGADMIN_DEFAULT_EMAIL: [email protected]
PGADMIN_DEFAULT_PASSWORD: admin
networks:
- postiz-network
postiz-redis:
image: redis:7.2
container_name: gitroom-redis
container_name: postiz-redis
restart: always
ports:
- 6379:6379


volumes:
postgres-volume:
external: false

networks:
postiz-network:
external: false